@nikovirtala/projen-constructs 0.3.78 → 0.3.80

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/.jsii +326 -141
  2. package/README.md +18 -0
  3. package/docs/api/assets/search.js +1 -1
  4. package/docs/api/classes/AwsCdkConstructLibraryProject.html +1 -1
  5. package/docs/api/classes/AwsCdkTypeScriptAppProject.html +1 -1
  6. package/docs/api/classes/Bundler.html +33 -6
  7. package/docs/api/classes/Colima.html +4 -0
  8. package/docs/api/classes/JsiiProject.html +1 -1
  9. package/docs/api/classes/LambdaFunctionCodeBundle.html +22 -2
  10. package/docs/api/classes/LambdaFunctionConstructGenerator.html +4 -0
  11. package/docs/api/classes/LocalStack.html +4 -0
  12. package/docs/api/classes/ProjectGenerator.html +1 -1
  13. package/docs/api/classes/TypeScriptProject.html +1 -1
  14. package/docs/api/classes/Vitest.html +1 -1
  15. package/docs/api/functions/convertToPosixPath.html +2 -0
  16. package/docs/api/functions/renderBundleName.html +9 -1
  17. package/docs/api/index.html +8 -0
  18. package/docs/api/interfaces/Bundle.html +12 -3
  19. package/docs/api/interfaces/BundlerOptions.html +40 -4
  20. package/docs/api/interfaces/BundlingOptions.html +139 -12
  21. package/docs/api/interfaces/LambdaFunctionCodeBundleOptions.html +53 -5
  22. package/docs/api/interfaces/LambdaFunctionCodeBundlerOptions.html +26 -3
  23. package/docs/api/interfaces/LambdaFunctionConstructGeneratorOptions.html +90 -8
  24. package/docs/api/interfaces/LocalStackOptions.html +46 -4
  25. package/docs/api/interfaces/ProjectGeneratorOptions.html +1 -1
  26. package/docs/api/interfaces/VitestOptions.html +48 -3
  27. package/lib/components/bundle-lambda-function-code.d.ts +243 -0
  28. package/lib/components/bundle-lambda-function-code.js +75 -5
  29. package/lib/components/colima.d.ts +5 -0
  30. package/lib/components/colima.js +7 -2
  31. package/lib/components/homebrew.js +1 -1
  32. package/lib/components/lambda-function-construct-generator.d.ts +54 -0
  33. package/lib/components/lambda-function-construct-generator.js +7 -2
  34. package/lib/components/localstack.d.ts +32 -0
  35. package/lib/components/localstack.js +14 -2
  36. package/lib/components/mise.js +1 -1
  37. package/lib/components/typedoc.js +1 -1
  38. package/lib/components/vitest.d.ts +29 -0
  39. package/lib/components/vitest.js +38 -35
  40. package/lib/project-generator.js +1 -1
  41. package/lib/projects/awscdk-construct-library.generated.js +1 -1
  42. package/lib/projects/awscdk-typescript-app.generated.js +1 -1
  43. package/lib/projects/jsii.generated.js +1 -1
  44. package/lib/projects/typescript.generated.js +1 -1
  45. package/package.json +1 -1
package/docs/api/interfaces/LambdaFunctionConstructGeneratorOptions.html CHANGED
@@ -10,6 +10,9 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">LambdaFunctionConstructGeneratorOptions</a></li></ul>
12
12
  <h1>Interface LambdaFunctionConstructGeneratorOptions</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>Options for the LambdaFunctionConstructGenerator</p>
15
+ </div></section>
13
16
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LambdaFunctionConstructGeneratorOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#adddependencies">addDependencies</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#baseconstructclass">baseConstructClass</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#baseconstructimport">baseConstructImport</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#baseconstructpackage">baseConstructPackage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#esbuildoptions">esbuildOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildOptions</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#filepattern">filePattern</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#outputdir">outputDir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#sourcedir">sourceDir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
17
  <section class="tsd-panel-group tsd-index-group">
