@moreapp/common-nodejs 0.2.0

package/.eslintignore

@@ -0,0 +1,2 @@
+**/*.js
+node_modules

package/.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "env": {
+    "node": true
+  },
+  "extends": ["plugin:prettier/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": ["./tsconfig.json"],
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "plugins": ["prettier", "@typescript-eslint"],
+  "rules": {
+    "prettier/prettier": ["error"],
+    "default-case": "off",
+    "@typescript-eslint/switch-exhaustiveness-check": "error"
+  },
+  "ignorePatterns": ["build"]
+}

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn build
+npx lint-staged

package/.nvmrc

@@ -0,0 +1 @@
+18.12.0

package/.prettierignore

@@ -0,0 +1 @@
+dist

package/README.md

@@ -0,0 +1,12 @@
+# Notification service
+
+# Direnv
+
+`direnv` loads the `.envrc` file automatically
+This loads Sparkpost secrets via `kubectl`
+
+**NOTE:** make sure the dev-cluster in `kubectx` is named `dev`!
+
+# Pre-commit hooks
+
+Run `yarn prepare` once to install Git hooks, doing lints and prettier formatting

package/bitbucket-pipelines.yml

@@ -0,0 +1,53 @@
+image: node:18.12.0
+
+pipelines:
+  pull-requests:
+    '**':
+      - step:
+          name: Analyse
+          services:
+            - docker
+          caches:
+            - docker
+            - node
+            - sonar
+          script:
+            - yarn install --frozen-lockfile
+            - yarn format:check
+            - yarn lint:check
+            - yarn build
+            - yarn test --coverage --testResultsProcessor=jest-sonar-reporter --detectOpenHandles
+            - pipe: sonarsource/sonarcloud-scan:1.4.0
+              variables:
+                EXTRA_ARGS: '-Dsonar.sources=src -Dsonar.tests=src -Dsonar.test.inclusions="**/*.test.js" -Dsonar.coverage.exclusions="**/node_modules/**,**/*.spec.ts" -Dsonar.javascript.lcov.reportPaths=coverage/lcov.info'
+            - pipe: sonarsource/sonarcloud-quality-gate:0.1.6
+  branches:
+    master:
+      - step:
+          name: "Build"
+          caches:
+            - node
+          script:
+            - yarn --frozen-lockfile
+            - yarn build
+          artifacts:
+            - build/**
+      - step:
+          name: "Publish to NPM"
+          trigger: manual
+          caches:
+            - node
+          script:
+            - npm version minor -m "Upgrade to %s [skip ci]"
+            - git push && git push --tags
+            - pipe: atlassian/npm-publish:0.3.2
+              variables:
+                NPM_TOKEN: $NPM_TOKEN
+                EXTRA_ARGS: "--access public"
+
+definitions:
+  caches:
+    sonar: ~/.sonar/cache
+  services:
+    docker:
+      memory: 2048

package/build/jest.config.d.ts

@@ -0,0 +1,3 @@
+import type { Config } from "@jest/types";
+declare const config: Config.InitialOptions;
+export default config;

package/build/jest.config.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    verbose: true,
+    preset: "ts-jest",
+    testEnvironment: "node",
+    testPathIgnorePatterns: ["/node_modules/", "/dist/"],
+    roots: ["<rootDir>/src"],
+    transform: {
+        "^.+\\.ts?$": "ts-jest",
+    },
+};
+exports.default = config;

package/build/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./utils";

package/build/src/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./utils"), exports);

package/build/src/utils.d.ts

@@ -0,0 +1 @@
+export declare function environmentVariable(key: string, fallback?: string | number): string;

package/build/src/utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.environmentVariable = void 0;
+function environmentVariable(key, fallback) {
+    const value = process.env[key] || fallback;
+    if (value) {
+        return value.toString();
+    }
+    throw new Error(`Missing environment variable '${key}'`);
+}
+exports.environmentVariable = environmentVariable;

package/build/src/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/utils.test.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+describe("environmentVariable", () => {
+    test("Should throw when environment variable does not exist", async () => {
+        process.env["COMMONS_NODEJS_TEST_EXISTING"] = "SOME_VALUE";
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_EXISTING")).toBe("SOME_VALUE");
+    });
+    test("Use fallback value when environment variable does not exist", async () => {
+        expect((0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING", "DEFAULT_VALUE")).toBe("DEFAULT_VALUE");
+    });
+    test("Should throw when environment variable does not exist", async () => {
+        expect(() => (0, utils_1.environmentVariable)("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow("Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'");
+    });
+});

package/jest.config.ts

@@ -0,0 +1,14 @@
+import type { Config } from "@jest/types";
+
+const config: Config.InitialOptions = {
+  verbose: true,
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
+  roots: ["<rootDir>/src"],
+  transform: {
+    "^.+\\.ts?$": "ts-jest",
+  },
+};
+
+export default config;

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@moreapp/common-nodejs",
+  "version": "0.2.0",
+  "license": "UNLICENSED",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest",
+    "prettier": "prettier './**/*.{ts,json,yaml,md,}'",
+    "format:check": "yarn prettier --check",
+    "format:fix": "yarn prettier --write",
+    "lint:check": "eslint . --ext ts",
+    "lint:fix": "yarn lint:check --fix",
+    "prepare": "husky install"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@types/jest": "29.2.0",
+    "@types/node": "18.11.8",
+    "@typescript-eslint/eslint-plugin": "5.41.0",
+    "@typescript-eslint/parser": "5.41.0",
+    "eslint": "8.26.0",
+    "eslint-config-airbnb-typescript": "17.0.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "husky": "8.0.1",
+    "jest": "29.2.2",
+    "jest-mock-extended": "3.0.1",
+    "jest-sonar-reporter": "2.0.0",
+    "lint-staged": "13.0.3",
+    "prettier": "2.7.1",
+    "ts-jest": "29.0.3",
+    "ts-node": "10.9.1",
+    "typescript": "4.8.4"
+  },
+  "prettier": {
+    "printWidth": 100,
+    "singleQuote": false
+  },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "yarn format:fix",
+      "yarn lint:fix"
+    ]
+  }
+}

