WIP: Typescript Interfaces #652
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add src/types.ts with comprehensive type exports - Add nylas/types subpath export in package.json - Export configuration types, resource parameter interfaces, and base classes - Add types-usage examples showing how to use the new export - Maintain 100% backwards compatibility with existing imports
- Fix AsyncListResponse async iteration pattern in analyzeMessagePatterns - Use iterator directly instead of awaiting first, then iterating - Add safety check for division by zero in average calculation - Add async-iteration-test.ts demonstrating correct pattern - Update README with new test file documentation
…ation - Add automated src/types.ts generation via scripts/generateTypesIndex.js - Integrate types generation into build process (prebuild hook) - Add comprehensive release validation via scripts/validateRelease.js - Add CI-friendly types validation via scripts/checkTypesUpToDate.js - Implement npm version hooks (preversion, postversion) for quality gates - Add GitHub Actions workflow for CI/CD validation - Ensure types are always current and all tests pass before releases Quality gates now validate: - Types are up-to-date with codebase - All tests pass - Linting standards met - Build integrity maintained - Examples compile correctly - Test coverage standards met This prevents broken releases and ensures types stay synchronized with the codebase automatically without manual maintenance.
- Remove src/types.ts and manual type generation infrastructure - Delete examples/types-usage/ directory and all related examples - Remove scripts/generateTypesIndex.js and scripts/checkTypesUpToDate.js - Update package.json to remove './types' export and related scripts - Update scripts/validateRelease.js to remove types validation - Update .github/workflows/validate-types.yml to remove types validation step - Add scripts/generateTypesViaApiExtractor.js as alternative implementation - Maintain core quality gates: linting, testing, build validation, examples validation The SDK returns to core functionality without additional types export. Quality assurance mechanisms remain functional for essential validations.
Pull Request Summary
Files Changed
View more in PlayerZero |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
License
I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.