15
18
  <section class="tsd-panel tsd-index-panel">
@@ -32,28 +35,107 @@
32
35
  <section>
33
36
  <section class="tsd-panel tsd-member">
34
37
  <h3 class="tsd-anchor-link" id="adddependencies"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>add<wbr/>Dependencies</span><a href="#adddependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
35
- <div class="tsd-signature"><span class="tsd-kind-property">addDependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div></section>
38
+ <div class="tsd-signature"><span class="tsd-kind-property">addDependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
39
+ <div class="tsd-comment tsd-typography"><p>Whether to automatically add the required dependencies</p>
40
+ </div>
41
+ <div class="tsd-comment tsd-typography">
42
+ <div class="tsd-tag-default">
43
+ <h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
44
+ </code><button type="button">Copy</button></pre>
45
+
46
+ </div></div></section>
36
47
  <section class="tsd-panel tsd-member">
37
48
  <h3 class="tsd-anchor-link" id="baseconstructclass"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>base<wbr/>Construct<wbr/>Class</span><a href="#baseconstructclass" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
38
- <div class="tsd-signature"><span class="tsd-kind-property">baseConstructClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
49
+ <div class="tsd-signature"><span class="tsd-kind-property">baseConstructClass</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
50
+ <div class="tsd-comment tsd-typography"><p>Name of the construct class to extend</p>
51
+ </div>
52
+ <div class="tsd-comment tsd-typography">
53
+ <div class="tsd-tag-example">
54
+ <h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;NodejsFunction&quot;</span>
55
+ </code><button type="button">Copy</button></pre>
56
+
57
+ </div>
58
+ <div class="tsd-tag-default">
59
+ <h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;aws_lambda.Function&quot;</span>
60
+ </code><button type="button">Copy</button></pre>
61
+
62
+ </div></div></section>
39
63
  <section class="tsd-panel tsd-member">
40
64
  <h3 class="tsd-anchor-link" id="baseconstructimport"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>base<wbr/>Construct<wbr/>Import</span><a href="#baseconstructimport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
41
- <div class="tsd-signature"><span class="tsd-kind-property">baseConstructImport</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
65
+ <div class="tsd-signature"><span class="tsd-kind-property">baseConstructImport</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
66
+ <div class="tsd-comment tsd-typography"><p>Import statement for the base construct</p>
67
+ </div>
68
+ <div class="tsd-comment tsd-typography">
69
+ <div class="tsd-tag-example">
70
+ <h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;import { NodejsFunction } from &#39;aws-cdk-lib/aws-lambda-nodejs&#39;;&quot;</span>
71
+ </code><button type="button">Copy</button></pre>
72
+
73
+ </div>
74
+ <div class="tsd-tag-default">
75
+ <h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;import { aws_lambda } from &#39;aws-cdk-lib&#39;;&quot;</span>
76
+ </code><button type="button">Copy</button></pre>
77
+
78
+ </div></div></section>
42
79
  <section class="tsd-panel tsd-member">
43
80
  <h3 class="tsd-anchor-link" id="baseconstructpackage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>base<wbr/>Construct<wbr/>Package</span><a href="#baseconstructpackage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
44
- <div class="tsd-signature"><span class="tsd-kind-property">baseConstructPackage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
81
+ <div class="tsd-signature"><span class="tsd-kind-property">baseConstructPackage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
82
+ <div class="tsd-comment tsd-typography"><p>Package name to add as dependency for the base construct</p>
83
+ </div>
84
+ <div class="tsd-comment tsd-typography">
85
+ <div class="tsd-tag-example">
86
+ <h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;aws-cdk-lib&quot;</span>
87
+ </code><button type="button">Copy</button></pre>
88
+
89
+ </div>
90
+ <div class="tsd-tag-default">
91
+ <h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;aws-cdk-lib&quot;</span>
92
+ </code><button type="button">Copy</button></pre>
93
+
94
+ </div></div></section>
45
95
  <section class="tsd-panel tsd-member">
