sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/sfra/stores.md

@@ -1,190 +0,0 @@
-# SFRA Stores Model
-
-## Overview
-
-The Stores model represents a collection of store locations in SFRA applications. It provides store locator functionality, map integration capabilities, and formatted store information for display in store finder interfaces.
-
-## Constructor
-
-```javascript
-function stores(storesResultsObject, searchKey, searchRadius, actionUrl, apiKey)
-```
-
-Creates a Stores model instance with store collection and search parameters.
-
-### Parameters
-
-- `storesResultsObject` (dw.util.Set) - A set of dw.catalog.Store objects  
-- `searchKey` (Object) - What the user searched by (location or postal code)
-- `searchRadius` (number) - The radius used in the search  
-- `actionUrl` (dw.web.URL) - A relative URL for the search action
-- `apiKey` (string) - The Google Maps API key that is set in site preferences
-
-## Properties
-
-### stores
-**Type:** Array<StoreModel>
-
-Array of individual store models, each containing complete store information including location, contact details, and hours.
-
-### searchKey
-**Type:** Object
-
-The search term or location used to find the stores (e.g., ZIP code, address, city).
-
-### radius
-**Type:** number
-
-The search radius in miles/kilometers used to limit store results.
-
-### actionUrl
-**Type:** dw.web.URL
-
-A relative URL for the search action.
-
-### googleMapsApi
-**Type:** string | null
-
-URL for Google Maps API integration, or null if no API key is configured.
-
-### radiusOptions
-**Type:** Array<number>
-
-Array of available radius options: [15, 30, 50, 100, 300].
-
-### storesResultsHtml
-**Type:** string | null
-
-HTML-formatted string of store results for display, or null if no stores found.
-
-### locations
-**Type:** string
-
-JSON stringified array of location objects optimized for map display. Each location contains:
-- `name` (string) - Store name
-- `latitude` (number) - Geographic latitude
-- `longitude` (number) - Geographic longitude  
-- `infoWindowHtml` (string) - Rendered HTML for map info windows
-
-## Helper Functions
-
-### createStoresObject(storesObject)
-Converts a set of store objects into an array of StoreModel instances.
-
-**Parameters:**
-- `storesObject` (dw.util.Set) - Set of dw.catalog.Store objects
-
-**Returns:** Array<StoreModel> - Array of formatted store models
-
-### createGeoLocationObject(storesObject)
-Creates location objects with coordinates and rendered info window HTML for map display.
-
-**Parameters:**
-- `storesObject` (dw.util.Set) - Set of dw.catalog.Store objects
-
-**Returns:** Array<Object> - Array of location objects with map data
-
-### getGoogleMapsApi(apiKey)
-Constructs Google Maps API URL if API key is available.
-
-**Parameters:**
-- `apiKey` (string) - Google Maps API key
-
-**Returns:** string | null - Complete API URL or null if no key
-
-## Usage Example
-
-```javascript
-var stores = require('*/cartridge/models/stores');
-var storeHelpers = require('*/cartridge/scripts/helpers/storeHelpers');
-
-// Search for stores
-var searchResults = storeHelpers.findStores('10001', 25);
-var apiKey = Site.getCurrent().getCustomPreferenceValue('googleMapsApiKey');
-var actionUrl = URLUtils.url('Stores-FindStores');
-
-var storesModel = new stores(
-    searchResults.stores, 
-    '10001',
-    25, 
-    actionUrl,
-    apiKey
-);
-
-// Access store collection
-console.log('Found ' + storesModel.stores.length + ' stores');
-console.log('Search: ' + storesModel.searchKey + ' within ' + storesModel.radius + ' miles');
-
-// Parse JSON locations for map
-var locations = JSON.parse(storesModel.locations);
-
-// Iterate through stores
-storesModel.stores.forEach(function(store) {
-    console.log(store.name + ' - ' + store.city);
-});
-
-// Use for map integration
-if (storesModel.googleMapsApi) {
-    // Load Google Maps with locations
-    var locations = JSON.parse(storesModel.locations);
-    locations.forEach(function(location) {
-        // Add markers to map using latitude/longitude
-        // Use infoWindowHtml for marker popups
-    });
-}
-
-// Display pre-rendered HTML results
-if (storesModel.storesResultsHtml) {
-    // Use the pre-rendered HTML for store display
-}
-```
-
-## Map Integration
-
-The model provides comprehensive mapping support:
-
-### Google Maps Integration
-- **googleMapsApi** - Ready-to-use API URL
-- **locations** - JSON string of coordinates with info windows (needs parsing)
-- **infoWindowHtml** - Pre-rendered HTML for map popups
-
-### Location Data Structure
-Each location object (after JSON parsing) includes:
-- Geographic coordinates for marker placement
-- Store name for marker labels
-- Rendered HTML content for info windows
-
-## Search Context
-
-The model preserves search context:
-- **searchKey** - Original search term for reference
-- **radius** - Search distance for display and refinement
-- **actionUrl** - URL for additional search actions
-- **radiusOptions** - Available radius choices for refinement
-- Enables search result pagination and refinement
-
-## Template Integration
-
-Info windows use the `storeLocator/storeInfoWindow` template:
-- Consistent store information display
-- Customizable popup content
-- Integrated with SFRA template system
-
-## Notes
-
-- Converts SFCC store objects to structured models
-- Provides map-ready coordinate data as JSON string
-- Includes pre-rendered HTML for info windows and store results
-- Supports Google Maps API integration
-- Maintains search context for user reference
-- Includes predefined radius options for search refinement
-- Handles missing API keys gracefully
-- Optimized for store locator interfaces
-- Uses storeHelpers.createStoresResultsHtml for consistent display
-
-## Related Models
-
-- **StoreModel** - Individual store representation
-- **Search Models** - May include store search results
-- **Address Models** - Similar location structure
-- **Product Models** - May include store availability

