@salesforce/b2c-dx-mcp 0.0.1 → 0.3.2

package/content/config.md

@@ -0,0 +1,180 @@
+# Configuration Management
+
+## Overview
+
+All configuration is centralized in `config.server.ts` with environment variable overrides via `.env` files. The configuration system provides type-safe access to app settings with automatic parsing and validation.
+
+## Required Variables
+
+Copy `.env.default` to `.env` and set these required Commerce Cloud credentials:
+
+```bash
+PUBLIC__app__commerce__api__clientId=your-client-id
+PUBLIC__app__commerce__api__organizationId=your-org-id
+PUBLIC__app__commerce__api__siteId=your-site-id
+PUBLIC__app__commerce__api__shortCode=your-short-code
+PUBLIC__app__defaultSiteId=your-site-id
+PUBLIC__app__commerce__sites='[{"id":"your-site-id","defaultLocale":"en-US","defaultCurrency":"USD","supportedLocales":[{"id":"en-US","preferredCurrency":"USD"}],"supportedCurrencies":["USD"]}]'
+```
+
+**Note:** The `commerce.sites` array defines your site configuration including locales, currencies, and supported options. See `.env.default` for a complete example with multiple locales and currencies.
+
+## Adding Configuration
+
+1. **Define type in `src/config/schema.ts`**:
+
+```typescript
+export type Config = {
+  app: {
+    myFeature: {
+      enabled: boolean;
+      maxItems: number;
+    };
+  };
+};
+```
+
+2. **Add defaults in `config.server.ts`**:
+
+```typescript
+export default defineConfig({
+  app: {
+    myFeature: {
+      enabled: false,
+      maxItems: 10,
+    },
+  },
+});
+```
+
+3. **Override via environment variables**:
+
+```bash
+PUBLIC__app__myFeature__enabled=true
+PUBLIC__app__myFeature__maxItems=20
+```
+
+## Usage Patterns
+
+**In React Components**:
+
+```typescript
+import { useConfig } from '@/config';
+
+export function MyComponent() {
+    const config = useConfig();
+
+    if (config.myFeature.enabled) {
+        const maxItems = config.myFeature.maxItems;
+        // Your feature code
+    }
+}
+```
+
+**In Server Loaders/Actions**:
+
+```typescript
+import { getConfig } from '@/config';
+
+export function loader({ context }: LoaderFunctionArgs) {
+    const config = getConfig(context);
+
+    if (config.myFeature.enabled) {
+        // Your loader code
+    }
+}
+```
+
+**In Client Loaders**:
+
+```typescript
+import { getConfig } from '@/config';
+
+export function clientLoader() {
+    const config = getConfig(); // No context needed - uses window.__APP_CONFIG__
+    
+    if (config.myFeature.enabled) {
+        // Your loader code
+    }
+}
+```
+
+**Note:** `getConfig()` and `useConfig()` return `AppConfig` which is the `app` section of the full `Config` type. So you access properties directly (e.g., `config.myFeature.enabled`) without the `app` prefix.
+
+## Environment Variable Rules
+
+Use the `PUBLIC__` prefix with double underscores (`__`) to set any config path:
+
+```bash
+# Environment variable         →  Config path (in Config type)  →  Access via getConfig()/useConfig()
+PUBLIC__app__commerce__sites='[...]' → config.app.commerce.sites → config.commerce.sites
+PUBLIC__app__defaultSiteId=RefArchGlobal → config.app.defaultSiteId → config.defaultSiteId
+PUBLIC__app__myFeature__enabled=true → config.app.myFeature.enabled → config.myFeature.enabled
+```
+
+**Multi-site Configuration Example:**
+
+```bash
+PUBLIC__app__commerce__sites='[
+  {
+    "id": "RefArchGlobal",
+    "defaultLocale": "en-US",
+    "defaultCurrency": "USD",
+    "supportedLocales": [
+      {"id": "en-US", "preferredCurrency": "USD"},
+      {"id": "de-DE", "preferredCurrency": "EUR"}
+    ],
+    "supportedCurrencies": ["USD", "EUR"]
+  }
+]'
+```
+
+**Accessing Site Configuration:**
+
+```typescript
+const config = getConfig(context);
+const currentSite = config.commerce.sites[0]; // Get first site
+const locale = currentSite.defaultLocale;      // "en-US"
+const currency = currentSite.defaultCurrency;  // "USD"
+```
+
+Values are automatically parsed (numbers, booleans, JSON arrays/objects).
+
+Rules:
+1. **`PUBLIC__` prefix**: Exposed to browser (client-safe values)
+2. **No prefix**: Server-only (secrets, never exposed)
+3. **`__` separator**: Navigate nested paths (`PUBLIC__app__commerce__sites`)
+4. **Case-insensitive**: All casings work (normalized to match `config.server.ts`)
+5. **Auto-parsing**: Strings, numbers, booleans, JSON arrays/objects
+6. **Validation**: Paths must exist in `config.server.ts` (prevents typos)
+7. **Depth limit**: Maximum 10 levels deep (use JSON values for deeper nesting)
+8. **Path precedence**: More specific paths override less specific ones
+9. **Protected paths**: `app__engagement` cannot be overridden via environment variables
+10. **MRT limits**: Variable names max 512 characters, total PUBLIC__ values max 32KB
+
+**Note:** Site configuration (locales, currencies) is now managed via `PUBLIC__app__commerce__sites` array instead of individual `PUBLIC__app__site__locale` variables. This enables multi-site support.
+
+**Setting nested objects with JSON:**
+
+```bash
+# Instead of multiple variables:
+PUBLIC__app__myFeature__option1=value1
+PUBLIC__app__myFeature__option2=value2
+
+# Use a single JSON value:
+PUBLIC__app__myFeature='{"option1":"value1","option2":"value2","nested":{"enabled":true}}'
+```
+
+## Security
+
+```bash
+# ✅ Safe for client (PUBLIC__ prefix)
+PUBLIC__app__commerce__api__clientId=abc123
+
+# ✅ Server-only (no prefix)
+COMMERCE_API_SLAS_SECRET=your-secret
+```
+
+Read server-only secrets directly from `process.env` - never add to config.
+
+**Reference:** See src/config/README.md for complete configuration documentation.

