@goldstack/template-lambda-http-cli 0.5.31

package/docs/template-configure.html

@@ -0,0 +1,66 @@
+<p></p>
+<div class="markdown-fragment">
+  <p>
+    Goldstack's Lambda Express module provides a basic Express.js server that is
+    deployed as an AWS lambda function.
+  </p>
+</div>
+<p></p>
+<p></p>
+<div class="markdown-fragment">
+  <p>The following key properties need to be configured for this module:</p>
+  <ul>
+    <li>
+      <strong>Lambda Name</strong>: The
+      <a
+        href="https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-FunctionName"
+        class="absolute"
+        target="_blank"
+        rel="noopener noreferrer"
+        >name</a
+      >
+      to be used for this lambda. Lambda names need to be unique for the AWS
+      Region. It is not possible to have two lambdas with the same name in the
+      same region.
+    </li>
+    <li>
+      <strong>API Domain</strong>: The domain where the API should be deployed
+      to. For instance, to be able to call the API endpoint
+      <code class="inline">https://api.mydomain.com/</code> the API domain
+      <code class="inline">api.mydomain.com</code> needs to be configured.
+    </li>
+    <li>
+      <strong>Hosted Zone Domain</strong>: A Route 53 hosted zone that will
+      allow adding the <em>API Domain</em> as a record. For instance, in order
+      to configure the API domain <code class="inline">api.mydomain.com</code>,
+      the hosted zones <code class="inline">api.mydomain.com</code> or
+      <code class="inline">mydomain.com</code> would be valid. For more details,
+      please check
+      <a
+        href="https://docs.goldstack.party/docs/goldstack/configuration#hosted-zone-configuration"
+        class="absolute"
+        target="_blank"
+        rel="noopener noreferrer"
+        >Hosted Zone Configuration</a
+      >
+      in the Goldstack documentation.
+    </li>
+    <li>
+      <strong>CORS Header</strong>: An optional CORS header to enable a UI that
+      is hosted on a different domain to access this API. For instance, for a UI
+      that is deployed to the domain
+      <code class="inline">ui.mydomain.com</code> the CORS header
+      <code class="inline">https://ui.mydomain.com</code> should be supplied. To
+      learn more about CORS, see the
+      <a
+        href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS"
+        class="absolute"
+        target="_blank"
+        rel="noopener noreferrer"
+        >Cross-Origin Resource Sharing (CORS)</a
+      >
+      in the MDN docs.
+    </li>
+  </ul>
+</div>
+<p></p>

package/docs/template.html