package/docs/sfra/totals.md

@@ -1,184 +0,0 @@
-# SFRA Totals Model
-
-## Overview
-
-The Totals model represents comprehensive pricing and discount information for a basket or order in SFRA applications. It provides formatted monetary values, discount calculations, and tax information for checkout and order display.
-
-## Constructor
-
-```javascript
-function totals(lineItemContainer)
-```
-
-Creates a Totals model instance with comprehensive pricing information from a line item container.
-
-### Parameters
-
-- `lineItemContainer` (dw.order.LineItemCtnr) - Current user's basket or order
-
-## Properties
-
-### subTotal
-**Type:** string
-
-Formatted subtotal of merchandise before taxes and shipping.
-
-### totalShippingCost
-**Type:** string
-
-Formatted total shipping cost.
-
-### grandTotal
-**Type:** string
-
-Formatted grand total including all items, taxes, shipping, and discounts.
-
-### totalTax
-**Type:** string
-
-Formatted total tax amount.
-
-### discounts
-**Type:** Array<Object>
-
-Array of discount objects including promotions and coupons. Each discount contains:
-
-**For Promotions:**
-- `UUID` (string) - Unique identifier
-- `lineItemText` (string) - Display text for the discount
-- `price` (string) - Formatted discount amount
-- `type` (string) - Always 'promotion'
-- `callOutMsg` (string) - Promotion callout message
-
-**For Coupons:**
-- `UUID` (string) - Unique identifier  
-- `type` (string) - Always 'coupon'
-- `couponCode` (string) - The coupon code
-- `applied` (boolean) - Whether the coupon is applied
-- `valid` (boolean) - Whether the coupon is valid
-- `relationship` (Array) - Array of related price adjustments with callout messages
-
-### discountsHtml
-**Type:** string
-
-HTML-formatted string of all discounts for display purposes.
-
-### orderLevelDiscountTotal
-**Type:** Object
-
-Order-level discount information containing:
-- `value` (number) - Raw discount value
-- `formatted` (string) - Formatted discount amount
-
-### shippingLevelDiscountTotal
-**Type:** Object
-
-Shipping-level discount information containing:
-- `value` (number) - Raw discount value
-- `formatted` (string) - Formatted discount amount
-
-## Helper Functions
-
-### getTotals(total)
-Formats a money total for display, handling unavailable totals.
-
-**Parameters:**
-- `total` (dw.value.Money) - Total price value
-
-**Returns:** string - Formatted money value or '-' if unavailable
-
-### getOrderLevelDiscountTotal(lineItemContainer)
-Calculates order-level discount by comparing totals with and without order discounts.
-
-**Parameters:**
-- `lineItemContainer` (dw.order.LineItemCtnr) - Basket or order container
-
-**Returns:** Object - Order discount value and formatted amount
-
-### getShippingLevelDiscountTotal(lineItemContainer)
-Calculates shipping-level discount by comparing shipping totals.
-
-**Parameters:**
-- `lineItemContainer` (dw.order.LineItemCtnr) - Basket or order container
-
-**Returns:** Object - Shipping discount value and formatted amount
-
-### createDiscountObject(collection, discounts)
-Adds promotion discounts to a discounts object.
-
-**Parameters:**
-- `collection` (dw.util.Collection) - Collection of price adjustments
-- `discounts` (Object) - Existing discounts object
-
-**Returns:** Object - Updated discounts object
-
-### getDiscounts(lineItemContainer)
-Creates a comprehensive array of all discounts including promotions and coupons.
-
-**Parameters:**
-- `lineItemContainer` (dw.order.LineItemCtnr) - Basket or order container
-
-**Returns:** Array<Object> - Array of discount objects
-
-## Usage Example
-
-```javascript
-var totals = require('*/cartridge/models/totals');
-var BasketMgr = require('dw/order/BasketMgr');
-
-var currentBasket = BasketMgr.getCurrentBasket();
-var totalsModel = new totals(currentBasket);
-
-// Access formatted totals
-console.log(totalsModel.subTotal);        // "$149.99"
-console.log(totalsModel.totalShippingCost); // "$9.95"
-console.log(totalsModel.grandTotal);      // "$159.94"
-console.log(totalsModel.totalTax);        // "$12.00"
-
-// Access discount information
-totalsModel.discounts.forEach(function(discount) {
-    if (discount.type === 'promotion') {
-        console.log('Promotion: ' + discount.lineItemText + ' - ' + discount.price);
-    } else if (discount.type === 'coupon') {
-        console.log('Coupon: ' + discount.couponCode + ' (applied: ' + discount.applied + ')');
-    }
-});
-
-// Check for order-level discounts
-if (totalsModel.orderLevelDiscountTotal.value > 0) {
-    console.log('Order discount: ' + totalsModel.orderLevelDiscountTotal.formatted);
-}
-```
-
-## Discount Types
-
-The model handles different types of discounts:
-
-### Promotions
-- Automatic promotional discounts
-- Include callout messages for display
-- Based on business rules and conditions
-
-### Coupons
-- Customer-entered coupon codes
-- Include the coupon code for reference
-- May have usage restrictions
-
-## HTML Formatting
-
-The `discountsHtml` property provides ready-to-use HTML formatting for discount display, using templates to ensure consistent presentation across the application.
-
-## Notes
-
-- All monetary values are properly formatted for display
-- Handles unavailable totals gracefully with fallback formatting
-- Separates order-level and shipping-level discounts
-- Provides both individual discount details and aggregate totals
-- Compatible with both baskets and completed orders
-- Includes comprehensive tax calculation information
-
-## Related Models
-
-- **Cart Model** - Uses totals for cart display
-- **Order Model** - Uses totals for order information
-- **Checkout Models** - Use totals throughout checkout process

