@dvsa/cvs-feature-flags 0.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Driver & Vehicle Standards Agency
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# cvs-feature-flags
+
+Feature flags for the Commercial Vehicle Services (CVS) system, published as a GitHub package.
+
+### Pre-requisites
+
+- Node.js (Please see `.nvmrc` for specific version)
+- `npm` (If using [n](https://github.com/tj/n) or [nvm](https://github.com/nvm-sh/nvm), this will be automatically managed)
+- Security
+  - [Git secrets](https://github.com/awslabs/git-secrets)
+  - [ScanRepo](https://github.com/UKHomeOffice/repo-security-scanner)
+    - Unzip `repo-security-scanner_<version>_Darwin_<architercture>.tar.gz` and rename the executable inside the folder
+      to `scanrepo` - Add executable to path (using `echo $PATH` to find your path)
+
+### Getting started
+
+###### Run the following command after cloning the project
+
+1. `npm install` (or `npm i`)
+
+###### The code that will be published lives inside the ./src directory.
+
+If wishing to add new top level directories to the output, then they must be included in the `files` array inside `package.json` as well as included in the `clean:temp` command.

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@dvsa/cvs-feature-flags",
+  "version": "0.10.0",
+  "description": "Common package to be used in CVS to manage feature flags",
+  "author": "DVSA",
+  "license": "ISC",
+  "files": [
+    "profiles/**",
+    "LICENSE",
+    "package.json"
+  ],
+  "keywords": [
+    "typescript",
+    "nodejs"
+  ],
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "clean": "rimraf coverage dist && npm run clean:temp",
+    "clean:temp": "rimraf profiles",
+    "format": "prettier . --write",
+    "gitSecrets": "git secrets --scan . && git log -p -- . | scanrepo",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "prepare": "husky",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "build:package": "npm run build",
+    "prepublishOnly": "npm run build:package && cp -r ./dist/* . && rm -rf ./dist",
+    "postpublish": "git clean -fd && npm run clean:temp"
+  },
+  "dependencies": {
+    "@aws-lambda-powertools/parameters": "^2.1.1",
+    "lodash.merge": "^4.6.2"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-appconfigdata": "^3.525.0",
+    "@types/aws-lambda": "^8.10.131",
+    "@types/jest": "^29.5.11",
+    "@types/lodash.merge": "^4.6.9",
+    "@types/node": "^20.11.6",
+    "@typescript-eslint/eslint-plugin": "^7.9.0",
+    "@typescript-eslint/parser": "^7.9.0",
+    "aws-sdk-client-mock": "^3.0.1",
+    "aws-sdk-client-mock-jest": "^3.0.1",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
+    "husky": "^9.0.2",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.2.4",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "npm run lint:fix",
+      "npm run format"
+    ]
+  }
+}

package/profiles/index.d.ts

@@ -0,0 +1,3 @@
+export { getProfile as getVTXProfile } from './vtx';
+export { getProfile as getVTAProfile } from './vta';
+export { getProfile as getVTMProfile } from './vtm';

package/profiles/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVTMProfile = exports.getVTAProfile = exports.getVTXProfile = void 0;
+var vtx_1 = require("./vtx");
+Object.defineProperty(exports, "getVTXProfile", { enumerable: true, get: function () { return vtx_1.getProfile; } });
+var vta_1 = require("./vta");
+Object.defineProperty(exports, "getVTAProfile", { enumerable: true, get: function () { return vta_1.getProfile; } });
+var vtm_1 = require("./vtm");
+Object.defineProperty(exports, "getVTMProfile", { enumerable: true, get: function () { return vtm_1.getProfile; } });

package/profiles/vta.d.ts

@@ -0,0 +1,11 @@
+declare const defaultFeatureFlags: {
+    adr: {
+        enabled: boolean;
+    };
+    iva: {
+        enabled: boolean;
+    };
+};
+export type FeatureFlags = typeof defaultFeatureFlags;
+export declare const getProfile: () => Promise<FeatureFlags>;
+export {};

package/profiles/vta.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProfile = void 0;
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+const __1 = require("..");
+const feature_flags_1 = require("../feature-flags");
+const defaultFeatureFlags = {
+    adr: {
+        enabled: false,
+    },
+    iva: {
+        enabled: false,
+    },
+};
+const getProfile = async () => {
+    const flags = await (0, feature_flags_1.getFeatureFlags)(__1.FeatureFlagsClientName.VTA);
+    return (0, lodash_merge_1.default)(defaultFeatureFlags, flags);
+};
+exports.getProfile = getProfile;

package/profiles/vtm.d.ts

@@ -0,0 +1,4 @@
+declare const defaultFeatureFlags: {};
+export type FeatureFlags = typeof defaultFeatureFlags;
+export declare const getProfile: () => Promise<{}>;
+export {};

package/profiles/vtm.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProfile = void 0;
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+const __1 = require("..");
+const feature_flags_1 = require("../feature-flags");
+const defaultFeatureFlags = {};
+const getProfile = async () => {
+    const flags = await (0, feature_flags_1.getFeatureFlags)(__1.FeatureFlagsClientName.VTM);
+    return (0, lodash_merge_1.default)(defaultFeatureFlags, flags);
+};
+exports.getProfile = getProfile;

package/profiles/vtx.d.ts

@@ -0,0 +1,11 @@
+declare const defaultFeatureFlags: {
+    welshTranslation: {
+        enabled: boolean;
+        translatePassTestResult: boolean;
+        translateFailTestResult: boolean;
+        translatePrsTestResult: boolean;
+    };
+};
+export type FeatureFlags = typeof defaultFeatureFlags;
+export declare const getProfile: () => Promise<FeatureFlags>;
+export {};

package/profiles/vtx.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProfile = void 0;
+const lodash_merge_1 = __importDefault(require("lodash.merge"));
+const __1 = require("..");
+const feature_flags_1 = require("../feature-flags");
+const defaultFeatureFlags = {
+    welshTranslation: {
+        enabled: false,
+        translatePassTestResult: false,
+        translateFailTestResult: false,
+        translatePrsTestResult: false,
+    },
+};
+const getProfile = async () => {
+    const flags = await (0, feature_flags_1.getFeatureFlags)(__1.FeatureFlagsClientName.VTX);
+    return (0, lodash_merge_1.default)(defaultFeatureFlags, flags);
+};
+exports.getProfile = getProfile;