forked from HlexNC/Document-Conversion-Solutions
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce NPM Package Functionality and Enhancements to Document Conversion API #4
Merged
Conversation
This file contains 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
…n development" This reverts commit 70e6a79.
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.
This PR introduces several key enhancements and additions to the Document Conversion API, aligning with our goal to expand the API's capabilities and ease of use. Below is a summary of the changes:
NPM Package Introduction: The API has been structured as an NPM package, facilitating easier integration into JavaScript and Node.js projects. This update includes necessary package.json adjustments and dependency updates.
New Documentation and Examples: To assist developers in leveraging the new NPM package, we've added comprehensive examples (
api-usage.md
andlibrary-usage.md
). These documents guide through the API utilization and library functions, demonstrating practical use cases.API and Utility Enhancements: Updates to
app.js
andofficegenHelper.js
include improvements in API endpoint structures and the document generation utility, optimizing performance and expanding the feature set.Workflow Adjustments for NPM Publishing: Modifications to
.github/workflows/publish.yml
ensure seamless integration with GitHub Actions for automated NPM package publishing, enhancing our CI/CD pipeline.Addition of
documentLibrary.js
: A new library file introduces advanced document handling capabilities, further broadening the API's utility for complex document generation and manipulation tasks.Conclusion:
This PR sets the stage for a more integrated and developer-friendly Document Conversion API. By embracing NPM packaging, we not only streamline the usage process but also open up new avenues for application development. We encourage feedback on these changes as we continue to enhance the API's functionality.