@@ -0,0 +1,106 @@
+<p></p>
+<div class="markdown-fragment">
+  <p>
+    This module provides a basic Express.js server that is deployed as an AWS
+    lambda function.
+  </p>
+</div>
+<p></p>
+<h2 class="heading">
+  <span id="configure"></span><a href="#configure">Configure</a
+  ><span class="permalink"
+    ><svg viewBox="0 0 16 16" width="16" height="16">
+      <g stroke-width="1" fill="#000000" stroke="#000000">
+        <path
+          fill="none"
+          stroke-linecap="round"
+          stroke-linejoin="round"
+          stroke-miterlimit="10"
+          d="M8.995,7.005 L8.995,7.005c1.374,1.374,1.374,3.601,0,4.975l-1.99,1.99c-1.374,1.374-3.601,1.374-4.975,0l0,0c-1.374-1.374-1.374-3.601,0-4.975 l1.748-1.698"
+        ></path>
+        <path
+          fill="none"
+          stroke="#000000"
+          stroke-linecap="round"
+          stroke-linejoin="round"
+          stroke-miterlimit="10"
+          d="M7.005,8.995 L7.005,8.995c-1.374-1.374-1.374-3.601,0-4.975l1.99-1.99c1.374-1.374,3.601-1.374,4.975,0l0,0c1.374,1.374,1.374,3.601,0,4.975 l-1.748,1.698"
+        ></path>
+      </g></svg
+  ></span>
+</h2>
+<p></p>
+<div class="markdown-fragment">
+  <p>The following key properties need to be configured for this module:</p>
+  <ul>
+    <li>
+      <strong>Lambda Name</strong>: The
+      <a
+        href="https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-FunctionName"
+        class="absolute"
+        target="_blank"
+        rel="noopener noreferrer"
+        >name</a
+      >
+      to be used for this lambda. This needs to be unique per AWS region.
+    </li>
+    <li>
+      <strong>API Domain</strong>: The domain where the API should be deployed
+      to. For instance, to be able to call the API endpoint
+      <code class="inline">https://api.mydomain.com/</code> the API domain
+      <code class="inline">api.mydomain.com</code> needs to be configured.
+    </li>
+    <li>
+      <strong>Hosted Zone Domain</strong>: A
+      <a
+        href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html"
+        class="absolute"
+        target="_blank"
+        rel="noopener noreferrer"
+        >Route 53 hosted zone</a
+      >
+      that will allow adding the <em>API Domain</em> as a record. For instance,
+      in order to configure the API domain
+      <code class="inline">api.mydomain.com</code>, the hosted zones
+      <code class="inline">api.mydomain.com</code> or
+      <code class="inline">mydomain.com</code> would be valid. Note that this
+      hosted zone must already exist in AWS. Please find instructions of how to
+      set up a hosted zone
+      <a
+        href="https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingHostedZone.html"
+        class="absolute"
+        target="_blank"
+        rel="noopener noreferrer"
+        >here</a
+      >.
+    </li>
+  </ul>
+</div>
+<p></p>
+<h2 class="heading">
+  <span id="getting-started"></span
+  ><a href="#getting-started">Getting Started</a
+  ><span class="permalink"
+    ><svg viewBox="0 0 16 16" width="16" height="16">
+      <g stroke-width="1" fill="#000000" stroke="#000000">
+        <path
+          fill="none"
+          stroke-linecap="round"
+          stroke-linejoin="round"
+          stroke-miterlimit="10"
+          d="M8.995,7.005 L8.995,7.005c1.374,1.374,1.374,3.601,0,4.975l-1.99,1.99c-1.374,1.374-3.601,1.374-4.975,0l0,0c-1.374-1.374-1.374-3.601,0-4.975 l1.748-1.698"
+        ></path>
+        <path
+          fill="none"
+          stroke="#000000"
+          stroke-linecap="round"
+          stroke-linejoin="round"
+          stroke-miterlimit="10"
+          d="M7.005,8.995 L7.005,8.995c-1.374-1.374-1.374-3.601,0-4.975l1.99-1.99c1.374-1.374,3.601-1.374,4.975,0l0,0c1.374,1.374,1.374,3.601,0,4.975 l-1.748,1.698"
+        ></path>
+      </g></svg
+  ></span>
+</h2>
+<p></p>
+<div class="markdown-fragment"></div>
+<p></p>

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@goldstack/template-lambda-http-cli",
+  "version": "0.5.31",
+  "description": "Utilities for templates that allow a Lambda to function as a web server.",
+  "keywords": [
+    "goldstack",
+    "utility",
+    "lambda",
+    "aws",
+    "web",
+    "cloudfront",
+    "serverless",
+    "infrastructure",
+    "IaC",
+    "configuration"
+  ],
+  "homepage": "https://goldstack.party",
+  "bugs": {
+    "url": "https://github.com/goldstack/goldstack/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goldstack/goldstack.git"
+  },
+  "license": "MIT",
+  "author": "Max Rohde",
+  "sideEffects": false,
+  "main": "dist/src/templateLambdaHttp.js",
+  "bin": {
+    "template": "./bin/template",
+    "template-lambda-http-cli": "./bin/template"
+  },
+  "scripts": {
+    "build": "yarn clean && yarn compile",
+    "build:watch": "yarn clean && yarn compile-watch",
+    "clean": "rimraf ./dist",
+    "cli": "ts-node bin/template.ts",
+    "compile": "tsc -p tsconfig.json",
+    "compile-watch": "tsc -p tsconfig.json --watch",
+    "compile-watch:light": "nodemon --watch ./src/ -e '*' --exec 'yarn compile'",
+    "coverage": "jest --collect-coverage --passWithNoTests --config=./jest.config.js --runInBand",
+    "generate-schema": "ts-node scripts/generateSchemas.ts && cp schemas/* ../../../templates/packages/lambda-express/schemas && cp schemas/* ../../../templates/packages/lambda-go-gin/schemas",
+    "prepublishOnly": "yarn run build",
+    "publish": "utils-git changed --exec \"yarn npm publish $@\"",
+    "test-ci": "jest --passWithNoTests --config=./jest.config.js --runInBand",
+    "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\"",
+    "version:apply:force": "yarn version $@ && yarn version apply"
+  },
+  "dependencies": {
+    "@goldstack/infra": "0.4.12",
+    "@goldstack/infra-aws": "0.4.20",
+    "@goldstack/template-lambda-cli": "0.1.1",
+    "@goldstack/utils-aws-lambda": "0.3.25",
+    "@goldstack/utils-cli": "0.3.10",
+    "@goldstack/utils-config": "0.4.12",
+    "@goldstack/utils-log": "0.3.11",
+    "@goldstack/utils-package": "0.4.12",
+    "@goldstack/utils-package-config": "0.4.12",
+    "@goldstack/utils-template": "0.4.12",
+    "@goldstack/utils-terraform": "0.4.23",
+    "@goldstack/utils-terraform-aws": "0.4.26",
+    "source-map-support": "^0.5.21",
+    "yargs": "^17.5.1"
+  },
+  "devDependencies": {
+    "@goldstack/utils-docs-cli": "0.3.11",
+    "@goldstack/utils-git": "0.2.9",
+    "@goldstack/utils-package-config-generate": "0.3.10",
+    "@swc/core": "^1.3.74",
+    "@swc/jest": "^0.2.27",
+    "@types/jest": "^29.0.1",
+    "@types/node": "^18.7.13",
+    "@types/yargs": "^17.0.10",
+    "jest": "^29.3.1",
+    "rimraf": "^3.0.2",
+    "ts-json-schema-generator": "^1.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
+  },
+  "publishConfig": {
+    "main": "dist/src/templateLambdaHttp.js"
+  }
+}