@dvsa/cvs-feature-flags 0.19.0 → 0.20.0

package/README.md

@@ -21,3 +21,40 @@ Feature flags for the Commercial Vehicle Services (CVS) system, published as a G
 ###### 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.
+
+
+### Naming conventions followed for RDS Migration
+
+When adding a new RDS migration object, the following conventions should be adhered to:
+1. The object should be named `<domain>DB` e.g. "testFacilityDB", "defectDB", "testTypeDB"
+
+2. A typical object should follow this structure:
+   - `enabled`: A boolean indicating if the feature is enabled.
+   - `<function>readDDB`: A boolean indicating if reading from DynamoDB is enabled.
+   - `<function>readAurora`: A boolean indicating if reading from Aurora is enabled.
+   - `<function>writeDDB`: A boolean indicating if writing to DynamoDB is enabled.
+   - `<function>writeAurora`: A boolean indicating if writing to Aurora is enabled.
+   
+(*Note: If Reads/Writes aren't required, the omit the flag)
+
+Example
+```json
+testFacilityDB: {
+  enabled: true,
+
+  // these flags control the /test-station/{+proxy}
+  testStationReadDDB: true,
+  testStationReadAurora: false,
+
+  // The only writes that occur in "test stations" are via the put, therefore no need for distinct flags
+  testStationWriteDDB: true,
+  testStationWriteAurora: false,
+        
+  // these flags control the /activities/{+proxy}
+  activityReadDDB: true,
+  activityReadAurora: false,
+  activityWriteDDB: true
+  activityWriteAurora: false
+}
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dvsa/cvs-feature-flags",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Common package to be used in CVS to manage feature flags",
   "author": "DVSA",
   "license": "ISC",
@@ -42,7 +42,7 @@
     "@types/aws-lambda": "^8.10.145",
     "@types/jest": "^29.5.14",
     "@types/lodash.merge": "^4.6.9",
-    "@types/node": "^22.15.3",
+    "@types/node": "^22.15.16",
     "aws-sdk-client-mock": "^4.0.1",
     "aws-sdk-client-mock-jest": "^4.1.0",
     "husky": "^9.1.7",

package/profiles/vtx.d.ts

@@ -17,6 +17,20 @@ declare const defaultFeatureFlags: {
     abandonedCerts: {
         enabled: boolean;
     };
+    /**
+     * Feature flags for the CVS test facility domain
+     */
+    testFacilityDB: {
+        enabled: boolean;
+        testStationReadDDB: boolean;
+        testStationReadAurora: boolean;
+        testStationWriteDDB: boolean;
+        testStationWriteAurora: boolean;
+        activityReadDDB: boolean;
+        activityReadAurora: boolean;
+        activityWriteDDB: boolean;
+        activityWriteAurora: boolean;
+    };
 };
 export type FeatureFlags = typeof defaultFeatureFlags;
 export declare const getProfile: () => Promise<FeatureFlags>;

package/profiles/vtx.js

@@ -26,6 +26,23 @@ const defaultFeatureFlags = {
     abandonedCerts: {
         enabled: true,
     },
+    /**
+     * Feature flags for the CVS test facility domain
+     */
+    testFacilityDB: {
+        enabled: true,
+        // these flags control the /test-station/{+proxy}
+        testStationReadDDB: true,
+        testStationReadAurora: false,
+        // the only write that occurs in "test stations" are via the put-test-station, therefore no need for distinct flags
+        testStationWriteDDB: true,
+        testStationWriteAurora: false,
+        // these flags control the /activities/{+proxy}
+        activityReadDDB: true,
+        activityReadAurora: false,
+        activityWriteDDB: true,
+        activityWriteAurora: false,
+    },
 };
 const getProfile = async () => {
     const flags = await (0, feature_flags_1.getFeatureFlags)(__1.FeatureFlagsClientName.VTX);