46
96
  <h3 class="tsd-anchor-link" id="esbuildoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>esbuild<wbr/>Options</span><a href="#esbuildoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
47
- <div class="tsd-signature"><span class="tsd-kind-property">esbuildOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildOptions</span></div></section>
97
+ <div class="tsd-signature"><span class="tsd-kind-property">esbuildOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildOptions</span></div>
98
+ <div class="tsd-comment tsd-typography"><p>esbuild options to customize the bundling process</p>
99
+ </div>
100
+ <div class="tsd-comment tsd-typography">
101
+ <div class="tsd-tag-default">
102
+ <h4 class="tsd-anchor-link" id="default-4">Default<a href="#default-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">{}</span>
103
+ </code><button type="button">Copy</button></pre>
104
+
105
+ </div></div></section>
48
106
  <section class="tsd-panel tsd-member">
49
107
  <h3 class="tsd-anchor-link" id="filepattern"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>file<wbr/>Pattern</span><a href="#filepattern" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
50
- <div class="tsd-signature"><span class="tsd-kind-property">filePattern</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
108
+ <div class="tsd-signature"><span class="tsd-kind-property">filePattern</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
109
+ <div class="tsd-comment tsd-typography"><p>File pattern to identify Lambda Function handlers</p>
110
+ </div>
111
+ <div class="tsd-comment tsd-typography">
112
+ <div class="tsd-tag-default">
113
+ <h4 class="tsd-anchor-link" id="default-5">Default<a href="#default-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;*.lambda.ts&quot;</span>
114
+ </code><button type="button">Copy</button></pre>
115
+
116
+ </div></div></section>
51
117
  <section class="tsd-panel tsd-member">
52
118
  <h3 class="tsd-anchor-link" id="outputdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>output<wbr/>Dir</span><a href="#outputdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
53
- <div class="tsd-signature"><span class="tsd-kind-property">outputDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
119
+ <div class="tsd-signature"><span class="tsd-kind-property">outputDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
120
+ <div class="tsd-comment tsd-typography"><p>Output directory where Lambda Function constructs will be generated</p>
121
+ </div>
122
+ <div class="tsd-comment tsd-typography">
123
+ <div class="tsd-tag-default">
124
+ <h4 class="tsd-anchor-link" id="default-6">Default<a href="#default-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;src/constructs/lambda&quot;</span>
125
+ </code><button type="button">Copy</button></pre>
126
+
127
+ </div></div></section>
54
128
  <section class="tsd-panel tsd-member">
55
129
  <h3 class="tsd-anchor-link" id="sourcedir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>source<wbr/>Dir</span><a href="#sourcedir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
56
- <div class="tsd-signature"><span class="tsd-kind-property">sourceDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section></section></details></div>
130
+ <div class="tsd-signature"><span class="tsd-kind-property">sourceDir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
131
+ <div class="tsd-comment tsd-typography"><p>Source directory where Lambda Function handlers are located</p>
132
+ </div>
133
+ <div class="tsd-comment tsd-typography">
134
+ <div class="tsd-tag-default">
135
+ <h4 class="tsd-anchor-link" id="default-7">Default<a href="#default-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;src/handlers&quot;</span>
136
+ </code><button type="button">Copy</button></pre>
137
+
138
+ </div></div></section></section></details></div>
57
139
  <div class="col-sidebar">
58
140
  <div class="page-menu">
59
141
  <div class="tsd-navigation settings">
package/docs/api/interfaces/LocalStackOptions.html CHANGED
@@ -10,6 +10,9 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">LocalStackOptions</a></li></ul>
12
12
  <h1>Interface LocalStackOptions</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>Options for LocalStack component.</p>
