feat: Add isSensitive field for handling of sensitive parameters

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-schemas",
-  "version": "1.0.77",
+  "version": "1.0.83",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

src/messages/apply-request-data-schema.json

@@ -64,6 +64,10 @@
                   },
                   "previousValue": {
                     "description": "The new value"
+                  },
+                  "isSensitive": {
+                    "description": "Indicates if the parameter is sensitive",
+                    "type": "boolean"
                   }
                 },
                 "required": [

src/messages/apply-request-data-schema.test.ts

@@ -36,6 +36,7 @@ describe('Apply request data schema', () => {
           operation: ParameterOperation.ADD,
           newValue: 'abc',
           previousValue: null,
+          isSensitive: false,
         }]
       }
     } as ApplyRequestData)).to.be.true;

src/messages/get-resource-info-response-data-schema.json

@@ -49,6 +49,12 @@
         }
       }
     },
+    "sensitiveParameters": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
     "allowMultiple": {
       "type": "boolean"
     }

src/messages/get-resource-info-response-data-schema.test.ts

@@ -40,7 +40,7 @@ describe('Get resources response data schema', () => {
             "items": {
               "type": "string"
             }
-          }
+          },
         },
         dependencies: [
           "typeA",
@@ -56,11 +56,7 @@ describe('Get resources response data schema', () => {
         requiredParameters: ['plugin']
       },
       allowMultiple: true,
-    })).to.be.true;
-
-    expect(validate({
-      type: 'type',
-      plugin: 'core-plugin',
+      sensitiveParameters: [],
     })).to.be.true;
 
     // For testing the typescript type
@@ -134,10 +130,15 @@ describe('Get resources response data schema', () => {
             "items": {
               "type": "string"
             }
+          },
+          "sensitiveProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           }
         }
       }
-
     })).to.be.false;
 
     expect(validate({

src/messages/initialize-response-data-schema.json

@@ -18,6 +18,12 @@
             "items": {
               "type": "string"
             }
+          },
+          "sensitiveParameters": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           }
         },
         "required": [

src/messages/initialize-response-data-schema.test.ts

@@ -22,6 +22,7 @@ describe('Get resources response data schema', () => {
         {
           type: 'typeB',
           dependencies: [],
+          sensitiveParameters: ['paramA', 'paramB'],
         }
       ]
     })).to.be.true;

src/messages/plan-response-data-schema.json

@@ -46,6 +46,10 @@
           },
           "newValue": {
             "description": "The new value"
+          },
+          "isSensitive": {
+            "description": "Indicates if the parameter is sensitive",
+            "type": "boolean"
           }
         },
         "required": ["name", "operation", "previousValue", "newValue"]

src/messages/plan-response-data-schema.test.ts

@@ -27,7 +27,8 @@ describe('Plan response data schema', () => {
         name: 'parameter1',
         operation: ParameterOperation.ADD,
         previousValue: null,
-        newValue: 'abc'
+        newValue: 'abc',
+        isSensitive: false,
       }]
     } as PlanResponseData)).to.be.true;
   })

src/types/index.ts

@@ -94,6 +94,7 @@ export interface PlanResponseData {
     operation: ParameterOperation;
     previousValue: unknown | null;
     newValue: unknown | null;
+    isSensitive?: boolean;
   }>
 }
 
@@ -116,6 +117,7 @@ export interface GetResourceInfoResponseData {
     requiredParameters: string[] | null;
     preventImport?: boolean;
   },
+  sensitiveParameters?: string[];
   allowMultiple: boolean;
 }
 
@@ -160,13 +162,15 @@ export interface ApplyRequestData {
       operation: ParameterOperation;
       newValue: unknown | null;
       previousValue: unknown | null;
+      isSensitive?: boolean;
     }>
   }
 }
 
 export interface ResourceDefinition {
   type: string;
   dependencies: string[];
+  sensitiveParameters?: string[];
 }
 
 export interface InitializeRequestData {