Karrio OSS 2024.6

Important

Thank you for your patience as I go through a time of workload adjustment between my new role and the maintenance of Karrio. Read my community announcement here

Feat

• refactor: dashboard extracting non-routing code and dependencies to @karrio/core package
• refactor: dashboard from Nextjs page router to app router
• feat: apply utc timezone to sapient integration ship date
• feat: add support for FedEx scan events multi-datetime formats
• feat: handle shipment_date update when passed upstream instead of per extension implementations
• feat: add karrio.lib to document template context
• feat: Disable "note" alert types as previously done in fedex_ws #638
• feat: rename legacy USPS extensions to usps_wt (for USPS Web Tools)
• feat: Carrier Connection REST API #582
• reat: [carrier-integration | interoperability] SAPIENT #633
• feat: FedEx Tracking should be giving us the signed_by #635
• feat: USPS REST API integration
• feat: Handle defaulting size units to LB/IN for UPS US rates and shipment requests
• feat: add a description field to parcel forms
• feat: add missing per package description data mapping to ups extension
• feat: cherry-pick hay_post integration
• feat: Finalize eShipper new API integration
• feat: add back FedEx tracking POD image
• feat: add workspace config for automatically applying insurance to full package value
• feat: add support for metadata link rendering
• feat: Add standardized flag for all supported carriers
• feat: expose return_address to GraphQL and API specs and generated clients
• feat: Add return address to create label forms across the dashboard
• Introduce the return_address field
• feat: Add Django admin editor for document templates
• feat: Add support for env config of Redis username and password (#564)
• feat: Bootstrap new eshipper API extension
• feat: Make cache available to all connection settings
• feat: add carrier_id to the POST /v1/proxy/shipping/{carrier_name}/cancel to allow precise carrier account selection for the operation. #590
• feat: Enhance Documents REST API with support for template management CRUD operations and generic document generator API in addition to Trade API upload API. #581

Fix

• fix: eshipper cancel shipment request, and add special cancel error handling for undocumented errors
• fix: eshipper datetime requirement for ship date and update tests for order cancellation
• fix: tracker filter to return tracker if already existent
• fix: fedex tracking estimated delivery date response parsing
• fix: migration defaulting to hardcoded eshipper for carrier_name
• fix: sapient shipment cancellation response parsing
• Fix FedEx multi shipment creating multiple of packages
• fix: invalid language and lang field default state assignment
• fix: eshipper carrier data parsing for both rating and shipping response data
• fix: debug and consolidate eshipper shipment cancellation with live tests
• fix: connection data parsing when saving tracing records
• feat: handle fedex max contact and company name
• fix: usps API token missing scope
• fix: eShipper server URL for production mode and label problem
• hotfix: add fallback values to SAPIENT shipment request
• fix: consolidate SAPIENT integration with live tests
• fix: eshipper dimension parsing requirements
• hot-fix(2024.6-rc24): migration race condition issue #645
• clean up: remaining usage of deprecated providers.MODELS dynamic object created by old carrier settings models
• hot-fix for 2024.6-rc24: regression on carrier configuration test_mode assignment for carrier connection registration in live mode.
• fix: Incorrect Item Quantity Distribution in Multi-Package Orders #634
• fix: eshipper database migration leaving orphan carrier data
• fix: #628
• fix: authenticated requests race condition issues
• fix: Dashboard environment variables configuration breaking change
• fix: dashboard Nextjs undefined env var caused by deprecated environment Configs
• fix: shipment sample fallback on document generation module
• fix: cancel shipment carrier_id check
• fix: UPS Saturday delivery option flag mapping
• fix: FedEx variableOptions fallback value to None
• fix: regression on FedEx shipping options parsing
• fix: regression of quicktype schema type generation commands
• fix: FedEx "variableOptions" format issue
• fix(2 birds): cache declaration leftovers and tracing record saving failing due to cache handle

Docs

• docs: Update API specs and generate API docs
• docs: update API docs with new return_address support
• docs: setup docusaurus docusaurus-openapi-docs plugin
• docs: Improve generated OpenAPI with annotation

Chore

• chore: deprecate apps module from OSS build
• chore: handle eshipper credential transfer from username|password to principal|credential
• chore: fix generic carrier configration parsing
• chore: fix docs generation and docusaurus dependencies
• chore: improve enum typing for lang and language configs for connectors and handle default values for carrier registration modal
• refactor: carrier proxies to only be generated for django admin and prevent migration requirement
• chore: update create_label component formatting
• chore: update API tests for the return_address field
• chore: update unit tests for the new return_address field
• chore: update Readme dashboard illustration
• chore: Apply minimal query optimization
• chore: Prevent backup file creation from sed command
• chore: investigate Admin user creation issue: /admin/user_accounts trying to add a new user account does not get added

Breaking changes

• feat: add daytime precision to tracking event time format (AM/PM)
• feat: remove deprecated eshipper_xml extension
• Rename legacy extension eshiper -> eshipper_xml to prepare for the upgrade to the new eShipper API
• The Electronic Trade Document upload API was changed from POST /v1/documents to POST /v1/documents/uploads
• The GET /v1/documents endpoint returning ETD upload records is now GET /v1/documents/uploads

Caution

Please make sure to update your deployment environment variables for the dashboard when upgrading to rc10 +
Check out the docs here and the following files to make sure you have the right environment variables especially if you are not using our public docker-compose files and have a custom deployment or hosted on something live Vercel.

• Dashboard env config
• Local dev docker-compose.yml
• Hobby docker-compose.hobby.yml

Special thanks to contributors: @ChrisNolan (🎉 first contribution), @jacobshilitz and @david-kocharyan

🚀 Celebrating a new sponsor:

@ alissonf216