feat: add secureFieldsWithDetails 😋

[zFernand0]

What It Does

• Adds a new API to retrieve secureFields with more details
• Fix Enhance secureFields method to optionally return arg value, type, and name #2206

How to Test

Review Checklist
I certify that I have:

• tested my changes
• added/updated automated tests
• updated the changelog
• followed the contribution guidelines

Additional Comments

// using config.api.secure.secureFields()
[
  'profiles.lpar1.profiles.zosmf.properties.user',
  'profiles.lpar1.profiles.zosmf.properties.test0', // unknown property (boolean)
  'profiles.lpar1.profiles.zosmf.properties.test1', // unknown property (number)
  'profiles.lpar1.profiles.zosmf.properties.test2', // unknown property (missing)
  'profiles.lpar1.properties.tokenValue', // let's assume that lpar1 is a typeless profile
  'profiles.base.properties.tokenValue', 
]

Here is what the output will look like in case we would like to reuse the same IProfArgAttrs interface.

[
  {
    "argName": "user",
    "dataType": "string",
    "argValue": "fernando",
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.user"
    }
  },
  {
    "argName": "test0",
    "dataType": "boolean",
    "argValue": false,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.test0"
    }
  },
  {
    "argName": "test1",
    "dataType": "number",
    "argValue": 1234,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.test1"
    }
  },
  {
    "argName": "test2",
    "dataType": null,
    "argValue": undefined,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.profiles.zosmf.properties.test2"
    }
  },
  {
    "argName": "tokenValue",
    "dataType": null, // This is `null` because the lpar1 profile does not have a type
    "argValue": undefined,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.lpar1.properties.tokenValue"
    },
  {
    "argName": "tokenValue",
    "dataType": "string",
    "argValue": undefined,
    "argLoc": {
      "locType": 1,
      "osLoc": [
        "/Users/fernando/.zowe/zowe.config.json"
      ],
      "jsonLoc": "profiles.base.properties.tokenValue"
    }
  }
]

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.30%. Comparing base (35b9d47) to head (dc945c7).
Report is 3 commits behind head on next.

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #2241   +/-   ##
=======================================
  Coverage   91.30%   91.30%           
=======================================
  Files         632      632           
  Lines       18147    18147           
  Branches     3888     3849   -39     
=======================================
  Hits        16570    16570           
  Misses       1576     1576           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[traeok]

Thanks Fernando! I left a suggestion for the opts parameter, but the implementation LGTM.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
97.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[awharn]

Looks good to me, just have two little questions that don't need to be resolved.

[awharn]

I know this is being a little picky, but is this line necessary for the locally scoped config variable?

[awharn]

Again, is this necessary for the locally scoped profInfo?

[t1m0thyj]

Is adding this method necessary? I'm probably being dumb but it seems like the secureFields method has a layer parameter which can be used to filter the secure fields returned for only a specific layer.