Feat(VNDA): Inventory

[aka-sacci-ccr]

What is this Contribution About?

Please provide a brief description of the changes or enhancements you are proposing in this pull request.

Issue Link

Please link to the relevant issue that this pull request addresses:

• Issue: #ISSUE_NUMBER

Loom Video

Record a quick screencast describing your changes to help the team understand and review your contribution. This will greatly assist in the review process.

Demonstration Link

Provide a link to a branch or environment where this pull request can be tested and seen in action.

Summary by CodeRabbit

• New Features
  • Product details now include inventory location information for product variants.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[github-actions]

Tagging Options

Should a new tag be published when this PR is merged?

• 👍 for Patch 0.133.17 update
• 🎉 for Minor 0.134.0 update
• 🚀 for Major 1.0.0 update

[coderabbitai]

Walkthrough

The changes extend the product data pipeline to fetch and process inventory place information. The loader now requests inventory place data via an API parameter, the client type definitions are updated to support this parameter, and the transform module processes inventory entries into product variant properties.

Changes

Cohort / File(s)	Summary
API Integration vnda/loaders/productDetailsPage.ts, vnda/utils/client/client.ts	Added include_inventory_place parameter to product fetch endpoint; extended GET /api/v2/products/:id searchParams type to include include_inventory_place: boolean for API type consistency.
Inventory Data Transformation vnda/utils/transform.ts	Imported ProductVariantInventory type; introduced toPropertyValueInventory helper to map inventories to PropertyValue entries; extended toProduct to append inventory properties to product's additionalProperty array using variant inventory data.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Areas of focus:
  • Logic correctness in toPropertyValueInventory helper function and its integration into the property mapping pipeline
  • Consistency of inventory property structure with existing spec/tag property handling
  • Verification that the include_inventory_place parameter properly cascades through loader and type definitions

Poem

🐰 Inventories tucked, in places we track,
Parameters flowing, no data goes slack,
Transform the variants with care and with grace,
Now every burrow knows what's in its place! 🌾

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description contains only the template structure with placeholder text and no actual implementation details, issue link, Loom video, or demonstration link filled in.	Fill in the 'What is this Contribution About?' section with specific details about inventory feature implementation, provide the actual issue link, Loom video link, and demonstration environment link.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Feat(VNDA): Inventory' is concise and directly related to the main change—adding inventory handling to product variants across multiple files.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/inventory-vnda

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

vnda/utils/transform.ts (1)

315-315: Consider removing the type assertion.

The type assertion as ProductVariantInventory[] may be unnecessary since toPropertyValueInventory already accepts an optional parameter and handles undefined values. If variant.inventories might be undefined, the assertion could mask type safety issues.

-const inventories = variant.inventories as ProductVariantInventory[];
+const inventories = variant.inventories;

If the type assertion is required due to type incompatibility, please verify that variant.inventories is always of the correct type at runtime:

#!/bin/bash
# Description: Check the type of variant.inventories in the codebase

# Search for ProductVariant type definition
echo "=== ProductVariant type definition ==="
ast-grep --pattern 'interface ProductVariant {
  $$$
  inventories$$$
  $$$
}'

# Check how variant.inventories is used elsewhere
echo -e "\n=== variant.inventories usage ==="
rg -n 'variant\.inventories' --type=ts -C2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a94f6ad and 8b44f73.

📒 Files selected for processing (3)

• vnda/loaders/productDetailsPage.ts (1 hunks)
• vnda/utils/client/client.ts (1 hunks)
• vnda/utils/transform.ts (4 hunks)

🔇 Additional comments (3)

vnda/utils/transform.ts (3)

19-19: LGTM!

The import of ProductVariantInventory is necessary for the new inventory handling functionality.

---

333-333: LGTM!

The inventory properties are correctly integrated into the additionalProperty array, following the same pattern as specifications and tags.

---

250-261: > Likely an incorrect or invalid review comment.