Added recursive folder retrieval for easier tree creation. Also, why not JSDocs.

[seanspeaks]

TL;DR

Added comprehensive JSDoc documentation to the Frontify API client and improved code organization.

What changed?

• Added JSDoc comments to all methods in the Frontify API client
• Replaced querystring with node:querystring for Node.js native modules
• Added node:form-data import for file uploads
• Improved method organization and structure
• Added a new _nestedFoldersQuery helper method for recursive folder queries
• Removed redundant methods (listProjectFolders, listLibraryFolders, listSubFolderFolders)
• Enhanced listSubFolderAssets to support nested/recursive folder queries with depth control

How to test?

• Verify API functionality remains unchanged
• Check that IDE intellisense now provides helpful documentation for all methods
• Test the enhanced listSubFolderAssets with the new nested or recursive parameters to retrieve folder hierarchies

Why make this change?

This change improves developer experience by providing clear documentation for all API methods, making the codebase more maintainable and easier to understand. The enhanced folder query capabilities allow for more efficient retrieval of nested folder structures, while the code reorganization improves readability and removes duplicate functionality.

📦 Published PR as canary version: Canary Versions

✨ Test out this PR locally via:

npm install @friggframework/api-module-frontify@1.3.1-canary.29.4f5d484.0
# or 
yarn add @friggframework/api-module-frontify@1.3.1-canary.29.4f5d484.0

Version

Published prerelease version: @friggframework/api-module-frontify@2.0.0-next.4

Changelog

🐛 Bug Fix

• @friggframework/api-module-frontify
  • Added recursive folder retrieval for easier tree creation. Also, why not JSDocs. #29 (@seanspeaks)
• @friggframework/api-module-microsoft-teams, @friggframework/api-module-slack, @friggframework/api-module-42matters, @friggframework/api-module-asana, @friggframework/api-module-attio, @friggframework/api-module-connectwise, @friggframework/api-module-contentful, @friggframework/api-module-contentstack, @friggframework/api-module-crossbeam, @friggframework/api-module-deel, @friggframework/api-module-frontify, @friggframework/api-module-google-calendar, @friggframework/api-module-google-drive, @friggframework/api-module-helpscout, @friggframework/api-module-hubspot, @friggframework/api-module-ironclad, @friggframework/api-module-linear, @friggframework/api-module-salesforce, @friggframework/api-module-stripe, @friggframework/api-module-unbabel-projects, @friggframework/api-module-unbabel, @friggframework/api-module-zoho-crm, @friggframework/api-module-zoom
  • Updated the attachment method to allow for file uploads #28 (@seanspeaks)

Authors: 1

• Sean Matthews (@seanspeaks)

[seanspeaks]

• Added recursive folder retrieval for easier tree creation. Also, why not JSDocs. #29 👈 (View in Graphite)
• next

This stack of pull requests is managed by Graphite. Learn more about stacking.

[seanspeaks]

Merge activity

• Mar 21, 12:24 AM EDT: A user merged this pull request with Graphite.

[seanspeaks]

🚀 PR was released in @friggframework/api-module-frontify@2.0.0-next.4 🚀