feat: extracted from map repo

.envrc.example

@@ -0,0 +1,4 @@
+export AWS_REGION=...                   # AWS region to use, e.g. eu-west-1
+export AWS_DEFAULT_REGION=$AWS_REGION
+export AWS_ACCESS_KEY_ID= ...           # Your AWS Access Key ID
+export AWS_SECRET_ACCESS_KEY=...        # Your AWS Secret Access Key

.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+ecs/
+cdk.out/

.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @coderbyheart @pudkrong

.github/workflows/test-and-release.yaml

@@ -0,0 +1,39 @@
+name: Test and Release
+
+on:
+  push:
+
+permissions:
+  contents: write
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci --no-audit
+
+      - name: Compile TypeScript
+        run: npx tsc
+
+      - name: Check source code with eslint
+        run: npx eslint ./
+
+      - name: Check if source code is properly formatted
+        run: npx prettier -c ./
+
+      - name: Semantic release
+        continue-on-error: true
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/update-repo-info.yaml

@@ -0,0 +1,32 @@
+name: Sync repository info from package.json
+
+env:
+  GITHUB_TOKEN: ${{ secrets.UPDATE_REPO_INFO_PAT }}
+
+on:
+  push:
+    branches:
+      - saga
+    paths:
+      - "package.json"
+      - ".github/workflows/update-repo-info.yaml"
+  workflow_dispatch:
+
+jobs:
+  update_repo_info:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Sync repository description
+        run:
+          gh repo edit --description "`cat package.json | jq -r '.description'`"
+
+      - name: Sync repository topics
+        run:
+          cat package.json | jq '.keywords[]' | xargs -I'{}' gh repo edit
+          --add-topic {}
+
+      - name: Sync homepage
+        run: gh repo edit --homepage "`cat package.json | jq -r '.homepage'`"

.gitignore

@@ -0,0 +1,9 @@
+# This file should only cover artifacts caused by the source code in this
+# repository, not those caused by the personal choice of editor and/or
+# environment of a developer.
+# See adr/002-clean-gitignore.md
+node_modules/
+npm-debug.log
+cdk.out/
+.envrc
+cdk.context.json

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,2 @@
+npx lint-staged
+npx tsc

.prettierignore

@@ -0,0 +1,2 @@
+dist/
+package-lock.json

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# Code of conduct
+
+## Our pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[markus.tacker@nordicsemi.no](mailto:markus.tacker@nordicsemi.no?subject=hello.nrfcloud.com+Code+of+Conduct).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement guidelines
+
+Community leaders will follow these community impact guidelines in determining
+the consequences for any action they deem in violation of this Code of conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of conduct is adapted from the
+[Contributor Covenant](https://www.contributor-covenant.org), version 2.0,
+available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing to the project
+
+This guide is intended for providing information on contributing to the
+hello.nrfcloud.com codebase. As a first step, see
+[Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## Finding open issues
+
+First, have a look at the issues for this project and look for issues that are
+labeled with `good first issue` or `help wanted`. These issues are good starting
+points for contributing to the project. Some of them require in-depth knowledge
+about the technology in use.

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Nordic Semiconductor ASA | nordicsemi.no
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,49 @@
+# Amazon Location Service Map resources
+
+[![GitHub Actions](https://github.com/hello-nrfcloud/aws-map/workflows/Test%20and%20Release/badge.svg)](https://github.com/hello-nrfcloud/aws-map/actions/workflows/test-and-release.yaml)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
+[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/)
+[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint)
+
+Contains the resources to serve maps to public web applications using
+[Amazon Location Service Maps](https://docs.aws.amazon.com/location/latest/developerguide/map-concepts.html)
+developed using [AWS CDK](https://aws.amazon.com/cdk) in
+[TypeScript](https://www.typescriptlang.org/).
+
+## Installation in your AWS account
+
+### Setup
+
+Provide your AWS credentials, for example using the `.envrc` (see
+[the example](.envrc.example)).
+
+### Install the dependencies
+
+```bash
+npm ci
+```
+
+### Deploy
+
+```bash
+# Configure the stack name
+# export MAP_STACK_NAME=...
+npx cdk bootstrap # if this is the first time you use CDK in this account
+npx cdk deploy --all
+```
+
+## Using with a map
+
+Store the `mapName` output in the parameter registry.
+
+Store the `mapRegion` output in the parameter registry.
+
+Display the API key using
+
+```bash
+aws location describe-key --key-name apiKey | jq '.Key'
+```
+
+Store the API key in the parameter registry as `mapApiKey`.

adr/001-use-saga-as-the-main-branch.md

@@ -0,0 +1,17 @@
+# ADR 001: Use saga as the name for the main branch
+
+Historically, Git and other software use terms such as `master/slave`,
+`whitelist/blacklist`, which are based on racial concepts. Their continued use
+maintains the racial stereotypes they depict. Better alternatives in meaning and
+technical correctness exist, like `leader/follower`, `blocklist/allowlist`.
+
+In the Nordic mythology, a `saga` is a long, continuous recollection of stories
+about the history of humans, legends, and Gods. The term `saga` reflects very
+well what happens in a Git repository. Changes happen in branches (some teams
+tie them to _User Stories_, which are sometimes directly or loosely coupled to
+the main branch). Once the changes are finalized, they get added to the main
+branch, or get appended in the case of a rebase. The mental model of a big book
+of stories fits this process very well.
+
+Therefore, the main branch in this project is named `saga`. `master` must not be
+used.

adr/002-clean-gitignore.md

@@ -0,0 +1,8 @@
+# ADR 002: Clean `.gitignore` file
+
+A `.gitignore` file in a project must only cover the artifacts caused by the
+contained source code and not those caused by the personal choice of editor or
+the environment of a developer.
+
+This is explained in detail
+[here](https://github.com/coderbyheart/first-principles/issues/30).

adr/003-use-of-typescript.md

@@ -0,0 +1,12 @@
+# ADR 003: use of TypeScript
+
+This project is developed using [TypeScript](https://www.typescriptlang.org/) (a
+typed superset of JavaScript).
+
+JavaScript is the most popular language according to the
+[2019 Stack Overflow survey](https://insights.stackoverflow.com/survey/2019#technology)
+and it is therefore likely that many developers using the project will be
+familiar with the language concepts and how to use and run it.
+
+Virtually all cloud providers provide their SDKs in JavaScript or TypeScript
+which this project can integrate natively.

adr/README.md

@@ -0,0 +1,8 @@
+# Architecture decision records
+
+This folder contains the architecture decision records (ADRs) for this project.
+
+To know more about ADRs, see
+[Documenting architecture decisions](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)
+and the video on
+[Communicating and documenting architectural decisions](https://www.youtube.com/watch?v=rwfXkSjFhzc).

cdk.json

@@ -0,0 +1,3 @@
+{
+  "app": "npx tsx --no-warnings cdk/map.ts"
+}