package/docs-site-v2/.vitepress/config.mts

@@ -1,190 +0,0 @@
-import { defineConfig } from 'vitepress';
-
-const siteName = 'SFCC Dev MCP';
-const siteDescription = 'MCP server for Salesforce B2C Commerce Cloud development with docs, logs, and tooling';
-const siteUrl = 'https://sfcc-mcp-dev.rhino-inquisitor.com';
-const defaultSocialImagePath = '/explain-product-pricing-methods.png';
-
-const toNonEmptyString = (value: unknown): string | undefined => {
-  if (typeof value !== 'string') {
-    return undefined;
-  }
-
-  const trimmedValue = value.trim();
-  return trimmedValue.length > 0 ? trimmedValue : undefined;
-};
-
-const buildCanonicalUrl = (relativePath: string): string => {
-  const normalizedPath = relativePath
-    .replace(/\\/g, '/')
-    .replace(/(^|\/)index\.md$/, '$1')
-    .replace(/\.md$/, '');
-
-  const withLeadingSlash = normalizedPath.startsWith('/') ? normalizedPath : `/${normalizedPath}`;
-
-  const canonicalPath =
-    withLeadingSlash === '/' || withLeadingSlash === ''
-      ? '/'
-      : withLeadingSlash.endsWith('/')
-        ? withLeadingSlash
-        : `${withLeadingSlash}/`;
-
-  return new URL(canonicalPath, `${siteUrl}/`).toString();
-};
-
-const buildAbsoluteUrl = (value: string): string => {
-  if (/^https?:\/\//i.test(value)) {
-    return value;
-  }
-
-  const withLeadingSlash = value.startsWith('/') ? value : `/${value}`;
-  return new URL(withLeadingSlash, `${siteUrl}/`).toString();
-};
-
-const websiteSchema = JSON.stringify({
-  '@context': 'https://schema.org',
-  '@type': 'WebSite',
-  name: siteName,
-  description: siteDescription,
-  url: siteUrl
-});
-
-const softwareSchema = JSON.stringify({
-  '@context': 'https://schema.org',
-  '@type': 'SoftwareApplication',
-  name: 'SFCC Development MCP Server',
-  applicationCategory: 'DeveloperApplication',
-  operatingSystem: 'macOS, Windows, Linux',
-  description: siteDescription,
-  url: siteUrl,
-  sameAs: ['https://github.com/taurgis/sfcc-dev-mcp', 'https://www.npmjs.com/package/sfcc-dev-mcp']
-});
-
-const guideSidebar = [
-  {
-    text: 'Getting Started',
-    items: [
-      { text: 'Introduction', link: '/guide/' },
-      { text: 'AI Interfaces', link: '/guide/ai-interfaces' },
-      { text: 'Configuration', link: '/guide/configuration' }
-    ]
-  },
-  {
-    text: 'Features',
-    items: [
-      { text: 'Overview', link: '/features/' },
-      { text: 'Tools Catalog', link: '/tools/' },
-      { text: 'Examples', link: '/examples/' },
-      { text: 'Script Debugger', link: '/script-debugger/' },
-      { text: 'Skills', link: '/skills/' },
-      { text: 'Security', link: '/security/' }
-    ]
-  },
-  {
-    text: 'Development',
-    items: [
-      { text: 'Development Guide', link: '/development/' },
-      { text: 'Troubleshooting', link: '/troubleshooting/' }
-    ]
-  }
-];
-
-export default defineConfig({
-  title: siteName,
-  description: siteDescription,
-  base: '/',
-
-  head: [
-    ['meta', { property: 'og:type', content: 'website' }],
-    ['meta', { property: 'og:site_name', content: siteName }],
-    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
-    ['script', { type: 'application/ld+json' }, websiteSchema],
-    ['script', { type: 'application/ld+json' }, softwareSchema]
-  ],
-
-  transformHead: ({ pageData }) => {
-    const relativePath = toNonEmptyString(pageData.relativePath) ?? 'index.md';
-    const canonicalUrl = buildCanonicalUrl(relativePath);
-    const frontmatter = (pageData.frontmatter ?? {}) as Record<string, unknown>;
-    const pageTitle = toNonEmptyString(pageData.frontmatter?.title) ?? toNonEmptyString(pageData.title) ?? siteName;
-    const pageDescription =
-      toNonEmptyString(pageData.frontmatter?.description) ??
-      toNonEmptyString((pageData as { description?: unknown }).description) ??
-      siteDescription;
-    const rawSocialImage =
-      toNonEmptyString(frontmatter.ogImage) ??
-      toNonEmptyString(frontmatter.socialImage) ??
-      toNonEmptyString(frontmatter.image) ??
-      defaultSocialImagePath;
-    const socialImageUrl = buildAbsoluteUrl(rawSocialImage);
-
-    const webPageSchema = JSON.stringify({
-      '@context': 'https://schema.org',
-      '@type': 'WebPage',
-      name: pageTitle,
-      description: pageDescription,
-      url: canonicalUrl,
-      image: socialImageUrl,
-      isPartOf: {
-        '@type': 'WebSite',
-        name: siteName,
-        url: siteUrl
-      }
-    });
-
-    return [
-      ['link', { rel: 'canonical', href: canonicalUrl }],
-      ['meta', { property: 'og:title', content: pageTitle }],
-      ['meta', { property: 'og:description', content: pageDescription }],
-      ['meta', { property: 'og:url', content: canonicalUrl }],
-      ['meta', { property: 'og:image', content: socialImageUrl }],
-      ['meta', { property: 'og:image:alt', content: pageTitle }],
-      ['meta', { name: 'twitter:title', content: pageTitle }],
-      ['meta', { name: 'twitter:description', content: pageDescription }],
-      ['meta', { name: 'twitter:image', content: socialImageUrl }],
-      ['script', { type: 'application/ld+json' }, webPageSchema]
-    ];
-  },
-
-  markdown: {
-    toc: { level: [2, 3] }
-  },
-
-  themeConfig: {
-    logo: {
-      light: '/logo.svg',
-      dark: '/logo-dark.svg'
-    },
-    outline: {
-      level: [2, 3]
-    },
-    nav: [
-      { text: 'Guide', link: '/guide/' },
-      { text: 'Features', link: '/features/' },
-      { text: 'Tools', link: '/tools/' },
-      { text: 'Examples', link: '/examples/' },
-      { text: 'Development', link: '/development/' }
-    ],
-    footer: {
-      message: 'Released under the MIT License.',
-      copyright: `Copyright (c) ${new Date().getFullYear()} Thomas Theunen`
-    },
-    sidebar: {
-      '/guide/': guideSidebar,
-      '/features/': guideSidebar,
-      '/tools/': guideSidebar,
-      '/examples/': guideSidebar,
-      '/script-debugger/': guideSidebar,
-      '/skills/': guideSidebar,
-      '/security/': guideSidebar,
-      '/development/': guideSidebar,
-      '/troubleshooting/': guideSidebar
-    },
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/taurgis/sfcc-dev-mcp' }
-    ],
-    search: {
-      provider: 'local'
-    }
-  }
-});