15
+ </div></section>
13
16
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">LocalStackOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#debug">debug</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#imagetag">imageTag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#port">port</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#services">services</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
17
  <section class="tsd-panel-group tsd-index-group">
15
18
  <section class="tsd-panel tsd-index-panel">
@@ -28,16 +31,55 @@
28
31
  <section>
29
32
  <section class="tsd-panel tsd-member">
30
33
  <h3 class="tsd-anchor-link" id="debug"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
31
- <div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div></section>
34
+ <div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
35
+ <div class="tsd-comment tsd-typography"><p>Enable LocalStack debug mode.</p>
36
+ </div>
37
+ <div class="tsd-comment tsd-typography">
38
+ <div class="tsd-tag-default">
39
+ <h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
40
+ </code><button type="button">Copy</button></pre>
41
+
42
+ </div></div></section>
32
43
  <section class="tsd-panel tsd-member">
33
44
  <h3 class="tsd-anchor-link" id="imagetag"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>image<wbr/>Tag</span><a href="#imagetag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
34
- <div class="tsd-signature"><span class="tsd-kind-property">imageTag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div></section>
45
+ <div class="tsd-signature"><span class="tsd-kind-property">imageTag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
46
+ <div class="tsd-comment tsd-typography"><p>LocalStack Docker image tag, e.g. <code>&quot;4.9&quot;</code> to pin a version.</p>
47
+ <p>When set, LocalStack starts with the <code>localstack/localstack:&lt;imageTag&gt;</code> image, passed to
48
+ <code>localstack start</code> through the <code>IMAGE_NAME</code> environment variable. That's the community
49
+ image, even if a <code>LOCALSTACK_AUTH_TOKEN</code> would otherwise select the Pro image.</p>
50
+ <p>Must be a valid Docker tag.</p>
51
+ </div>
52
+ <div class="tsd-comment tsd-typography">
53
+ <div class="tsd-tag-default">
54
+ <h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">LocalStack</span><span class="hl-1"> </span><span class="hl-4">CLI</span><span class="hl-2">&#39;s default imag</span><span class="hl-9">e</span>
55
+ </code><button type="button">Copy</button></pre>
56
+
57
+ </div>
58
+ <div class="tsd-tag-see">
59
+ <h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://docs.localstack.cloud/aws/customization/configuration-options/">https://docs.localstack.cloud/aws/customization/configuration-options/</a></p>
60
+ </div></div></section>
35
61
  <section class="tsd-panel tsd-member">
36
62
  <h3 class="tsd-anchor-link" id="port"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>port</span><a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
37
- <div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div></section>
63
+ <div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
64
+ <div class="tsd-comment tsd-typography"><p>LocalStack gateway port.</p>
65
+ </div>
66
+ <div class="tsd-comment tsd-typography">
67
+ <div class="tsd-tag-default">
68
+ <h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-6">4566</span>
69
+ </code><button type="button">Copy</button></pre>
70
+
71
+ </div></div></section>
38
72
  <section class="tsd-panel tsd-member">
39
73
  <h3 class="tsd-anchor-link" id="services"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>services</span><a href="#services" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
40
- <div class="tsd-signature"><span class="tsd-kind-property">services</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div></section></section></details></div>
74
+ <div class="tsd-signature"><span class="tsd-kind-property">services</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
75
+ <div class="tsd-comment tsd-typography"><p>LocalStack services to enable.</p>
76
+ </div>
77
+ <div class="tsd-comment tsd-typography">
78
+ <div class="tsd-tag-default">
79
+ <h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">all</span><span class="hl-1"> </span><span class="hl-5">services</span><span class="hl-1"> </span><span class="hl-5">enabled</span>
80
+ </code><button type="button">Copy</button></pre>
81
+
82
+ </div></div></section></section></details></div>
41
83
  <div class="col-sidebar">
42
84
  <div class="page-menu">
43
85
  <div class="tsd-navigation settings">
