@rbaileysr/zephyr-managed-api 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/README.md +23 -1
  2. package/dist/README.md +699 -0
  3. package/dist/error-strategy.d.ts +3 -0
  4. package/dist/error-strategy.d.ts.map +1 -1
  5. package/dist/error-strategy.js +3 -0
  6. package/dist/groups/All.d.ts +3 -0
  7. package/dist/groups/All.d.ts.map +1 -1
  8. package/dist/groups/All.js +2 -6
  9. package/dist/groups/Automation.d.ts +3 -0
  10. package/dist/groups/Automation.d.ts.map +1 -1
  11. package/dist/groups/Automation.js +2 -3
  12. package/dist/groups/Environment.d.ts +3 -0
  13. package/dist/groups/Environment.d.ts.map +1 -1
  14. package/dist/groups/Environment.js +2 -3
  15. package/dist/groups/Folder.d.ts +3 -0
  16. package/dist/groups/Folder.d.ts.map +1 -1
  17. package/dist/groups/Folder.js +2 -3
  18. package/dist/groups/IssueLink.d.ts +3 -0
  19. package/dist/groups/IssueLink.d.ts.map +1 -1
  20. package/dist/groups/IssueLink.js +2 -3
  21. package/dist/groups/Link.d.ts +3 -0
  22. package/dist/groups/Link.d.ts.map +1 -1
  23. package/dist/groups/Link.js +2 -3
  24. package/dist/groups/Priority.d.ts +3 -0
  25. package/dist/groups/Priority.d.ts.map +1 -1
  26. package/dist/groups/Priority.js +2 -3
  27. package/dist/groups/Project.d.ts +3 -0
  28. package/dist/groups/Project.d.ts.map +1 -1
  29. package/dist/groups/Project.js +2 -3
  30. package/dist/groups/Status.d.ts +3 -0
  31. package/dist/groups/Status.d.ts.map +1 -1
  32. package/dist/groups/Status.js +2 -3
  33. package/dist/groups/TestCase.d.ts +3 -0
  34. package/dist/groups/TestCase.d.ts.map +1 -1
  35. package/dist/groups/TestCase.js +2 -3
  36. package/dist/groups/TestCycle.d.ts +3 -0
  37. package/dist/groups/TestCycle.d.ts.map +1 -1
  38. package/dist/groups/TestCycle.js +2 -3
  39. package/dist/groups/TestExecution.d.ts +3 -0
  40. package/dist/groups/TestExecution.d.ts.map +1 -1
  41. package/dist/groups/TestExecution.js +2 -3
  42. package/dist/groups/TestPlan.d.ts +3 -0
  43. package/dist/groups/TestPlan.d.ts.map +1 -1
  44. package/dist/groups/TestPlan.js +2 -3
  45. package/dist/index.d.ts +5 -2
  46. package/dist/index.d.ts.map +1 -1
  47. package/dist/index.js +5 -2
  48. package/dist/package.json +54 -0
  49. package/dist/types.d.ts +3 -0
  50. package/dist/types.d.ts.map +1 -1
  51. package/dist/types.js +3 -0
  52. package/dist/utils-api-call.d.ts +3 -0
  53. package/dist/utils-api-call.d.ts.map +1 -1
  54. package/dist/utils-api-call.js +3 -0
  55. package/dist/utils.d.ts +3 -0
  56. package/dist/utils.d.ts.map +1 -1
  57. package/dist/utils.js +3 -0
  58. package/package.json +4 -4
package/README.md CHANGED
@@ -663,7 +663,7 @@ The `All` group provides a single point of access to all API methods across all
663
663
 
664
664
  ## License
665
665
 
666
- MIT
666
+ UNLICENSED - Copyright Adaptavist 2025 (c) All rights reserved
667
667
 
668
668
  ## Support
669
669
 
@@ -675,3 +675,25 @@ For issues, questions, or contributions, please refer to the project repository
675
675
  - **Zephyr API Documentation**: https://support.smartbear.com/zephyr-scale-cloud/api-docs/v2/
676
676
  - **ScriptRunner Connect Documentation**: https://docs.adaptavist.com/src/latest/
677
677
 
678
+ ## Changelog
679
+
680
+ ### 1.0.1
681
+
682
+ - **Added**: Comprehensive JSDoc comments with API endpoint descriptions and links to official documentation
683
+ - **Added**: Single import option via default export for convenient usage
684
+ - **Changed**: Removed `region` parameter from `createZephyrApi` - base URL now configured in Generic Connector
685
+ - **Improved**: Error handling to support both `BadRequestError` and `NotFoundError` in test examples
686
+ - **Improved**: Type safety and IntelliSense support throughout the API
687
+
688
+ ### 1.0.0
689
+
690
+ - **Initial Release**: Complete Managed API wrapper for Zephyr Cloud REST API v2
691
+ - **Added**: Full support for all Zephyr API endpoints (Test Cases, Test Cycles, Test Plans, Test Executions, etc.)
692
+ - **Added**: Type-safe TypeScript definitions for all API operations
693
+ - **Added**: Hierarchical API structure matching ScriptRunner Connect conventions
694
+ - **Added**: Automatic rate limiting retry with exponential backoff
695
+ - **Added**: Support for both API Connection and OAuth token authentication
696
+ - **Added**: Pagination helpers (`getAllPages`, `getAllPagesCursor`)
697
+ - **Added**: Error strategy builder for advanced error handling
698
+ - **Added**: Comprehensive error types compatible with Commons Core
699
+