package/docs-site-v2/.vitepress/theme/components/AssistantTabs.vue

@@ -1,96 +0,0 @@
-<template>
-  <div class="vp-tabs">
-    <div class="vp-tabs__list" role="tablist" aria-label="Assistant selection">
-      <button class="vp-tabs__button" :class="active === 'copilot' ? 'is-active' : ''" role="tab" :aria-selected="active === 'copilot'" @click="active = 'copilot'">GitHub Copilot</button>
-      <button class="vp-tabs__button" :class="active === 'claude' ? 'is-active' : ''" role="tab" :aria-selected="active === 'claude'" @click="active = 'claude'">Claude Desktop</button>
-      <button class="vp-tabs__button" :class="active === 'cursor' ? 'is-active' : ''" role="tab" :aria-selected="active === 'cursor'" @click="active = 'cursor'">Cursor</button>
-    </div>
-
-    <div class="vp-tabs__panel" role="tabpanel">
-      <h3>Configuration</h3>
-      <pre><code class="language-json">{
-  "mcpServers": {
-    "sfcc-dev": {
-      "command": "npx",
-      "args": ["sfcc-dev-mcp", "--dw-json", "/path/to/dw.json", "--debug", "false"]
-    }
-  }
-}</code></pre>
-
-      <div class="vp-grid vp-grid--3">
-        <div class="vp-card" v-for="item in benefits[active]" :key="item.title">
-          <h4>{{ item.title }}</h4>
-          <p>{{ item.text }}</p>
-        </div>
-      </div>
-
-      <div class="vp-links" v-if="links[active]">
-        <a v-for="link in links[active]" :key="link.url" :href="link.url" target="_blank" rel="noopener noreferrer">{{ link.label }}</a>
-      </div>
-
-      <h4>Verification prompts</h4>
-      <ul>
-        <li v-for="prompt in prompts[active]" :key="prompt">{{ prompt }}</li>
-      </ul>
-    </div>
-  </div>
-</template>
-
-<script setup lang="ts">
-import { ref } from 'vue';
-
-type Assistant = 'copilot' | 'claude' | 'cursor';
-
-const active = ref<Assistant>('copilot');
-
-const benefits: Record<Assistant, Array<{ title: string; text: string }>> = {
-  copilot: [
-    { title: 'Inline speed', text: 'Rapid completions and edits in VS Code.' },
-    { title: 'Scaffolding', text: 'Generate controllers, models, and tests.' },
-    { title: 'Everyday flow', text: 'Low-friction iteration for daily work.' }
-  ],
-  claude: [
-    { title: 'Deep reasoning', text: 'Great for architecture and multi-step planning.' },
-    { title: 'Debug sessions', text: 'Explain logs and identify root causes.' },
-    { title: 'Exploration', text: 'Modeling and refactor strategy guidance.' }
-  ],
-  cursor: [
-    { title: 'Rule packs', text: 'Context-aware security and performance rules.' },
-    { title: 'Large changes', text: 'Safely coordinate multi-file refactors.' },
-    { title: 'Consistency', text: 'Standardize patterns across the codebase.' }
-  ]
-};
-
-const prompts: Record<Assistant, string[]> = {
-  copilot: [
-    'Show methods on dw.catalog.Product',
-    'Create SFRA controller for Product-Show',
-    'Search job logs for failed step exceptions',
-    'List custom attributes on Product object'
-  ],
-  claude: [
-    'List available SFCC documentation tools',
-    'Analyze recent error logs then summarize likely root cause',
-    'Generate cartridge structure named demo_cartridge',
-    'Show hook reference entries for SCAPI extension points'
-  ],
-  cursor: [
-    'Suggest performance improvements for this controller',
-    'Apply security patterns to this hook',
-    'Search SFRA docs for middleware guidance',
-    'Summarize latest job execution health'
-  ]
-};
-
-const links: Record<Assistant, Array<{ label: string; url: string }>> = {
-  copilot: [
-    { label: 'Copilot MCP setup', url: 'https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp' }
-  ],
-  claude: [
-    { label: 'Claude MCP setup', url: 'https://support.anthropic.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop' }
-  ],
-  cursor: [
-    { label: 'Cursor MCP setup', url: 'https://docs.cursor.com/advanced/model-context-protocol' }
-  ]
-};
-</script>

package/docs-site-v2/.vitepress/theme/components/Callout.vue

@@ -1,10 +0,0 @@
-<template>
-  <div class="vp-callout" :data-variant="variant">
-    <strong v-if="title">{{ title }}</strong>
-    <slot />
-  </div>
-</template>
-
-<script setup lang="ts">
-defineProps<{ title?: string; variant?: 'info' | 'warn' | 'danger' | 'success' }>();
-</script>

package/docs-site-v2/.vitepress/theme/components/Collapsible.vue

@@ -1,14 +0,0 @@
-<template>
-  <details class="vp-collapsible" :open="open">
-    <summary class="vp-collapsible__summary">
-      <span>{{ title }}</span>
-    </summary>
-    <div class="vp-collapsible__content">
-      <slot />
-    </div>
-  </details>
-</template>
-
-<script setup lang="ts">
-defineProps<{ title: string; open?: boolean }>();
-</script>