package/docs/api/interfaces/ProjectGeneratorOptions.html CHANGED
@@ -16,7 +16,7 @@
16
16
  with standard configuration and component integration.</p>
17
17
  </div></section>
18
18
  <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ProjectGeneratorOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#additionaloptions">additionalOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#components">components</a><span class="tsd-signature-symbol">?:</span> <a href="Component.html" class="tsd-signature-type tsd-kind-interface">Component</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#executable">executable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#filepath">filePath</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#indent">indent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#omitoptions">omitOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#projecttype">projectType</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ProjectType.html" class="tsd-signature-type tsd-kind-enum">ProjectType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#readonly">readonly</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
19
- <section class="tsd-panel tsd-hierarchy" data-refl="703">
19
+ <section class="tsd-panel tsd-hierarchy" data-refl="719">
20
20
  <h4>Hierarchy</h4>
21
21
  <ul class="tsd-hierarchy">
22
22
  <li class="tsd-hierarchy-item"><span class="tsd-signature-type">SourceCodeOptions</span>
package/docs/api/interfaces/VitestOptions.html CHANGED
@@ -10,7 +10,7 @@
10
10
  <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
11
  <li><a href="" aria-current="page">VitestOptions</a></li></ul>
12
12
  <h1>Interface VitestOptions</h1></div>
13
- <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">VitestOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#config">config</a><span class="tsd-signature-symbol">?:</span> <a href="VitestConfigOptions.html" class="tsd-signature-type tsd-kind-interface">VitestConfigOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#configfilepath">configFilePath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#vitestversion">vitestVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
13
+ <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">VitestOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#config">config</a><span class="tsd-signature-symbol">?:</span> <a href="VitestConfigOptions.html" class="tsd-signature-type tsd-kind-interface">VitestConfigOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#configfilepath">configFilePath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#extraconfig">extraConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#extratestconfig">extraTestConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="#vitestversion">vitestVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div>
14
14
  <section class="tsd-panel-group tsd-index-group">
15
15
  <section class="tsd-panel tsd-index-panel">
16
16
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -20,6 +20,8 @@
20
20
  <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
21
21
  <div class="tsd-index-list"><a href="#config" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config?</span></a>
22
22
  <a href="#configfilepath" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config<wbr/>File<wbr/>Path?</span></a>
23
+ <a href="#extraconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extra<wbr/>Config?</span></a>
24
+ <a href="#extratestconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extra<wbr/>Test<wbr/>Config?</span></a>
23
25
  <a href="#vitestversion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest<wbr/>Version?</span></a>
24
26
  </div></section></div></details></section></section>
25
27
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -40,6 +42,49 @@
40
42
  <h4 class="tsd-anchor-link" id="default">Default<a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;vitest.config.ts&quot;</span>
41
43
  </code><button type="button">Copy</button></pre>
42
44
 
