Chore/readmes for blocks and integrations#705
Conversation
- Introduced cart-related modules to Medusa.js integration with support for create, update, and delete operations. - Included mappings and services for handling carts across integrations. - Updated relevant configurations, docs, and seed data.
- Added models, services, and mappers for customers, payments, and checkout. - Enhanced carts and orders to support additional fields like email and payment session. - Integrated mocked module functionality for new services. - Refined Medusa.js mappings for customer addresses and shipping options.
- Renamed methods, parameters, and models for clarity and consistency (e.g., `setupAddresses` to `setAddresses`). - Centralized support for guest email handling using `email` field across carts, orders, and checkout processes. - Removed redundant calls and optimized order completion workflow.
- Added locale-based grouping for payment providers. - Introduced utility to retrieve localized payment method display info. - Updated cart and checkout services to support locale-based operations. - Enhanced cart item handling with improved product mapping and variant support. - Addressed stricter authentication for customer cart access and actions.
…oducts, customers, and orders
…d field mappings - Added documentation for Carts, Customers, and Checkout services, including API methods and data models. - Updated Products module to reference associated entities (e.g., Carts and Orders). - Enhanced Tickets API docs with clarified field mapping and integration-specific requirements. - Improved docs with consistent formatting.
- Replaced hardcoded URLs with dynamic inputs for better flexibility in checkout. - Enhanced promotion handling with direct API invocation for addition and removal. - Refactored `carts.mapper` to standardize currency to uppercase.
…module - Updated models, mappers, and service logic to use `sku` for identifying product variants. - Adjusted tests and mocked data mappings to align with the new `sku` field. - Revised documentation to reflect the parameter changes and improve consistency.
- Updated request parameters across cart-related models to include `locale` field. - Fixed incorrect HTTP method in promotion removal logic. - Updated checkout service to accept dynamic `returnUrl` and `cancelUrl` values.
- Added stricter validation for payment and shipping methods in the checkout service. - Refactored currency handling to use default currency when missing. - Standardized import paths for `handleHttpError` utility across modules.
…ove error handling across modules
… type handling across payment and cart modules - Removed `type` field from `PaymentMethod` and `Cart` entities, mappers, and related services. - Standardized error handling in payment and customer address services with clearer exception usage.
…tion usage in services
…price mapping for consistent error handling and field validation
…usajs-integration-for-checkout-process # Conflicts: # packages/integrations/medusajs/src/modules/medusajs/medusajs.service.spec.ts # packages/integrations/medusajs/src/modules/medusajs/medusajs.service.ts # packages/integrations/medusajs/src/modules/products/products.mapper.ts # packages/integrations/medusajs/src/modules/products/products.service.spec.ts # packages/integrations/medusajs/src/modules/products/products.service.ts
…d access to ProductList block
…API product methods
…nd remove unused address fields
- add setup and usage guides - update cart and checkout documentation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughAdds README documentation and standardized package.json metadata (keywords, repository, homepage, bugs, and some descriptions/scripts) across many packages (blocks, integrations, configs, utils, framework, ui, telemetry, modules, CLI) and updates turbo generator templates to scaffold READMEs and package metadata. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Coverage Report for packages/configs/vitest-config
File CoverageNo changed files found. |
…cks-and-integrations
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/integrations/redis/README.md`:
- Around line 49-58: The README currently lists CACHE_REDIS_HOST and
CACHE_REDIS_PORT as "Required" but the code in cache.service.ts only reads them
when CACHE_ENABLED === 'true'; update the README to reflect that
CACHE_REDIS_HOST and CACHE_REDIS_PORT are required only when CACHE_ENABLED is
enabled (or move them to "Optional" with a conditional note). Mention
CACHE_ENABLED, CACHE_REDIS_HOST, CACHE_REDIS_PORT and keep CACHE_TTL as optional
with its default (300) shown, and add a short sentence like "CACHE_REDIS_HOST
and CACHE_REDIS_PORT are required only if CACHE_ENABLED is set to true" so
readers know the variables are conditional.
- Around line 24-33: The first example in README imports an unused symbol
(Cache) and references a nonexistent RedisConfig export from
'@o2s/integrations.redis/integration'; fix by either deleting that entire first
example and leaving the second (which uses Cache.CacheIntegrationConfig), or
update the example to import the actual export (Config) and use Config.cache
instead of RedisConfig; locate references to "import { Cache }", "RedisConfig",
"Config.cache", and "Cache.CacheIntegrationConfig" in the snippet and apply one
of these two fixes so the example compiles and matches the real exports.
- Around line 72-75: The README incorrectly advertises "Connection pooling"
while the integration uses the redis library's createClient()
(single-connection) and not createClientPool(); remove the "Connection pooling"
bullet from the feature list and, if desired, replace it with a note that
pooling can be enabled via createClientPool() in the redis library to avoid
misleading readers; update any related docs or examples that mention pooling to
reference createClient() vs createClientPool() by name.
What does this PR do?
package.jsonfiles for all existing blocks and integrationsSummary by CodeRabbit
Documentation
Chores