package/sonar-project.properties

@@ -0,0 +1,5 @@
+sonar.sources=src
+sonar.exclusions=src/**/*.test.ts
+sonar.tests=src/**/*.test.ts
+sonar.testExecutionReportPaths=test-report.xml
+sonar.javascript.lcov.reportPaths=coverage/lcov.info

package/src/index.ts

@@ -0,0 +1 @@
+export * from "./utils";

package/src/utils.test.ts

@@ -0,0 +1,20 @@
+import { environmentVariable } from "./utils";
+
+describe("environmentVariable", () => {
+  test("Should throw when environment variable does not exist", async () => {
+    process.env["COMMONS_NODEJS_TEST_EXISTING"] = "SOME_VALUE";
+    expect(environmentVariable("COMMONS_NODEJS_TEST_EXISTING")).toBe("SOME_VALUE");
+  });
+
+  test("Use fallback value when environment variable does not exist", async () => {
+    expect(environmentVariable("COMMONS_NODEJS_TEST_NON_EXISTING", "DEFAULT_VALUE")).toBe(
+      "DEFAULT_VALUE"
+    );
+  });
+
+  test("Should throw when environment variable does not exist", async () => {
+    expect(() => environmentVariable("COMMONS_NODEJS_TEST_NON_EXISTING")).toThrow(
+      "Missing environment variable 'COMMONS_NODEJS_TEST_NON_EXISTING'"
+    );
+  });
+});

package/src/utils.ts

@@ -0,0 +1,8 @@
+export function environmentVariable(key: string, fallback?: string | number): string {
+  const value = process.env[key] || fallback;
+  if (value) {
+    return value.toString();
+  }
+
+  throw new Error(`Missing environment variable '${key}'`);
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    "lib": ["ES2021"],
+    "module": "commonjs",
+    "target": "ES2021",
+    "outDir": "./build",
+    "strict": true,
+    "declaration": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    // Required to load JSON files
+    "resolveJsonModule": true
+  }
+}