package/content/data-fetching.md

@@ -0,0 +1,323 @@
+# Data Fetching Patterns
+
+## Loader Functions
+
+**IMPORTANT**: This project **mandates server-only data loading**. Every UI route must only export a `loader` function.
+
+### Critical Rule: Synchronous Loaders for Streaming
+
+**IMPORTANT**: Loaders should be **synchronous functions that return objects containing promises**, NOT async functions. This enables non-blocking page transitions and streaming SSR.
+
+```typescript
+// ✅ CORRECT - Synchronous loader returning promises
+export function loader({ context }: LoaderFunctionArgs): ProductPageData {
+    const clients = createApiClients(context);
+    return {
+        product: clients.shopperProducts.getProduct({...}),  // Promise - streams
+        reviews: clients.shopperProducts.getReviews({...}),  // Promise - streams
+    };
+}
+
+// ❌ AVOID - Async loader blocks page transitions
+export async function loader({ context }: LoaderFunctionArgs): Promise<ProductPageData> {
+    const product = await clients.shopperProducts.getProduct({...}); // Blocks!
+    return { product };
+}
+```
+
+**Why this matters:**
+- Async loaders with `await` **block the entire page transition** until all data resolves
+- Synchronous loaders returning promises allow React to **stream data progressively**
+- Each promise resolves independently, enabling granular Suspense boundaries
+- Users see content as it becomes available, not all at once
+
+**Behavior**:
+- Initial load: Runs on server (SSR)
+- Navigation: Runs on server (XHR/fetch to server)
+- SCAPI requests always on MRT
+
+## Data Loading Strategies
+
+### Pattern 1: Awaited Data (Blocking)
+
+```typescript
+// ⚠️ BLOCKS rendering until all data is ready
+export async function loader({ params, context }: LoaderFunctionArgs) {
+    const clients = createApiClients(context);
+    return {
+        product: await clients.shopperProducts.getProduct({
+            params: { path: { id: params.productId } }
+        }).then(({ data }) => data)
+    };
+}
+```
+
+**Use when:** Critical data must be available before rendering (SEO, above-the-fold content)
+
+### Pattern 2: Deferred Data (Streaming)
+
+```typescript
+// ✅ RECOMMENDED - Streams data progressively
+export function loader({ params, context }: LoaderFunctionArgs) {
+    const clients = createApiClients(context);
+    return {
+        // Return promises directly - they'll stream to client
+        product: clients.shopperProducts.getProduct({
+            params: { path: { id: params.productId } }
+        }).then(({ data }) => data),
+
+        reviews: clients.shopperProducts.getReviews({
+            params: { path: { id: params.productId } }
+        }).then(({ data }) => data)
+    };
+}
+```
+
+**Use when:** Non-critical data can load after initial render
+
+### Pattern 3: Mixed Strategy
+
+```typescript
+// ✅ BEST OF BOTH - Critical data awaited, rest streamed
+export async function loader({ params, context }: LoaderFunctionArgs) {
+    const clients = createApiClients(context);
+
+    // Await critical data
+    const product = await clients.shopperProducts.getProduct({
+        params: { path: { id: params.productId } }
+    }).then(({ data }) => data);
+
+    return {
+        product, // Resolved
+        reviews: clients.shopperProducts.getReviews({
+            params: { path: { id: params.productId } }
+        }).then(({ data }) => data), // Streamed
+        recommendations: clients.shopperProducts.getRecommendations({
+            params: { path: { id: params.productId } }
+        }).then(({ data }) => data) // Streamed
+    };
+}
+```
+
+## Action Functions
+
+Handle mutations (form submissions, cart updates):
+
+```typescript
+import {data, redirect} from 'react-router';
+
+export async function action({request, context}: ActionFunctionArgs) {
+  const formData = await request.formData();
+  const productId = formData.get('productId') as string;
+
+  const clients = createApiClients(context);
+
+  try {
+    await clients.shopperBasketsV2.addItemToBasket({
+      params: {
+        path: {basketId},
+        body: {productId, quantity: 1},
+      },
+    });
+
+    return data({success: true});
+  } catch (error) {
+    return data({success: false, error: error.message}, {status: 400});
+  }
+}
+```
+
+## Interactive Data Fetching: useScapiFetcher
+
+For on-demand, user-triggered data fetching (after page load), use the `useScapiFetcher` hook instead of loaders.
+
+### `loader` vs `useScapiFetcher`
+
+| Aspect | `loader` | `useScapiFetcher` |
+|--------|----------|-------------------|
+| **When it runs** | Route navigation (page load) | On-demand (user interaction) |
+| **Triggered by** | URL change | Component code (useEffect, button click) |
+| **Data availability** | Before/during component render (streamed) | After component mounts |
+| **Execution context** | Server (MRT) | Triggers server route |
+| **Use case** | Initial page data | Dynamic, interactive fetching |
+
+### How `useScapiFetcher` Works
+
+```text
+Component calls useScapiFetcher()
+        ↓
+Hook builds URL: /resource/api/client/{encoded-params}
+        ↓
+fetcher.load() or fetcher.submit()
+        ↓
+resource.api.client.$resource.ts loader/action runs ON SERVER
+        ↓
+createApiClients(context) makes SCAPI call (server-side)
+        ↓
+JSON response returned to component
+```
+
+**Important:** Even though you call `useScapiFetcher` from the browser, the actual SCAPI requests still happen **on the server** through the resource route, keeping credentials secure.
+
+### Example: Search Suggestions
+
+```typescript
+import { useScapiFetcher } from '@/hooks/use-scapi-fetcher';
+import { useMemo, useCallback } from 'react';
+
+export function useSearchSuggestions({ q, limit, currency }) {
+    // Prepare SCAPI parameters
+    const parameters = useMemo(
+        () => ({
+            params: {
+                query: { q, limit, currency }
+            }
+        }),
+        [q, limit, currency]
+    );
+
+    // Hook automatically routes to server
+    const fetcher = useScapiFetcher(
+        'shopperSearch',           // SCAPI client
+        'getSearchSuggestions',    // Method name
+        parameters                 // Parameters
+    );
+
+    const refetch = useCallback(async () => {
+        await fetcher.load();  // Triggers server request
+    }, [fetcher]);
+
+    return {
+        data: fetcher.data,
+        isLoading: fetcher.state === 'loading',
+        refetch
+    };
+}
+```
+
+### When to Use Each Approach
+
+| Scenario | Use |
+|----------|-----|
+| Load product data when visiting `/product/123` | `loader` |
+| Load checkout data | `loader` |
+| Search suggestions as user types | `useScapiFetcher` |
+| Update customer profile in modal | `useScapiFetcher` |
+| Load recommendations after page loads | `useScapiFetcher` |
+| Fetch bonus products when modal opens | `useScapiFetcher` |
+| Infinite scroll / Load more | `useScapiFetcher` |
+
+### Timeline Comparison
+
+```text
+┌─────────────────────────────────────────────────────────────────┐
+│                     loader (Server)                             │
+├─────────────────────────────────────────────────────────────────┤
+│  User clicks link → Server loader() → Stream data → Page render │
+│                                                                 │
+│  Timeline:  [navigate] → [server fetch] → [stream to client]    │
+│                                                                 │
+│  Data available: Streamed during render via Suspense            │
+└─────────────────────────────────────────────────────────────────┘
+
+┌─────────────────────────────────────────────────────────────────┐
+│                     useScapiFetcher                             │
+├─────────────────────────────────────────────────────────────────┤
+│  Page loads → Component mounts → User types → fetcher.load()    │
+│                                                                 │
+│  Timeline:  [render] → [user action] → [fetch] → [re-render]    │
+│                                                                 │
+│  Data available: AFTER user action, component re-renders        │
+└─────────────────────────────────────────────────────────────────┘
+```
+
+## API Client Usage
+
+Always use `createApiClients(context)`:
+
+```typescript
+import { createApiClients } from '@/lib/api-clients';
+
+export function loader({ context }: LoaderFunctionArgs) {
+    const clients = createApiClients(context);
+
+    // All SCAPI clients with full type safety:
+    clients.shopperProducts.getProduct({...});
+    clients.shopperCustomers.getCustomer({...});
+    clients.shopperBasketsV2.getBasket({...});
+    clients.shopperSearch.productSearch({...});
+    clients.shopperOrders.getOrder({...});
+}
+```
+
+## Parallel vs Sequential
+
+```typescript
+// ✅ GOOD - Parallel requests
+export function loader({ context }: LoaderFunctionArgs) {
+    const clients = createApiClients(context);
+
+    return {
+        product: clients.shopperProducts.getProduct({...}),
+        reviews: clients.shopperProducts.getReviews({...}),
+        recommendations: clients.shopperProducts.getRecommendations({...})
+    };
+    // All three requests start simultaneously
+}
+
+// ❌ BAD - Sequential requests
+export async function loader({ context }: LoaderFunctionArgs) {
+    const clients = createApiClients(context);
+
+    const product = await clients.shopperProducts.getProduct({...});
+    const reviews = await clients.shopperProducts.getReviews({...});
+    const recommendations = await clients.shopperProducts.getRecommendations({...});
+
+    return { product, reviews, recommendations };
+    // Each request waits for the previous to complete
+}
+```
+
+## Understanding Data Flow
+
+### Initial Page Load (SSR)
+
+```text
+Browser → MRT Server
+         ↓
+    loader() runs on server
+         ↓
+    SCAPI requests on MRT
+         ↓
+    HTML response → Browser
+```
+
+**Key characteristics:**
+- The `loader()` runs on the server
+- SCAPI requests happen server-side (direct in production, proxied in dev)
+- Full HTML is returned to browser
+- Client hydrates the HTML
+
+### Subsequent Navigation (SPA)
+
+All routes use server `loader` for both SSR and SPA navigation:
+
+```text
+User clicks link → React Router intercepts
+         ↓
+    Browser makes fetch() to server
+         ↓
+    MRT Server receives request
+         ↓
+    Same loader() runs on server
+         ↓
+    SCAPI requests on MRT
+         ↓
+    JSON response → Browser
+         ↓
+    React updates DOM
+```
+
+**Key Point:** The loader function code is identical for both SSR and SPA navigation. The only difference is the response format (HTML vs JSON). This is why SCAPI credentials stay secure and MRT orchestration works consistently.
+
+**Reference:** See README-DATA.md for complete data fetching documentation.

