Add branding format support to JS and Python SDKs - #2360
Merged
Merged
Conversation
Co-Authored-By: abi@sideguide.dev <abimex@gmail.com>
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:
|
- Add JS SDK unit tests in branding.test.ts with 4 test cases - Add Python SDK unit tests in test_branding.py with 5 test cases - Update Python SDK normalize_document_input to handle colorScheme -> color_scheme conversion - Add model_config extra='allow' to BrandingProfile for future extensibility - All tests pass locally (25 JS tests, 5 Python tests) Co-Authored-By: abi@sideguide.dev <abimex@gmail.com>
- Bump JS SDK version from 4.4.1 to 4.5.0 - Bump Python SDK version from 4.5.0 to 4.6.0 Version bumps reflect the addition of branding format support and comprehensive unit tests. Co-Authored-By: abi@sideguide.dev <abimex@gmail.com>
Merged
5 tasks
nickscamara
approved these changes
Nov 5, 2025
jerbao
pushed a commit
to jerbao/firecrawl-custom
that referenced
this pull request
Aug 22, 2026
* Add branding format support to JS and Python SDKs Co-Authored-By: abi@sideguide.dev <abimex@gmail.com> * Add comprehensive unit tests for branding format in both SDKs - Add JS SDK unit tests in branding.test.ts with 4 test cases - Add Python SDK unit tests in test_branding.py with 5 test cases - Update Python SDK normalize_document_input to handle colorScheme -> color_scheme conversion - Add model_config extra='allow' to BrandingProfile for future extensibility - All tests pass locally (25 JS tests, 5 Python tests) Co-Authored-By: abi@sideguide.dev <abimex@gmail.com> * Bump SDK versions for branding format release - Bump JS SDK version from 4.4.1 to 4.5.0 - Bump Python SDK version from 4.5.0 to 4.6.0 Version bumps reflect the addition of branding format support and comprehensive unit tests. Co-Authored-By: abi@sideguide.dev <abimex@gmail.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: abi@sideguide.dev <abimex@gmail.com>
zeekay
pushed a commit
to Dream-AI-4444/firecrawl
that referenced
this pull request
Sep 10, 2026
* Add branding format support to JS and Python SDKs Co-Authored-By: abi@sideguide.dev <abimex@gmail.com> * Add comprehensive unit tests for branding format in both SDKs - Add JS SDK unit tests in branding.test.ts with 4 test cases - Add Python SDK unit tests in test_branding.py with 5 test cases - Update Python SDK normalize_document_input to handle colorScheme -> color_scheme conversion - Add model_config extra='allow' to BrandingProfile for future extensibility - All tests pass locally (25 JS tests, 5 Python tests) Co-Authored-By: abi@sideguide.dev <abimex@gmail.com> * Bump SDK versions for branding format release - Bump JS SDK version from 4.4.1 to 4.5.0 - Bump Python SDK version from 4.5.0 to 4.6.0 Version bumps reflect the addition of branding format support and comprehensive unit tests. Co-Authored-By: abi@sideguide.dev <abimex@gmail.com> --------- Co-authored-by: abi@sideguide.dev <abimex@gmail.com> Co-authored-by: Hanzo Dev <dev@hanzo.ai>
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
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 branding format support to JS and Python SDKs
Summary
This PR adds type definitions for the
brandingformat to both the JavaScript/TypeScript and Python SDKs. The branding format is already implemented and supported in the API but was missing from the SDK type definitions.Changes:
'branding'to theFormatStringtype union in both SDKsBrandingProfileinterface/class with comprehensive type definitions including:branding?: BrandingProfilefield to theDocumenttype in both SDKsThe types were copied from the API's existing
apps/api/src/types/branding.tsto ensure compatibility.Review & Testing Checklist for Human
formats: ["branding"]and verify the returned branding data is properly typed and matches the BrandingProfile interfaceformats: ["branding"]and verify the returned branding data is properly typed and matches the BrandingProfile classTest Plan
Notes
Dict[str, Any]types for nested structures compared to TypeScript's more specific types, which is acceptable for Python's dynamic natureapps/api/src/lib/branding/with comprehensive branding extraction logicLink to Devin run: https://app.devin.ai/sessions/24af7e0ad2d64415966c1abf54522ada
Requested by: abi@sideguide.dev (@abimaelmartell)
Summary by cubic
Adds branding format support to the JS and Python SDKs, aligned with the API’s existing branding schema. Request ["branding"] to get typed data via Document.branding; Python normalizes colorScheme to color_scheme.
New Features
Bug Fixes
Written for commit 558a1eb. Summary will update automatically on new commits.