sfcc-dev-mcp 1.0.19 → 1.0.20

package/src/clients/isml-client.ts

@@ -1,353 +0,0 @@
-/**
- * SFCC ISML Documentation Client
- *
- * Provides access to ISML (Internet Store Markup Language) element documentation including
- * control flow elements, output formatting, includes, scripting, caching, and special elements.
- */
-
-import * as fs from 'fs/promises';
-import * as path from 'path';
-import { PathResolver } from '../utils/path-resolver.js';
-import {
-  AbstractDocumentationClient,
-  BaseDocument,
-  DocumentSummary,
-  SearchResult,
-  CategoryWithCount,
-  DocumentationClientConfig,
-} from './base/abstract-documentation-client.js';
-import {
-  extractDescriptionFromContent,
-  extractSections,
-} from '../utils/markdown-utils.js';
-
-// ==================== Types ====================
-
-export type ISMLCategory =
-  | 'control-flow'
-  | 'output'
-  | 'includes'
-  | 'scripting'
-  | 'cache'
-  | 'decorators'
-  | 'special'
-  | 'payment'
-  | 'analytics';
-
-export interface ISMLElement extends BaseDocument {
-  category: ISMLCategory;
-  attributes?: string[];
-  requiredAttributes?: string[];
-  optionalAttributes?: string[];
-}
-
-export interface ISMLElementSummary extends DocumentSummary {
-  category: string;
-}
-
-export interface ISMLSearchResult extends SearchResult<ISMLElementSummary> {}
-
-export interface ISMLCategoryInfo extends CategoryWithCount {}
-
-// ==================== Configuration ====================
-
-const ISML_CATEGORY_MAPPINGS: Record<string, ISMLCategory> = {
-  // Control flow elements
-  'isif': 'control-flow',
-  'isloop': 'control-flow',
-  'isbreak': 'control-flow',
-  'iscontinue': 'control-flow',
-  'isnext': 'control-flow',
-  'isselect': 'control-flow',
-
-  // Output elements
-  'isprint': 'output',
-
-  // Include/Component elements
-  'isinclude': 'includes',
-  'iscomponent': 'includes',
-  'iscontent': 'includes',
-  'isslot': 'includes',
-  'ismodule': 'includes',
-
-  // Scripting elements
-  'isscript': 'scripting',
-  'isobject': 'scripting',
-  'isset': 'scripting',
-
-  // Cache elements
-  'iscache': 'cache',
-
-  // Decorator elements
-  'isdecorate': 'decorators',
-
-  // Special elements
-  'isredirect': 'special',
-  'isstatus': 'special',
-  'iscookie': 'special',
-  'iscomment': 'special',
-  'isremove': 'special',
-  'isreplace': 'special',
-
-  // Payment elements
-  'ispayment': 'payment',
-  'ispaymentmessages': 'payment',
-  'isapplepay': 'payment',
-  'isbuynow': 'payment',
-
-  // Analytics elements
-  'isactivedatacontext': 'analytics',
-  'isactivedatahead': 'analytics',
-  'isanalyticsoff': 'analytics',
-};
-
-const ISML_CATEGORY_DESCRIPTIONS: Record<ISMLCategory, { displayName: string; description: string }> = {
-  'control-flow': {
-    displayName: 'Control Flow',
-    description: 'Conditional logic, loops, and flow control elements (isif, isloop, isbreak, etc.)',
-  },
-  'output': {
-    displayName: 'Output',
-    description: 'Elements for formatting and displaying data (isprint)',
-  },
-  'includes': {
-    displayName: 'Includes & Components',
-    description: 'Template inclusion and component rendering (isinclude, iscomponent, isslot, etc.)',
-  },
-  'scripting': {
-    displayName: 'Scripting',
-    description: 'Server-side scripting and variable management (isscript, isset, isobject)',
-  },
-  'cache': {
-    displayName: 'Cache',
-    description: 'Page and template caching control (iscache)',
-  },
-  'decorators': {
-    displayName: 'Decorators',
-    description: 'Template decoration and layout wrapping (isdecorate)',
-  },
-  'special': {
-    displayName: 'Special Elements',
-    description: 'Specialized functionality (isredirect, isstatus, iscookie, iscomment, etc.)',
-  },
-  'payment': {
-    displayName: 'Payment',
-    description: 'Payment-related elements (ispayment, isapplepay, isbuynow)',
-  },
-  'analytics': {
-    displayName: 'Analytics',
-    description: 'Analytics and tracking elements (isactivedatacontext, isactivedatahead)',
-  },
-};
-
-// ==================== Client Implementation ====================
-
-/**
- * Client for accessing ISML element documentation
- * Extends AbstractDocumentationClient for shared functionality
- */
-export class ISMLClient extends AbstractDocumentationClient<ISMLElement, ISMLElementSummary, ISMLCategory> {
-  constructor() {
-    const config: DocumentationClientConfig<ISMLCategory> = {
-      clientName: 'ISMLClient',
-      docsPath: path.join(PathResolver.getDocsPath(), 'isml'),
-      categoryMappings: ISML_CATEGORY_MAPPINGS,
-      categoryDescriptions: ISML_CATEGORY_DESCRIPTIONS,
-      defaultCategory: 'special',
-      cachePrefix: 'isml',
-    };
-    super(config);
-  }
-
-  // ==================== Public API (preserves existing interface) ====================
-
-  /**
-   * Get list of all available ISML elements with summaries
-   */
-  async getAvailableElements(): Promise<ISMLElementSummary[]> {
-    return this.getAvailableDocuments();
-  }
-
-  /**
-   * Get detailed information about a specific ISML element
-   */
-  async getISMLElement(
-    elementName: string,
-    options?: {
-      includeContent?: boolean;
-      includeSections?: boolean;
-      includeAttributes?: boolean;
-    },
-  ): Promise<ISMLElement | null> {
-    const normalizedName = this.normalizeElementName(elementName);
-    const element = await this.getDocument(normalizedName);
-
-    if (!element) {
-      return null;
-    }
-
-    // Apply options to filter returned data
-    return this.applyElementOptions(element, options);
-  }
-
-  /**
-   * Search ISML documentation with relevance scoring
-   */
-  async searchISMLElements(
-    query: string,
-    options?: { category?: string; limit?: number },
-  ): Promise<ISMLSearchResult[]> {
-    return this.searchDocuments(query, options);
-  }
-
-  /**
-   * Get ISML elements filtered by category
-   */
-  async getElementsByCategory(category: string): Promise<ISMLElementSummary[]> {
-    return this.getDocumentsByCategory(category);
-  }
-
-  /**
-   * Get available ISML element categories with counts
-   */
-  async getAvailableCategories(): Promise<ISMLCategoryInfo[]> {
-    return super.getAvailableCategories();
-  }
-
-  // ==================== Protected overrides ====================
-
-  protected createDocument(baseData: BaseDocument): ISMLElement {
-    return {
-      ...baseData,
-      category: baseData.category as ISMLCategory,
-      attributes: [],
-      requiredAttributes: [],
-      optionalAttributes: [],
-    };
-  }
-
-  protected toSummary(element: ISMLElement): ISMLElementSummary {
-    return {
-      name: element.name,
-      title: element.title,
-      description: element.description,
-      category: element.category,
-      filename: element.filename,
-    };
-  }
-
-  protected async parseDocumentFile(filePath: string, filename: string): Promise<ISMLElement | null> {
-    try {
-      const content = await fs.readFile(filePath, 'utf-8');
-      const stats = await fs.stat(filePath);
-
-      const elementName = filename.replace('.md', '');
-      const normalizedName = this.normalizeDocumentName(elementName);
-
-      // Extract title from first heading
-      const titleMatch = content.match(/^#\s+(.+)$/m);
-      const title = titleMatch ? titleMatch[1].trim() : elementName;
-
-      // Extract attributes
-      const attributes = this.extractAttributes(content);
-
-      // Get category
-      const category = ISML_CATEGORY_MAPPINGS[normalizedName] ?? 'special';
-
-      return {
-        name: elementName,
-        title,
-        description: extractDescriptionFromContent(content),
-        sections: extractSections(content),
-        content,
-        category,
-        attributes: attributes.all,
-        requiredAttributes: attributes.required,
-        optionalAttributes: attributes.optional,
-        filename,
-        lastModified: stats.mtime,
-      };
-    } catch (error) {
-      this.logger.error(`Error parsing ISML file ${filename}: ${error}`);
-      return null;
-    }
-  }
-
-  // ==================== Private helpers ====================
-
-  /**
-   * Normalize element name (ensure 'is' prefix)
-   */
-  private normalizeElementName(name: string): string {
-    const lower = name.toLowerCase();
-    return lower.startsWith('is') ? lower : `is${lower}`;
-  }
-
-  /**
-   * Extract attributes from content
-   */
-  private extractAttributes(content: string): {
-    all: string[];
-    required: string[];
-    optional: string[];
-  } {
-    const all: string[] = [];
-    const required: string[] = [];
-    const optional: string[] = [];
-
-    const attrRegex = /###\s+(.+?)\n/g;
-    let match;
-
-    while ((match = attrRegex.exec(content)) !== null) {
-      const attrName = match[1].trim();
-
-      // Skip common headings that aren't attributes
-      const skipPatterns = ['overview', 'syntax', 'example', 'use case'];
-      if (skipPatterns.some(p => attrName.toLowerCase().includes(p))) {
-        continue;
-      }
-
-      all.push(attrName);
-
-      // Check if attribute is required/optional
-      const sectionContent = content.slice(match.index, match.index + 500);
-      if (sectionContent.toLowerCase().includes('required: yes')) {
-        required.push(attrName);
-      } else if (sectionContent.toLowerCase().includes('optional: yes')) {
-        optional.push(attrName);
-      }
-    }
-
-    return { all, required, optional };
-  }
-
-  /**
-   * Apply filtering options to element data
-   */
-  private applyElementOptions(
-    element: ISMLElement,
-    options?: {
-      includeContent?: boolean;
-      includeSections?: boolean;
-      includeAttributes?: boolean;
-    },
-  ): ISMLElement {
-    const filtered = { ...element };
-
-    if (options?.includeContent === false) {
-      filtered.content = '';
-    }
-
-    if (options?.includeSections === false) {
-      filtered.sections = [];
-    }
-
-    if (options?.includeAttributes === false) {
-      filtered.attributes = [];
-      filtered.requiredAttributes = [];
-      filtered.optionalAttributes = [];
-    }
-
-    return filtered;
-  }
-}

package/src/clients/log-client.ts

@@ -1,19 +0,0 @@
-/**
- * SFCC log client - now uses modular structure
- *
- * This file provides backward compatibility by re-exporting the main log client
- * from the new modular structure in the logs/ directory.
- */
-
-export { SFCCLogClient } from './logs/index.js';
-export type { LogLevel, LogFileInfo, LogSummary, WebDAVClientConfig } from './logs/index.js';
-
-// Re-export SFCCConfig for backward compatibility
-export interface SFCCConfig {
-  hostname?: string;
-  username?: string;
-  password?: string;
-  clientId?: string;
-  clientSecret?: string;
-  siteId?: string;
-}

package/src/clients/ocapi/code-versions-client.ts

@@ -1,54 +0,0 @@
-/**
- * OCAPI Code Versions Client
- *
- * This module handles all SFCC code version related operations including
- * retrieving code versions and activating specific versions for deployment management.
- */
-
-import { OCAPIConfig } from '../../types/types.js';
-import { OCAPIAuthClient } from '../base/ocapi-auth-client.js';
-import { Validator } from '../../utils/validator.js';
-import { buildOCAPIBaseUrl } from '../../utils/ocapi-url-builder.js';
-
-/**
- * OCAPI Code Versions Client
- * Handles code version management operations for SFCC instances
- */
-export class OCAPICodeVersionsClient extends OCAPIAuthClient {
-  constructor(config: OCAPIConfig) {
-    super(config);
-    // Override the baseUrl for this specialized client
-    this.baseUrl = buildOCAPIBaseUrl(config);
-  }
-
-  /**
-   * Get all code versions from the SFCC instance
-   *
-   * @returns {Promise<any>} Code version result with data array containing version information
-   */
-  async getCodeVersions(): Promise<any> {
-    return this.get('/code_versions');
-  }
-
-  /**
-   * Activate a specific code version by setting its active flag to true
-   *
-   * @param {string} codeVersionId - The ID of the code version to activate
-   * @returns {Promise<any>} Updated code version object
-   */
-  async activateCodeVersion(codeVersionId: string): Promise<any> {
-    Validator.validateRequired({ codeVersionId }, ['codeVersionId']);
-
-    // Validate code version ID format to prevent URL injection
-    // Code version IDs should be alphanumeric with underscores, dashes, and dots
-    if (!/^[a-zA-Z0-9_.-]+$/.test(codeVersionId)) {
-      throw new Error('Invalid code version ID format. Must contain only alphanumeric characters, underscores, dashes, and dots.');
-    }
-
-    const requestBody = {
-      active: true,
-    };
-
-    return this.patch(`/code_versions/${encodeURIComponent(codeVersionId)}`, requestBody);
-  }
-}

package/src/clients/ocapi/site-preferences-client.ts

@@ -1,106 +0,0 @@
-/**
- * OCAPI Site Preferences Client
- *
- * This module handles all SFCC site preference related operations including
- * searching preferences across different instance types and preference groups.
- */
-
-import { OCAPIConfig } from '../../types/types.js';
-import { OCAPIAuthClient } from '../base/ocapi-auth-client.js';
-import { QueryBuilder } from '../../utils/query-builder.js';
-import { Validator } from '../../utils/validator.js';
-import { buildOCAPIBaseUrl } from '../../utils/ocapi-url-builder.js';
-
-/**
- * Interface for search request structure
- */
-interface SearchRequest {
-  query?: {
-    text_query?: {
-      fields: string[];
-      search_phrase: string;
-    };
-    term_query?: {
-      fields: string[];
-      operator: string;
-      values: any[];
-    };
-    filtered_query?: {
-      filter: any;
-      query: any;
-    };
-    bool_query?: {
-      must?: any[];
-      must_not?: any[];
-      should?: any[];
-    };
-    match_all_query?: {};
-  };
-  sorts?: Array<{
-    field: string;
-    sort_order?: 'asc' | 'desc';
-  }>;
-  start?: number;
-  count?: number;
-  select?: string;
-}
-
-/**
- * Site preferences search options
- */
-interface SitePreferencesOptions {
-  maskPasswords?: boolean;
-  expand?: string;
-}
-
-/**
- * OCAPI Site Preferences Client
- * Specialized client for site preference operations
- */
-export class OCAPISitePreferencesClient extends OCAPIAuthClient {
-  constructor(config: OCAPIConfig) {
-    super(config);
-    // Override the baseUrl for this specialized client
-    this.baseUrl = buildOCAPIBaseUrl(config);
-  }
-
-  /**
-   * Search site preferences across sites in the specified preference group and instance
-   *
-   * Allows searching for preferences by id, display_name, description, and value_type
-   * Supports text queries, term queries, filtered queries, and boolean queries
-   *
-   * Searchable fields:
-   * - id - String
-   * - display_name - Localized String
-   * - description - Localized String
-   * - value_type - one of {
-   *    string, int, double, text, html, date, image, boolean, money, quantity,
-   *    datetime, email, password, set_of_string, set_of_int, set_of_double, enum_of_string, enum_of_int
-   *  }
-   *
-   * Note: value_type can only be joined with other attributes using a conjunction (AND)
-   * Only searchable attributes can be used in sorting
-   */
-  async searchSitePreferences(
-    groupId: string,
-    instanceType: string,
-    searchRequest: SearchRequest,
-    options?: SitePreferencesOptions,
-  ): Promise<any> {
-    Validator.validateRequired({ groupId, instanceType }, ['groupId', 'instanceType']);
-    const validatedInstanceType = Validator.validateInstanceType(instanceType);
-    Validator.validateSearchRequest(searchRequest);
-
-    let endpoint = `/site_preferences/preference_groups/${encodeURIComponent(groupId)}/${validatedInstanceType}/preference_search`;
-
-    if (options) {
-      const queryString = QueryBuilder.fromObject(options);
-      if (queryString) {
-        endpoint += `?${queryString}`;
-      }
-    }
-
-    return this.post(endpoint, searchRequest);
-  }
-}

package/src/clients/ocapi/system-objects-client.ts

@@ -1,148 +0,0 @@
-/**
- * OCAPI System Objects Client
- *
- * This module handles all SFCC system object related operations including
- * object definitions, attribute definitions, and attribute groups.
- */
-
-import { OCAPIConfig } from '../../types/types.js';
-import { OCAPIAuthClient } from '../base/ocapi-auth-client.js';
-import { QueryBuilder } from '../../utils/query-builder.js';
-import { Validator } from '../../utils/validator.js';
-import { buildOCAPIBaseUrl } from '../../utils/ocapi-url-builder.js';
-
-/**
- * Interface for common query parameters
- */
-interface BaseQueryParams {
-  start?: number;
-  count?: number;
-  select?: string;
-}
-
-/**
- * Interface for search request structure
- */
-interface SearchRequest {
-  query?: {
-    text_query?: {
-      fields: string[];
-      search_phrase: string;
-    };
-    term_query?: {
-      fields: string[];
-      operator: string;
-      values: any[];
-    };
-    filtered_query?: {
-      filter: any;
-      query: any;
-    };
-    bool_query?: {
-      must?: any[];
-      must_not?: any[];
-      should?: any[];
-    };
-    match_all_query?: {};
-  };
-  sorts?: Array<{
-    field: string;
-    sort_order?: 'asc' | 'desc';
-  }>;
-  start?: number;
-  count?: number;
-  select?: string;
-}
-
-/**
- * OCAPI System Objects Client
- * Specialized client for system object operations
- */
-export class OCAPISystemObjectsClient extends OCAPIAuthClient {
-  constructor(config: OCAPIConfig) {
-    super(config);
-    // Override the baseUrl for this specialized client
-    this.baseUrl = buildOCAPIBaseUrl(config);
-  }
-
-  /**
-   * Get all system object definitions
-   */
-  async getSystemObjectDefinitions(params?: BaseQueryParams): Promise<any> {
-    let endpoint = '/system_object_definitions';
-
-    if (params) {
-      const queryString = QueryBuilder.fromObject(params);
-      if (queryString) {
-        endpoint += `?${queryString}`;
-      }
-    }
-
-    return this.get(endpoint);
-  }
-
-  /**
-   * Get a specific system object definition by object type
-   */
-  async getSystemObjectDefinition(objectType: string): Promise<any> {
-    Validator.validateRequired({ objectType }, ['objectType']);
-    Validator.validateObjectType(objectType);
-
-    const endpoint = `/system_object_definitions/${encodeURIComponent(objectType)}`;
-    return this.get(endpoint);
-  }
-
-  /**
-   * Search for system object definitions using complex queries
-   */
-  async searchSystemObjectDefinitions(searchRequest: SearchRequest): Promise<any> {
-    Validator.validateSearchRequest(searchRequest);
-
-    const endpoint = '/system_object_definition_search';
-    return this.post(endpoint, searchRequest);
-  }
-
-  /**
-   * Search attribute definitions for a specific system object type
-   */
-  async searchSystemObjectAttributeDefinitions(
-    objectType: string,
-    searchRequest: SearchRequest,
-  ): Promise<any> {
-    Validator.validateRequired({ objectType }, ['objectType']);
-    Validator.validateObjectType(objectType);
-    Validator.validateSearchRequest(searchRequest);
-
-    const endpoint = `/system_object_definitions/${encodeURIComponent(objectType)}/attribute_definition_search`;
-    return this.post(endpoint, searchRequest);
-  }
-
-  /**
-   * Search attribute groups for a specific system object type
-   */
-  async searchSystemObjectAttributeGroups(
-    objectType: string,
-    searchRequest: SearchRequest,
-  ): Promise<any> {
-    Validator.validateRequired({ objectType }, ['objectType']);
-    Validator.validateObjectType(objectType);
-    Validator.validateSearchRequest(searchRequest);
-
-    const endpoint = `/system_object_definitions/${encodeURIComponent(objectType)}/attribute_group_search`;
-    return this.post(endpoint, searchRequest);
-  }
-
-  /**
-   * Search attribute definitions for a specific custom object type
-   */
-  async searchCustomObjectAttributeDefinitions(
-    objectType: string,
-    searchRequest: SearchRequest,
-  ): Promise<any> {
-    Validator.validateRequired({ objectType }, ['objectType']);
-    Validator.validateSearchRequest(searchRequest);
-
-    const endpoint = `/custom_object_definitions/${encodeURIComponent(objectType)}/attribute_definition_search`;
-    return this.post(endpoint, searchRequest);
-  }
-}