package/content/extensions.md

@@ -0,0 +1,80 @@
+# Extension Development
+
+## Structure
+
+```
+src/extensions/my-extension/
+├── plugin-config.json    # Plugin configuration
+├── components/           # Extension components
+├── routes/              # Extension routes
+├── locales/             # Extension translations
+└── providers/           # Extension providers
+```
+
+## Plugin Configuration
+
+**Insert component into plugin point**:
+
+```json
+{
+  "components": [
+    {
+      "pluginId": "header.before.cart",
+      "path": "extensions/my-extension/components/badge.tsx",
+      "order": 0
+    }
+  ],
+  "contextProviders": [
+    {
+      "path": "extensions/my-extension/providers/my-provider.tsx",
+      "order": 0
+    }
+  ]
+}
+```
+
+## Extension Routes
+
+Files in `routes/` auto-register:
+
+```typescript
+// src/extensions/my-extension/routes/my-route.tsx
+export function loader() {
+    return { message: 'Hello' };
+}
+
+export default function MyRoute() {
+    const { message } = useLoaderData();
+    return <div>{message}</div>;
+}
+```
+
+## Extension Translations
+
+Auto-namespaced as `extPascalCase`:
+
+```
+src/extensions/my-extension/locales/
+├── en-US/translations.json
+└── it-IT/translations.json
+```
+
+```typescript
+const {t} = useTranslation('extMyExtension');
+t('welcome');
+```
+
+## Integration Markers
+
+```typescript
+// Single line
+/** @sfdc-extension-line SFDC_EXT_MY_FEATURE */
+import myFeature from '@extensions/my-feature';
+
+// Block
+{/* @sfdc-extension-block-start SFDC_EXT_MY_FEATURE */}
+<Link to="/my-feature">My Feature</Link>
+{/* @sfdc-extension-block-end SFDC_EXT_MY_FEATURE */}
+```
+
+For full documentation, read: src/extensions/README.md

