feat: add public URL support to file upload and get methods #99
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 generatePublicUrl parameter to FileUploadParams - Add isPublic parameter to Files.get method - Add public_url field to FileResponse and PresignedUrlResponse - Add comprehensive tests for new functionality - Matches backend API changes from vlm-lab PR #1017 Co-Authored-By: [email protected] <[email protected]>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
- Fixes high severity DoS vulnerability (GHSA-4hjh-wcwx-xvwj) - Updates axios from <1.12.0 to 1.12.2 - Resolves CI security audit failure Co-Authored-By: [email protected] <[email protected]>
- Use type assertion to access name property on error.cause - Fixes compilation error introduced by axios 1.12.2 update - Maintains existing error handling logic Co-Authored-By: [email protected] <[email protected]>
- Remove preview_url field from PresignedUrlResponse interface - Remove generateFilePreviewUrl function and PreviewUrlResponse interface - Remove all related imports and test code - Update integration test describe block name Addresses PR feedback from Mirajul-Mohin Co-Authored-By: [email protected] <[email protected]>
- Update version from 0.5.4 to 1.0.0 - Refactor Files class methods to improve parameter handling and consistency - Update integration tests to reflect changes in public_url handling
…iles.test.ts - Changed single quotes to double quotes for consistency across the test file. - Enhanced readability of test cases by aligning formatting and structure. - No functional changes were made to the tests or the underlying logic.
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.
Add public URL support and remove deprecated preview URL functionality
Summary
This PR implements public URL generation support for file uploads and retrieval in the VlmRun Node.js SDK, mirroring changes from backend PR #1017. It also removes deprecated preview URL functionality based on PR feedback.
New Features:
generatePublicUrl?: booleanparameter to file upload (defaults totrue)isPublic?: booleanparameter to file get methodpublic_url?: stringfield toFileResponseandPresignedUrlResponsetypesBreaking Changes:
generateFilePreviewUrl()method from Files classpreview_urlfield fromPresignedUrlResponseinterfacePreviewUrlResponseinterface entirelyAdditional fixes:
error.causecastingReview & Testing Checklist for Human
generatePublicUrl: trueand verify the returnedpublic_urlis accessible and serves the file contentgenerateFilePreviewUrl()andpreview_urlfield won't impact existing users severelygeneratePublicUrldefaulting totrueis the desired behavior (this changes existing upload behavior)npm run test:integrationto verify SDK correctly communicates with backend API using the new parametersNotes