45
+ </div></div></section>
46
+ <section class="tsd-panel tsd-member">
47
+ <h3 class="tsd-anchor-link" id="extraconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>extra<wbr/>Config</span><a href="#extraconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
48
+ <div class="tsd-signature"><span class="tsd-kind-property">extraConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span></div>
49
+ <div class="tsd-comment tsd-typography"><p>Additional top-level config options, next to <code>test</code>, such as <code>resolve</code>.</p>
50
+ <p>Values are rendered as JSON, so they must be JSON-serializable (no functions or regular expressions,
51
+ which rules out plugins). Use <code>extraTestConfig</code> for <code>test</code> options.</p>
52
+ </div>
53
+ <div class="tsd-comment tsd-typography">
54
+ <div class="tsd-tag-example">
55
+ <h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">{ </span><span class="hl-10">resolve</span><span class="hl-1">: { </span><span class="hl-10">alias</span><span class="hl-1">: { </span><span class="hl-2">&quot;@&quot;</span><span class="hl-1">: </span><span class="hl-2">&quot;/src&quot;</span><span class="hl-1"> } } }</span>
56
+ </code><button type="button">Copy</button></pre>
57
+
58
+ </div>
59
+ <div class="tsd-tag-default">
60
+ <h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">additional</span><span class="hl-1"> </span><span class="hl-5">top</span><span class="hl-1">-</span><span class="hl-5">level</span><span class="hl-1"> </span><span class="hl-5">options</span>
61
+ </code><button type="button">Copy</button></pre>
62
+
63
+ </div>
64
+ <div class="tsd-tag-see">
65
+ <h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/">https://vitest.dev/config/</a></p>
66
+ </div></div></section>
67
+ <section class="tsd-panel tsd-member">
68
+ <h3 class="tsd-anchor-link" id="extratestconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>extra<wbr/>Test<wbr/>Config</span><a href="#extratestconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
69
+ <div class="tsd-signature"><span class="tsd-kind-property">extraTestConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">unknown</span> <span class="tsd-signature-symbol">}</span></div>
70
+ <div class="tsd-comment tsd-typography"><p>Additional <code>test</code> options for settings that <code>config</code> doesn't cover, such as <code>setupFiles</code> or <code>expect</code>.</p>
71
+ <p>Deep-merged over the options generated from <code>config</code>: objects are merged, other values (including
72
+ arrays) replace the generated value. Values are rendered as JSON, so they must be JSON-serializable
73
+ (no functions or regular expressions).</p>
74
+ </div>
75
+ <div class="tsd-comment tsd-typography">
76
+ <div class="tsd-tag-example">
77
+ <h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">{ </span><span class="hl-10">setupFiles</span><span class="hl-1">: [</span><span class="hl-2">&quot;test/setup.ts&quot;</span><span class="hl-1">], </span><span class="hl-10">expect</span><span class="hl-1">: { </span><span class="hl-10">requireAssertions</span><span class="hl-1">: </span><span class="hl-3">true</span><span class="hl-1"> } }</span>
78
+ </code><button type="button">Copy</button></pre>
79
+
80
+ </div>
81
+ <div class="tsd-tag-default">
82
+ <h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">additional</span><span class="hl-1"> </span><span class="hl-5">test</span><span class="hl-1"> </span><span class="hl-5">options</span>
83
+ </code><button type="button">Copy</button></pre>
84
+
85
+ </div>
86
+ <div class="tsd-tag-see">
87
+ <h4 class="tsd-anchor-link" id="see-1">See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://vitest.dev/config/">https://vitest.dev/config/</a></p>
43
88
  </div></div></section>
44
89
  <section class="tsd-panel tsd-member">
45
90
  <h3 class="tsd-anchor-link" id="vitestversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>vitest<wbr/>Version</span><a href="#vitestversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
@@ -48,7 +93,7 @@
48
93
  </div>
49
94
  <div class="tsd-comment tsd-typography">
50
95
  <div class="tsd-tag-default">
51
- <h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;^4&quot;</span>
96
+ <h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">&quot;^4&quot;</span>
52
97
  </code><button type="button">Copy</button></pre>
53
98
 
54
99
  </div></div></section></section></details></div>
@@ -68,7 +113,7 @@
68
113
  <h3>On This Page</h3></summary>
69
114
  <div class="tsd-accordion-details">
70
115
  <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
71
- <div><a href="#config"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#configfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config<wbr/>File<wbr/>Path</span></a><a href="#vitestversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest<wbr/>Version</span></a></div></details></div></details></div>
116
+ <div><a href="#config"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config</span></a><a href="#configfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>config<wbr/>File<wbr/>Path</span></a><a href="#extraconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extra<wbr/>Config</span></a><a href="#extratestconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extra<wbr/>Test<wbr/>Config</span></a><a href="#vitestversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest<wbr/>Version</span></a></div></details></div></details></div>
72
117
  <div class="site-menu">
73
118
  <nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a>
74
119
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">