package/content/i18n.md

@@ -0,0 +1,121 @@
+# Internationalization (i18n)
+
+## Overview
+
+- **Server instance**: Has access to all translations for all languages
+- **Client instance**: Dynamically imports translations as JavaScript chunks
+- **Dual API**: `useTranslation()` for components, `getTranslation()` for everything else
+
+## Adding Translations
+
+**In `src/locales/{language}/translations.json`**:
+
+```json
+{
+  "product": {
+    "title": "Product Details",
+    "addToCart": "Add to Cart",
+    "greeting": "Hello, {{name}}!",
+    "itemCount": {
+      "zero": "No items",
+      "one": "{{count}} item",
+      "other": "{{count}} items"
+    }
+  }
+}
+```
+
+## Usage
+
+**2. Use in React components:**
+
+```typescript
+import { useTranslation } from 'react-i18next';
+
+export function ProductCard() {
+    const { t } = useTranslation('product');
+
+    return (
+        <div>
+            <h1>{t('title')}</h1>
+            <button>{t('addToCart')}</button>
+            <p>{t('greeting', { name: 'John' })}</p>
+            <p>{t('itemCount', { count: 5 })}</p>
+        </div>
+    );
+}
+```
+
+**3. Use in non-component code:**
+
+```typescript
+import { getTranslation } from '@/lib/i18next';
+
+// Client-side or utilities
+const { t } = getTranslation();
+const message = t('product:addToCart');
+
+// Server-side (loaders/actions)
+export function loader(args: LoaderFunctionArgs) {
+    const { t } = getTranslation(args.context);
+    return { title: t('product:title') };
+}
+```
+
+## Validation Schemas with Translations
+
+**CRITICAL**: Use factory pattern for Zod schemas to avoid race conditions:
+
+```typescript
+// ❌ WRONG - Module-level schema (race condition)
+export const schema = z.object({
+    email: z.string().email(t('validation:emailInvalid'))
+});
+
+// ✅ CORRECT - Factory function
+import type { TFunction } from 'i18next';
+
+export const createSchema = (t: TFunction) => {
+    return z.object({
+        email: z.string().email(t('validation:emailInvalid'))
+    });
+};
+
+// Usage in component
+import { useMemo } from 'react';
+import { useTranslation } from 'react-i18next';
+
+function MyForm() {
+    const { t } = useTranslation();
+    const schema = useMemo(() => createSchema(t), [t]);
+
+    const form = useForm({ resolver: zodResolver(schema) });
+}
+```
+
+## Language Switching
+
+```typescript
+import LocaleSwitcher from '@/components/locale-switcher';
+
+export function Footer() {
+    return <footer><LocaleSwitcher /></footer>;
+}
+```
+
+## Extension Translations
+
+Extensions use `extPascalCase` namespace:
+
+```
+src/extensions/my-extension/locales/
+├── en-US/translations.json
+└── it-IT/translations.json
+```
+
+```typescript
+const {t} = useTranslation('extMyExtension');
+t('welcome');
+```
+
+**Reference:** See README-I18N.md for complete internationalization documentation.