Revamping to make repo a npm module instead

.eslintignore

@@ -0,0 +1 @@
+src/types/global.d.ts

.eslintrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'node'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.json'],
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:node/recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:jest/recommended', // Add this line to include Jest configuration
+  ],
+  rules: {
+    'node/no-missing-import': 'off',
+    'node/no-empty-function': 'off',
+    'node/no-unsupported-features/es-syntax': 'off',
+    'node/no-missing-require': 'off',
+    'node/shebang': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    quotes: ['warn', 'single', { avoidEscape: true }],
+    'node/no-unpublished-import': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitattributes

@@ -0,0 +1,2 @@
+# Set the repository to show as TypeScript rather than JS in GitHub
+*.js linguist-detectable=false

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Current Behavior
+
+<!-- Describe how the issue manifests. -->
+
+## Expected Behavior
+
+<!-- Describe what the desired behavior would be. -->
+
+## Steps to Reproduce the Problem
+
+  1.
+  1.
+  1.
+
+## Environment
+
+- Version: <!-- Version set in package.json -->
+- Platform: <!-- Win/Mac/Linux -->
+- Node.js Version: <!-- Output of running `node -v` -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,34 @@
+---
+name: 🌈 Feature request
+about: Suggest an amazing new idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature Request
+
+**Is your feature request related to a problem? Please describe.**
+<!-- A clear and concise description of what the problem is. Ex. I have an issue when [...] -->
+
+**Describe the solution you'd like**
+<!-- A clear and concise description of what you want to happen. Add any considered drawbacks. -->
+
+**Describe alternatives you've considered**
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+## Are you willing to resolve this issue by submitting a Pull Request?
+
+<!--
+  Remember that first-time contributors are welcome! 🙌
+-->
+
+- [ ] Yes, I have the time, and I know how to start.
+- [ ] Yes, I have the time, but I don't know how to start. I would need guidance.
+- [ ] No, I don't have the time, although I believe I could do it if I had the time...
+- [ ] No, I don't have the time and I wouldn't even know how to start.
+
+<!--
+  👋 Have a great day and thank you for the feature request!
+-->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,42 @@
+<!--
+  😀 Wonderful!  Thank you for opening a pull request.
+
+  Please fill in the information below to expedite the review
+  and (hopefully) merge of your change.
+-->
+
+### Description of change
+
+<!--
+  Please be clear and concise what the change is intended to do,
+  why this change is needed, and how you've verified that it
+  corrects what you intended.
+
+  In some cases it may be helpful to include the current behavior
+  and the new behavior.
+
+  If the change is related to an open issue, you can link it here.
+  If you include `Fixes #0000` (replacing `0000` with the issue number)
+  when this is merged it will automatically mark the issue as fixed and
+  close it.
+-->
+
+### Pull-Request Checklist
+
+<!--
+  Please make sure to review and check all of the following.
+
+  If an item is not applicable, you can add "N/A" to the end.
+-->
+
+- [ ] Code is up-to-date with the `main` branch
+- [ ] `npm run lint` passes with this change
+- [ ] `npm run test` passes with this change
+- [ ] This pull request links relevant issues as `Fixes #0000`
+- [ ] There are new or updated unit tests validating the change
+- [ ] Documentation has been updated to reflect this change
+- [ ] The new commits follow conventions outlined in the [conventional commit spec](https://www.conventionalcommits.org/en/v1.0.0/)
+
+<!--
+  🎉 Thank you for contributing!
+-->

.github/workflows/pr.yml

@@ -0,0 +1,30 @@
+name: Pull Request
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 14
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Run unit tests
+        run: npm test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/deployment.yaml → .github/workflows/release.yaml

@@ -14,23 +14,30 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Set up Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: 14
 
       - name: Install dependencies
         run: npm install
 
-      - name: 'Create env file'
-        run: |
-          touch .env
-          echo NODE_ENV=development >> .env
-          echo PORT=3000 >> .env
-          cat .env
-
       - name: Run unit tests
         run: npm test
 
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - uses: shallwefootball/s3-upload-action@master
+        name: Upload to S3
+        id: S3
+        with:
+          aws_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
+          aws_bucket: ${{ secrets.AWS_DEPLOYMENT_BUCKET_NAME }}
+          source_dir: 'static'
+
       - name: Deploy to AWS CodeDeploy
         run: |
           aws configure set aws_access_key_id ${{ secrets.AWS_ACCESS_KEY_ID }}

.gitignore

@@ -5,59 +5,127 @@ dist/
 
 # hide dotenv
 .env 
-
 # Compiled Java class files
 *.class
-
 # Compiled Python bytecode
 *.py[cod]
-
 # Log files
 *.log
-
 # Package files
 *.jar
-
 # Maven
 target/
-dist/
-
 # JetBrains IDE
 .idea/
-
 # Unit test reports
 TEST*.xml
-
 # Generated by MacOS
 .DS_Store
-
 # Generated by Windows
 Thumbs.db
-
 # Applications
 *.app
 *.exe
 *.war
-
 # Large media files
 *.mp4
 *.tiff
 *.avi
 *.flv
 *.mov
 *.wmv
-
-
 # Ignore metadata generated by Jekyll
 _site/
 .sass-cache/
 .jekyll-cache/
 .jekyll-metadata
-
 # Ignore folders generated by Bundler
 .bundle/
 vendor/
-
 .env
-
-terraform
+terraform
+# Logs
+logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+# nyc test coverage
+.nyc_output
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+# Bower dependency directory (https://bower.io/)
+bower_components
+# node-waf configuration
+.lock-wscript
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+# Dependency directories
+jspm_packages/
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+# TypeScript cache
+*.tsbuildinfo
+# Optional npm cache directory
+.npm
+# Optional eslint cache
+.eslintcache
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+# Optional REPL history
+.node_repl_history
+# Output of 'npm pack'
+*.tgz
+# Yarn Integrity file
+.yarn-integrity
+# dotenv environment variables file
+.env.test
+.env.local
+# parcel-bundler cache (https://parceljs.org/)
+.parcel-cache
+# Next.js build output
+.next
+out
+# Nuxt.js build / generate output
+.nuxt
+dist
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+# vuepress build output
+.vuepress/dist
+# Serverless directories
+.serverless/
+# FuseBox cache
+.fusebox/
+# DynamoDB Local files
+.dynamodb/
+# TernJS port file
+.tern-port
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+# Compiled code
+lib/