feat(list): Add maxLength and start options to List SDK functions

[traeok]

What It Does

• Added the maxLength option to List SDK functions (allMembers, dataSetsMatchingPattern, membersMatchingPattern) to specify the maximum number of items to return.
• Added the start option to List SDK functions (allMembers, dataSetsMatchingPattern, membersMatchingPattern) to specify the first data set/member name to return in the response.
• Updated logic for a system test that wasn't actually validating the behavior of the start option in List.dataSet. Now, the test validates that start works as expected.

How to Test

See the scripts in this gist.

1. Checkout this branch on your machine and run npm install && npm run build from the root of the repo.
2. Grab one of the scripts defined in the gist and save it to a folder where the packages can be imported - I placed mine in packages/zosfiles
3. For the maxLength script, replace the "USER.*" pattern with a pattern that will match results for your default z/OSMF profile.
4. For the start script, replace the pattern mentioned in step 3 and adjust the value for the start option to match a data set listed by the pattern.
5. Observe that maxLength is respected (e.g. maxLength: 1 returns only one data set matching the pattern)
6. Observe that start is respected (e.g. "USER.*" with "USER.STARTDS" as the start option results in the list starting with USER.STARTDS)

Review Checklist
I certify that I have:

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

Additional Comments

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.33%. Comparing base (97a3c68) to head (342f8f1).

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #2409    +/-   ##
========================================
  Coverage   91.33%   91.33%            
========================================
  Files         639      639            
  Lines       18248    18251     +3     
  Branches     3834     3945   +111     
========================================
+ Hits        16666    16670     +4     
+ Misses       1580     1579     -1     
  Partials        2        2            

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

[github-actions]

📅 Suggested merge-by date: 1/29/2025

[zFernand0]

LGTM! 😋

I left one comment regarding uri encoding things 😋
Could we chat about it briefly? 😋

Addressed in 0a1f056

[zFernand0]

LGTM! 😋
thanks for addressing the comment so quickly 🙏

[zFernand0]

Thanks for reverting the format changes. 😋
I'm not opposed if you'd like to run it agains the entire repo (on a separate PR) 🙏

Also, this worked fine with special characters 🙏
FERNANDO.A10123.ENCO#ED.DATA
Thanks!

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud