sfcc-dev-mcp 1.0.19 → 1.0.21

package/src/clients/sfra-client.ts

@@ -1,339 +0,0 @@
-/**
- * SFCC SFRA Documentation Client
- *
- * Provides access to SFRA (Storefront Reference Architecture) documentation including
- * core classes like Server, Request, Response, QueryString, render module, and comprehensive
- * model documentation for account, cart, products, pricing, billing, shipping, and more.
- */
-
-import * as fs from 'fs/promises';
-import { PathResolver } from '../utils/path-resolver.js';
-import {
-  AbstractDocumentationClient,
-  BaseDocument,
-  DocumentSummary,
-  DocumentationClientConfig,
-} from './base/abstract-documentation-client.js';
-import {
-  extractDescriptionFromLines,
-  extractSections,
-  extractProperties,
-  extractMethods,
-  formatDocumentName,
-} from '../utils/markdown-utils.js';
-
-// ==================== Types ====================
-
-export type SFRACategory = 'core' | 'product' | 'order' | 'customer' | 'pricing' | 'store' | 'other';
-export type SFRADocumentType = 'class' | 'module' | 'model';
-
-export interface SFRADocument extends BaseDocument {
-  type: SFRADocumentType;
-  category: SFRACategory;
-  properties?: string[];
-  methods?: string[];
-}
-
-export interface SFRADocumentSummary extends DocumentSummary {
-  type: string;
-  category: string;
-}
-
-// ==================== Configuration ====================
-
-const SFRA_CATEGORY_MAPPINGS: Record<string, SFRACategory> = {
-  // Core SFRA classes and modules
-  'server': 'core',
-  'request': 'core',
-  'response': 'core',
-  'querystring': 'core',
-  'render': 'core',
-
-  // Product-related models
-  'product-full': 'product',
-  'product-bundle': 'product',
-  'product-tile': 'product',
-  'product-search': 'product',
-  'product-line-items': 'product',
-
-  // Pricing models
-  'price-default': 'pricing',
-  'price-range': 'pricing',
-  'price-tiered': 'pricing',
-
-  // Order and cart models
-  'cart': 'order',
-  'order': 'order',
-  'billing': 'order',
-  'shipping': 'order',
-  'payment': 'order',
-  'totals': 'order',
-
-  // Customer models
-  'account': 'customer',
-  'address': 'customer',
-
-  // Store models
-  'store': 'store',
-  'stores': 'store',
-
-  // Other models
-  'categories': 'other',
-  'content': 'other',
-  'locale': 'other',
-};
-
-const SFRA_CATEGORY_DESCRIPTIONS: Record<SFRACategory, { displayName: string; description: string }> = {
-  'core': {
-    displayName: 'Core',
-    description: 'Core SFRA classes and modules (Server, Request, Response, QueryString, render)',
-  },
-  'product': {
-    displayName: 'Product',
-    description: 'Product-related models and functionality',
-  },
-  'order': {
-    displayName: 'Order',
-    description: 'Order, cart, billing, shipping, and payment models',
-  },
-  'customer': {
-    displayName: 'Customer',
-    description: 'Customer account and address models',
-  },
-  'pricing': {
-    displayName: 'Pricing',
-    description: 'Pricing and discount models',
-  },
-  'store': {
-    displayName: 'Store',
-    description: 'Store and location models',
-  },
-  'other': {
-    displayName: 'Other',
-    description: 'Other models and utilities',
-  },
-};
-
-// ==================== Client Implementation ====================
-
-/**
- * Client for accessing SFRA documentation
- * Extends AbstractDocumentationClient for shared functionality
- */
-export class SFRAClient extends AbstractDocumentationClient<SFRADocument, SFRADocumentSummary, SFRACategory> {
-  constructor() {
-    const config: DocumentationClientConfig<SFRACategory> = {
-      clientName: 'SFRAClient',
-      docsPath: PathResolver.getSFRADocsPath(),
-      categoryMappings: SFRA_CATEGORY_MAPPINGS,
-      categoryDescriptions: SFRA_CATEGORY_DESCRIPTIONS,
-      defaultCategory: 'other',
-      cachePrefix: 'sfra',
-    };
-    super(config);
-  }
-
-  // ==================== Public API (preserves existing interface) ====================
-
-  /**
-   * Get a specific SFRA document with full content
-   */
-  async getSFRADocument(documentName: string): Promise<SFRADocument | null> {
-    return this.getDocument(documentName);
-  }
-
-  /**
-   * Enhanced search across all SFRA documentation with better categorization
-   */
-  async searchSFRADocumentation(query: string): Promise<Array<{
-    document: string;
-    title: string;
-    category: string;
-    type: string;
-    relevanceScore: number;
-    matches: Array<{section: string; content: string; lineNumber: number}>;
-  }>> {
-    const cacheKey = `sfra:search:${query.toLowerCase()}`;
-    const cached = this.cache.getSearchResults(cacheKey);
-    if (cached) { return cached; }
-
-    const documents = await this.getAvailableDocuments();
-    const results = [];
-    const queryLower = query.toLowerCase();
-    const queryWords = queryLower.split(/\s+/).filter(word => word.length > 1);
-
-    for (const doc of documents) {
-      const documentContent = await this.getDocument(doc.name);
-      if (!documentContent) { continue; }
-
-      const matches = [];
-      const lines = documentContent.content.split('\n');
-      let currentSection = '';
-      let relevanceScore = 0;
-
-      // Calculate relevance score based on title and description matches
-      if (doc.title.toLowerCase().includes(queryLower)) {
-        relevanceScore += 10;
-      }
-      if (doc.description.toLowerCase().includes(queryLower)) {
-        relevanceScore += 5;
-      }
-
-      // Search through content
-      for (let i = 0; i < lines.length; i++) {
-        const line = lines[i];
-        const lineLower = line.toLowerCase();
-
-        if (line.startsWith('##')) {
-          currentSection = line.replace(/^##\s*/, '').trim();
-        }
-
-        let matchFound = false;
-        let lineRelevance = 0;
-
-        if (lineLower.includes(queryLower)) {
-          matchFound = true;
-          lineRelevance += 3;
-        } else {
-          const wordMatches = queryWords.filter(word => lineLower.includes(word));
-          if (wordMatches.length > 0) {
-            matchFound = true;
-            lineRelevance += wordMatches.length;
-          }
-        }
-
-        if (matchFound) {
-          const contextStart = Math.max(0, i - 2);
-          const contextEnd = Math.min(lines.length, i + 3);
-          const context = lines.slice(contextStart, contextEnd)
-            .map((contextLine, idx) => {
-              const actualLineNumber = contextStart + idx;
-              return actualLineNumber === i ? `>>> ${contextLine}` : contextLine;
-            })
-            .join('\n');
-
-          matches.push({
-            section: currentSection || 'Introduction',
-            content: context,
-            lineNumber: i + 1,
-          });
-
-          relevanceScore += lineRelevance;
-        }
-      }
-
-      if (matches.length > 0) {
-        results.push({
-          document: doc.name,
-          title: doc.title,
-          category: doc.category,
-          type: doc.type,
-          relevanceScore,
-          matches,
-        });
-      }
-    }
-
-    results.sort((a, b) => b.relevanceScore - a.relevanceScore);
-    this.cache.setSearchResults(cacheKey, results);
-    return results;
-  }
-
-  /**
-   * Get documents by category
-   */
-  async getDocumentsByCategory(category: string): Promise<SFRADocumentSummary[]> {
-    return super.getDocumentsByCategory(category);
-  }
-
-  // ==================== Protected overrides ====================
-
-  protected createDocument(baseData: BaseDocument): SFRADocument {
-    return {
-      ...baseData,
-      type: 'model',
-      category: baseData.category as SFRACategory,
-      properties: [],
-      methods: [],
-    };
-  }
-
-  protected toSummary(document: SFRADocument): SFRADocumentSummary {
-    return {
-      name: document.name,
-      title: document.title,
-      description: document.description,
-      type: document.type,
-      category: document.category,
-      filename: document.filename,
-    };
-  }
-
-  protected async parseDocumentFile(filePath: string, filename: string): Promise<SFRADocument | null> {
-    try {
-      const content = await fs.readFile(filePath, 'utf-8');
-      const stats = await fs.stat(filePath);
-
-      const documentName = filename.replace('.md', '');
-      const normalizedName = this.normalizeDocumentName(documentName);
-      const lines = content.split('\n');
-
-      // Extract title
-      const titleLine = lines.find(line => line.startsWith('#'));
-      const title = titleLine?.replace(/^#+\s*/, '').trim() ?? formatDocumentName(normalizedName);
-
-      // Determine type based on title and content
-      const type = this.determineDocumentType(title, content);
-
-      // Get category
-      const category = SFRA_CATEGORY_MAPPINGS[normalizedName] ?? 'other';
-
-      // Extract description
-      const description = extractDescriptionFromLines(lines, title);
-
-      return {
-        name: documentName,
-        title,
-        description,
-        sections: extractSections(content),
-        content,
-        type,
-        category,
-        filename: `${normalizedName}.md`,
-        lastModified: stats.mtime,
-        ...(type === 'class' || type === 'model' ? {
-          properties: extractProperties(lines),
-          methods: extractMethods(lines),
-        } : {}),
-      };
-    } catch (error) {
-      this.logger.error(`Error loading SFRA document ${filename}:`, error);
-      return null;
-    }
-  }
-
-  // ==================== Private helpers ====================
-
-  /**
-   * Determine document type from title and content
-   */
-  private determineDocumentType(title: string, content: string): SFRADocumentType {
-    const titleLower = title.toLowerCase();
-    const contentLower = content.toLowerCase();
-
-    if (titleLower.includes('class ')) {
-      return 'class';
-    }
-
-    if (titleLower.includes('module ')) {
-      return 'module';
-    }
-
-    if (titleLower.includes('model') || contentLower.includes('model') ||
-        contentLower.includes('constructor') || contentLower.includes('properties')) {
-      return 'model';
-    }
-
-    return 'model';
-  }
-}

package/src/config/configuration-factory.ts

@@ -1,201 +0,0 @@
-/**
- * Configuration factory for SFCC MCP Server
- *
- * Centralized configuration management with validation and defaults.
- * This factory creates SFCCConfig objects from various sources while
- * leveraging secure file loading from the config module.
- */
-
-import { existsSync } from 'fs';
-import { resolve } from 'path';
-import { SFCCConfig, DwJsonConfig } from '../types/types.js';
-import { loadSecureDwJson } from './dw-json-loader.js';
-
-export class ConfigurationFactory {
-  /**
-   * Create configuration from various sources with proper validation
-   */
-  static create(options: {
-    dwJsonPath?: string;
-    hostname?: string;
-    username?: string;
-    password?: string;
-    clientId?: string;
-    clientSecret?: string;
-    siteId?: string;
-  }): SFCCConfig {
-    let config: SFCCConfig;
-
-    // Load from dw.json if path provided
-    if (options.dwJsonPath) {
-      const dwConfig = this.loadFromDwJson(options.dwJsonPath);
-      config = this.mapDwJsonToConfig(dwConfig);
-    } else {
-      // Create from provided options
-      config = {
-        hostname: options.hostname ?? '',
-        username: options.username,
-        password: options.password,
-        clientId: options.clientId,
-        clientSecret: options.clientSecret,
-        siteId: options.siteId,
-      };
-    }
-
-    // Override with any provided options (command-line args take precedence)
-    if (options.hostname) {config.hostname = options.hostname;}
-    if (options.username) {config.username = options.username;}
-    if (options.password) {config.password = options.password;}
-    if (options.clientId) {config.clientId = options.clientId;}
-    if (options.clientSecret) {config.clientSecret = options.clientSecret;}
-    if (options.siteId) {config.siteId = options.siteId;}
-
-    this.validate(config);
-    return config;
-  }
-
-  /**
-   * Load configuration from dw.json file using secure file loading
-   *
-   * @param dwJsonPath - Path to the dw.json file
-   * @returns Parsed dw.json configuration
-   * @throws Error if file cannot be loaded or is invalid
-   */
-  private static loadFromDwJson(dwJsonPath: string): DwJsonConfig {
-    const resolvedPath = resolve(dwJsonPath);
-
-    if (!existsSync(resolvedPath)) {
-      throw new Error(`dw.json file not found at: ${resolvedPath}`);
-    }
-
-    // Use the secure loading function from dw-json-loader.ts
-    // This ensures all security validations are applied consistently
-    return loadSecureDwJson(dwJsonPath);
-  }
-
-  /**
-   * Map dw.json structure to SFCCConfig
-   *
-   * Transforms the dw.json format (with kebab-case properties) to the
-   * internal SFCCConfig format (with camelCase properties).
-   *
-   * @param dwConfig - The parsed dw.json configuration
-   * @returns Mapped SFCCConfig object
-   */
-  static mapDwJsonToConfig(dwConfig: DwJsonConfig): SFCCConfig {
-    const config: SFCCConfig = {
-      hostname: dwConfig.hostname,
-      username: dwConfig.username,
-      password: dwConfig.password,
-    };
-
-    // Map OAuth credentials if present
-    if (dwConfig['client-id'] && dwConfig['client-secret']) {
-      config.clientId = dwConfig['client-id'];
-      config.clientSecret = dwConfig['client-secret'];
-    }
-
-    // Map site ID if present
-    if (dwConfig['site-id']) {
-      config.siteId = dwConfig['site-id'];
-    }
-
-    // Map code version if present
-    if (dwConfig['code-version']) {
-      config.codeVersion = dwConfig['code-version'];
-    }
-
-    return config;
-  }
-
-  /**
-   * Validate configuration for different operating modes
-   *
-   * This validation supports both documentation-only mode (no credentials required)
-   * and full mode (credentials required for API access).
-   *
-   * @param config - The configuration to validate
-   * @throws Error if configuration is invalid for any supported mode
-   */
-  private static validate(config: SFCCConfig): void {
-    const hasBasicAuth = config.username && config.password;
-    const hasOAuth = config.clientId && config.clientSecret;
-    const hasHostname = config.hostname && config.hostname.trim() !== '';
-
-    // Allow local mode if no credentials or hostname are provided
-    if (!hasBasicAuth && !hasOAuth && !hasHostname) {
-      // Local mode - only class documentation available
-      return;
-    }
-
-    // If hostname is provided, require credentials
-    if (hasHostname && !hasBasicAuth && !hasOAuth) {
-      throw new Error(
-        'When hostname is provided, either username/password or OAuth credentials (clientId/clientSecret) must be provided',
-      );
-    }
-
-    // Additional hostname validation if provided
-    if (hasHostname) {
-      const trimmedHostname = config.hostname!.trim();
-      if (!trimmedHostname.match(/^[a-zA-Z0-9.-]+(?::[0-9]+)?$/)) {
-        throw new Error('Invalid hostname format in configuration');
-      }
-    }
-  }
-
-  /**
-   * Check if configuration supports specific features
-   *
-   * This method analyzes the provided configuration to determine what
-   * capabilities are available based on the credentials and hostname provided.
-   *
-   * @param config - The configuration to analyze
-   * @returns Object describing available capabilities
-   */
-  static getCapabilities(config: SFCCConfig): {
-    canAccessLogs: boolean;
-    canAccessOCAPI: boolean;
-    canAccessWebDAV: boolean;
-    canGenerateCartridges: boolean;
-    isLocalMode: boolean;
-  } {
-    // WebDAV/Logs can work with either basic auth OR OAuth credentials
-    const hasWebDAVCredentials = !!(config.username && config.password) ||
-      !!(config.clientId && config.clientSecret);
-
-    // OCAPI specifically requires OAuth credentials
-    const hasOAuthCredentials = !!(config.clientId && config.clientSecret);
-
-    // Local mode when no hostname or credentials are provided
-    const hasHostname = !!(config.hostname && config.hostname.trim() !== '');
-    const isLocalMode = !hasHostname && !hasWebDAVCredentials;
-
-    return {
-      canAccessLogs: hasWebDAVCredentials && hasHostname,
-      canAccessOCAPI: hasOAuthCredentials && hasHostname,
-      canAccessWebDAV: hasWebDAVCredentials && hasHostname,
-      canGenerateCartridges: true, // Always available since it's a local file operation
-      isLocalMode,
-    };
-  }
-
-  /**
-   * Create a configuration for local development mode
-   *
-   * This creates a minimal configuration that only provides access to
-  * documentation without requiring any SFCC credentials.
-   *
-   * @returns Configuration for local/documentation-only mode
-   */
-  static createLocalMode(): SFCCConfig {
-    return {
-      hostname: '',
-      username: undefined,
-      password: undefined,
-      clientId: undefined,
-      clientSecret: undefined,
-      siteId: undefined,
-    };
-  }
-}