sfcc-dev-mcp 1.0.15 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/ISSUE_TEMPLATE/bug_report.yml +3 -1
- package/.github/ISSUE_TEMPLATE/documentation.yml +2 -2
- package/.github/ISSUE_TEMPLATE/question.yml +1 -1
- package/.github/PULL_REQUEST_TEMPLATE/documentation.md +1 -1
- package/.github/PULL_REQUEST_TEMPLATE/new_tool.md +1 -1
- package/.github/agents/official-docs-researcher.agent.md +56 -0
- package/.github/instructions/mcp-node-tests.instructions.md +12 -916
- package/.github/instructions/mcp-yml-tests.instructions.md +14 -742
- package/.github/pull_request_template.md +1 -1
- package/.github/skills/agent-authoring/SKILL.md +66 -0
- package/.github/skills/mcp-log-debugging/SKILL.md +69 -0
- package/.github/skills/mcp-programmatic-testing/SKILL.md +142 -0
- package/.github/skills/mcp-yaml-testing/SKILL.md +136 -0
- package/.github/skills/salesforce-developer-site-scraper/SKILL.md +102 -0
- package/.github/skills/salesforce-developer-site-scraper/scripts/scrape-to-markdown.js +205 -0
- package/.github/skills/salesforce-help-site-scraper/SKILL.md +84 -0
- package/.github/skills/salesforce-help-site-scraper/scripts/scrape-help-to-markdown.js +212 -0
- package/.github/skills/skill-authoring/SKILL.md +228 -0
- package/.github/skills/skill-authoring/references/PATTERNS.md +384 -0
- package/.github/workflows/ci.yml +3 -3
- package/.github/workflows/deploy-pages.yml +9 -19
- package/.github/workflows/publish.yml +5 -2
- package/.github/workflows/update-docs.yml +1 -1
- package/AGENTS.md +140 -286
- package/CONTRIBUTING.md +10 -22
- package/README.md +48 -16
- package/ai-instructions/{github-copilot/copilot-instructions.md → AGENTS.md} +99 -127
- package/ai-instructions/skills/sfcc-caching/SKILL.md +89 -0
- package/{dist/docs/best-practices/cartridge_creation.md → ai-instructions/skills/sfcc-cartridge-development/SKILL.md} +31 -7
- package/ai-instructions/skills/sfcc-forms-development/SKILL.md +261 -0
- package/ai-instructions/skills/sfcc-forms-development/references/ARCHITECTURE-SGJC-SFRA.md +143 -0
- package/ai-instructions/skills/sfcc-forms-development/references/FORM-XML-CHEATSHEET.md +127 -0
- package/ai-instructions/skills/sfcc-fraud-prevention/SKILL.md +95 -0
- package/ai-instructions/skills/sfcc-hooks-registration/SKILL.md +39 -0
- package/ai-instructions/skills/sfcc-isml-development/SKILL.md +370 -0
- package/ai-instructions/skills/sfcc-isml-development/references/REMOTE-INCLUDES.md +116 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-LAYOUTS.md +50 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CART-ACCOUNT-AUTH.md +45 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CATALOG.md +85 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-STRUCTURE-COMPONENTS.md +63 -0
- package/ai-instructions/skills/sfcc-isml-development/references/UTILITIES-EXPRESSIONS.md +159 -0
- package/ai-instructions/skills/sfcc-isml-development/references/sfra-base-templates-architecture.md +13 -0
- package/ai-instructions/skills/sfcc-job-development/SKILL.md +334 -0
- package/ai-instructions/skills/sfcc-job-development/references/CHUNK-ORIENTED.md +393 -0
- package/ai-instructions/skills/sfcc-job-development/references/STEPTYPES-JSON.md +271 -0
- package/ai-instructions/skills/sfcc-job-development/references/TASK-ORIENTED.md +257 -0
- package/ai-instructions/skills/sfcc-localization/SKILL.md +92 -0
- package/ai-instructions/skills/sfcc-localization/references/CONTROLLERS.md +63 -0
- package/ai-instructions/skills/sfcc-localization/references/FORMATTING.md +29 -0
- package/ai-instructions/skills/sfcc-localization/references/FORMS-LOCALIZATION.md +33 -0
- package/ai-instructions/skills/sfcc-localization/references/JAVASCRIPT-LOCALIZATION.md +41 -0
- package/ai-instructions/skills/sfcc-localization/references/LOCALE-SWITCHING.md +35 -0
- package/ai-instructions/skills/sfcc-localization/references/PATTERNS.md +740 -0
- package/ai-instructions/skills/sfcc-localization/references/PROPERTIES-ENCODING.md +25 -0
- package/ai-instructions/skills/sfcc-localization/references/RESOURCE-BUNDLES.md +67 -0
- package/ai-instructions/skills/sfcc-localization/references/STATIC-FILES.md +23 -0
- package/ai-instructions/skills/sfcc-localization/references/TESTING.md +21 -0
- package/{docs/best-practices/localserviceregistry.md → ai-instructions/skills/sfcc-localserviceregistry/SKILL.md} +65 -31
- package/ai-instructions/skills/sfcc-logging/SKILL.md +352 -0
- package/ai-instructions/skills/sfcc-logging/references/LOG-FILES.md +282 -0
- package/{docs/best-practices/ocapi_hooks.md → ai-instructions/skills/sfcc-ocapi-hooks/SKILL.md} +51 -16
- package/ai-instructions/skills/sfcc-ocapi-scapi-slas/SKILL.md +108 -0
- package/ai-instructions/skills/sfcc-page-designer/SKILL.md +353 -0
- package/ai-instructions/skills/sfcc-page-designer/references/ATTRIBUTE-TYPES.md +436 -0
- package/ai-instructions/skills/sfcc-page-designer/references/META-DEFINITIONS.md +322 -0
- package/{dist/docs/best-practices/performance.md → ai-instructions/skills/sfcc-performance/SKILL.md} +35 -3
- package/ai-instructions/skills/sfcc-platform-limits/SKILL.md +89 -0
- package/ai-instructions/skills/sfcc-scapi-custom-endpoints/SKILL.md +237 -0
- package/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/AUTHENTICATION.md +214 -0
- package/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/URL-MAPPING.md +253 -0
- package/{docs/best-practices/scapi_hooks.md → ai-instructions/skills/sfcc-scapi-hooks/SKILL.md} +44 -17
- package/ai-instructions/skills/sfcc-script-evaluation/SKILL.md +380 -0
- package/{docs/best-practices/security.md → ai-instructions/skills/sfcc-security/SKILL.md} +12 -3
- package/ai-instructions/skills/sfcc-sfra-client-side-js/SKILL.md +270 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/AJAX-CSRF-VALIDATION.md +285 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/BASE-MODULE-INDEX.md +206 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/EXTENSION-PATTERNS.md +165 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/PLUGIN-PATTERNS.md +185 -0
- package/ai-instructions/skills/sfcc-sfra-controllers/SKILL.md +347 -0
- package/ai-instructions/skills/sfcc-sfra-controllers/references/MIDDLEWARE-REFERENCE.md +257 -0
- package/ai-instructions/skills/sfcc-sfra-controllers/references/REMOTE-INCLUDES.md +193 -0
- package/{dist/docs/best-practices/sfra_controllers.md → ai-instructions/skills/sfcc-sfra-controllers/references/standard-sfra-controllers.md} +0 -670
- package/ai-instructions/skills/sfcc-sfra-models/SKILL.md +322 -0
- package/ai-instructions/skills/sfcc-sfra-models/references/MODEL-PATTERNS.md +530 -0
- package/ai-instructions/skills/sfcc-sfra-models/references/MODEL-STRUCTURE.md +234 -0
- package/ai-instructions/skills/sfcc-sfra-models/references/TESTING-SECURITY.md +417 -0
- package/{dist/docs/best-practices/sfra_scss.md → ai-instructions/skills/sfcc-sfra-scss/SKILL.md} +5 -0
- package/ai-instructions/skills/sfcc-webdav-workflows/SKILL.md +111 -0
- package/dist/ai-instructions/AGENTS.md +628 -0
- package/dist/ai-instructions/skills/sfcc-caching/SKILL.md +89 -0
- package/{docs/best-practices/cartridge_creation.md → dist/ai-instructions/skills/sfcc-cartridge-development/SKILL.md} +31 -7
- package/dist/ai-instructions/skills/sfcc-forms-development/SKILL.md +261 -0
- package/dist/ai-instructions/skills/sfcc-forms-development/references/ARCHITECTURE-SGJC-SFRA.md +143 -0
- package/dist/ai-instructions/skills/sfcc-forms-development/references/FORM-XML-CHEATSHEET.md +127 -0
- package/dist/ai-instructions/skills/sfcc-fraud-prevention/SKILL.md +95 -0
- package/dist/ai-instructions/skills/sfcc-hooks-registration/SKILL.md +39 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/SKILL.md +370 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/REMOTE-INCLUDES.md +116 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-LAYOUTS.md +50 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CART-ACCOUNT-AUTH.md +45 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CATALOG.md +85 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-STRUCTURE-COMPONENTS.md +63 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/UTILITIES-EXPRESSIONS.md +159 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/sfra-base-templates-architecture.md +13 -0
- package/dist/ai-instructions/skills/sfcc-job-development/SKILL.md +334 -0
- package/dist/ai-instructions/skills/sfcc-job-development/references/CHUNK-ORIENTED.md +393 -0
- package/dist/ai-instructions/skills/sfcc-job-development/references/STEPTYPES-JSON.md +271 -0
- package/dist/ai-instructions/skills/sfcc-job-development/references/TASK-ORIENTED.md +257 -0
- package/dist/ai-instructions/skills/sfcc-localization/SKILL.md +92 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/CONTROLLERS.md +63 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/FORMATTING.md +29 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/FORMS-LOCALIZATION.md +33 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/JAVASCRIPT-LOCALIZATION.md +41 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/LOCALE-SWITCHING.md +35 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/PATTERNS.md +740 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/PROPERTIES-ENCODING.md +25 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/RESOURCE-BUNDLES.md +67 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/STATIC-FILES.md +23 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/TESTING.md +21 -0
- package/dist/{docs/best-practices/localserviceregistry.md → ai-instructions/skills/sfcc-localserviceregistry/SKILL.md} +65 -31
- package/dist/ai-instructions/skills/sfcc-logging/SKILL.md +352 -0
- package/dist/ai-instructions/skills/sfcc-logging/references/LOG-FILES.md +282 -0
- package/dist/{docs/best-practices/ocapi_hooks.md → ai-instructions/skills/sfcc-ocapi-hooks/SKILL.md} +51 -16
- package/dist/ai-instructions/skills/sfcc-ocapi-scapi-slas/SKILL.md +108 -0
- package/dist/ai-instructions/skills/sfcc-page-designer/SKILL.md +353 -0
- package/dist/ai-instructions/skills/sfcc-page-designer/references/ATTRIBUTE-TYPES.md +436 -0
- package/dist/ai-instructions/skills/sfcc-page-designer/references/META-DEFINITIONS.md +322 -0
- package/{docs/best-practices/performance.md → dist/ai-instructions/skills/sfcc-performance/SKILL.md} +35 -3
- package/dist/ai-instructions/skills/sfcc-platform-limits/SKILL.md +89 -0
- package/dist/ai-instructions/skills/sfcc-scapi-custom-endpoints/SKILL.md +237 -0
- package/dist/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/AUTHENTICATION.md +214 -0
- package/dist/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/URL-MAPPING.md +253 -0
- package/dist/{docs/best-practices/scapi_hooks.md → ai-instructions/skills/sfcc-scapi-hooks/SKILL.md} +44 -17
- package/dist/ai-instructions/skills/sfcc-script-evaluation/SKILL.md +380 -0
- package/dist/{docs/best-practices/security.md → ai-instructions/skills/sfcc-security/SKILL.md} +12 -3
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/SKILL.md +270 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/AJAX-CSRF-VALIDATION.md +285 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/BASE-MODULE-INDEX.md +206 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/EXTENSION-PATTERNS.md +165 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/PLUGIN-PATTERNS.md +185 -0
- package/dist/ai-instructions/skills/sfcc-sfra-controllers/SKILL.md +347 -0
- package/dist/ai-instructions/skills/sfcc-sfra-controllers/references/MIDDLEWARE-REFERENCE.md +257 -0
- package/dist/ai-instructions/skills/sfcc-sfra-controllers/references/REMOTE-INCLUDES.md +193 -0
- package/{docs/best-practices/sfra_controllers.md → dist/ai-instructions/skills/sfcc-sfra-controllers/references/standard-sfra-controllers.md} +0 -670
- package/dist/ai-instructions/skills/sfcc-sfra-models/SKILL.md +322 -0
- package/dist/ai-instructions/skills/sfcc-sfra-models/references/MODEL-PATTERNS.md +530 -0
- package/dist/ai-instructions/skills/sfcc-sfra-models/references/MODEL-STRUCTURE.md +234 -0
- package/dist/ai-instructions/skills/sfcc-sfra-models/references/TESTING-SECURITY.md +417 -0
- package/{docs/best-practices/sfra_scss.md → dist/ai-instructions/skills/sfcc-sfra-scss/SKILL.md} +5 -0
- package/dist/ai-instructions/skills/sfcc-webdav-workflows/SKILL.md +111 -0
- package/dist/clients/agent-instructions-client.d.ts +66 -0
- package/dist/clients/agent-instructions-client.d.ts.map +1 -0
- package/dist/clients/agent-instructions-client.js +277 -0
- package/dist/clients/agent-instructions-client.js.map +1 -0
- package/dist/clients/base/abstract-documentation-client.d.ts +146 -0
- package/dist/clients/base/abstract-documentation-client.d.ts.map +1 -0
- package/dist/clients/base/abstract-documentation-client.js +265 -0
- package/dist/clients/base/abstract-documentation-client.js.map +1 -0
- package/dist/clients/base/oauth-token.d.ts +18 -0
- package/dist/clients/base/oauth-token.d.ts.map +1 -1
- package/dist/clients/base/oauth-token.js +45 -2
- package/dist/clients/base/oauth-token.js.map +1 -1
- package/dist/clients/cartridge/cartridge-generation-client.d.ts +59 -0
- package/dist/clients/cartridge/cartridge-generation-client.d.ts.map +1 -0
- package/dist/clients/cartridge/cartridge-generation-client.js +224 -0
- package/dist/clients/cartridge/cartridge-generation-client.js.map +1 -0
- package/dist/clients/cartridge/cartridge-structure.d.ts +17 -0
- package/dist/clients/cartridge/cartridge-structure.d.ts.map +1 -0
- package/dist/clients/cartridge/cartridge-structure.js +33 -0
- package/dist/clients/cartridge/cartridge-structure.js.map +1 -0
- package/dist/clients/cartridge/cartridge-templates.d.ts +22 -0
- package/dist/clients/cartridge/cartridge-templates.d.ts.map +1 -0
- package/dist/clients/cartridge/cartridge-templates.js +225 -0
- package/dist/clients/cartridge/cartridge-templates.js.map +1 -0
- package/dist/clients/cartridge/index.d.ts +7 -0
- package/dist/clients/cartridge/index.d.ts.map +1 -0
- package/dist/clients/cartridge/index.js +7 -0
- package/dist/clients/cartridge/index.js.map +1 -0
- package/dist/clients/docs/documentation-scanner.d.ts +5 -2
- package/dist/clients/docs/documentation-scanner.d.ts.map +1 -1
- package/dist/clients/docs/documentation-scanner.js +38 -23
- package/dist/clients/docs/documentation-scanner.js.map +1 -1
- package/dist/clients/docs-client.d.ts +13 -4
- package/dist/clients/docs-client.d.ts.map +1 -1
- package/dist/clients/docs-client.js +44 -11
- package/dist/clients/docs-client.js.map +1 -1
- package/dist/clients/isml-client.d.ts +71 -0
- package/dist/clients/isml-client.d.ts.map +1 -0
- package/dist/clients/isml-client.js +252 -0
- package/dist/clients/isml-client.js.map +1 -0
- package/dist/clients/ocapi/code-versions-client.d.ts.map +1 -1
- package/dist/clients/ocapi/code-versions-client.js +6 -1
- package/dist/clients/ocapi/code-versions-client.js.map +1 -1
- package/dist/clients/ocapi-client.d.ts +9 -101
- package/dist/clients/ocapi-client.d.ts.map +1 -1
- package/dist/clients/ocapi-client.js +11 -93
- package/dist/clients/ocapi-client.js.map +1 -1
- package/dist/clients/script-debugger/index.d.ts +5 -0
- package/dist/clients/script-debugger/index.d.ts.map +1 -0
- package/dist/clients/script-debugger/index.js +5 -0
- package/dist/clients/script-debugger/index.js.map +1 -0
- package/dist/clients/script-debugger/script-debugger-client.d.ts +147 -0
- package/dist/clients/script-debugger/script-debugger-client.d.ts.map +1 -0
- package/dist/clients/script-debugger/script-debugger-client.js +591 -0
- package/dist/clients/script-debugger/script-debugger-client.js.map +1 -0
- package/dist/clients/sfra-client.d.ts +13 -62
- package/dist/clients/sfra-client.d.ts.map +1 -1
- package/dist/clients/sfra-client.js +105 -326
- package/dist/clients/sfra-client.js.map +1 -1
- package/dist/config/configuration-factory.d.ts +1 -1
- package/dist/config/configuration-factory.d.ts.map +1 -1
- package/dist/config/configuration-factory.js +5 -1
- package/dist/config/configuration-factory.js.map +1 -1
- package/dist/config/dw-json-loader.d.ts +7 -0
- package/dist/config/dw-json-loader.d.ts.map +1 -1
- package/dist/config/dw-json-loader.js +92 -15
- package/dist/config/dw-json-loader.js.map +1 -1
- package/dist/config/workspace-roots.d.ts +143 -0
- package/dist/config/workspace-roots.d.ts.map +1 -0
- package/dist/config/workspace-roots.js +448 -0
- package/dist/config/workspace-roots.js.map +1 -0
- package/dist/constants/index.d.ts +1 -0
- package/dist/constants/index.d.ts.map +1 -0
- package/dist/constants/index.js +3 -0
- package/dist/constants/index.js.map +1 -0
- package/dist/core/handlers/abstract-client-handler.d.ts +52 -0
- package/dist/core/handlers/abstract-client-handler.d.ts.map +1 -0
- package/dist/core/handlers/abstract-client-handler.js +51 -0
- package/dist/core/handlers/abstract-client-handler.js.map +1 -0
- package/dist/core/handlers/agent-instructions-handler.d.ts +17 -0
- package/dist/core/handlers/agent-instructions-handler.d.ts.map +1 -0
- package/dist/core/handlers/agent-instructions-handler.js +38 -0
- package/dist/core/handlers/agent-instructions-handler.js.map +1 -0
- package/dist/core/handlers/base-handler.d.ts +3 -68
- package/dist/core/handlers/base-handler.d.ts.map +1 -1
- package/dist/core/handlers/base-handler.js +11 -84
- package/dist/core/handlers/base-handler.js.map +1 -1
- package/dist/core/handlers/cartridge-handler.d.ts +10 -11
- package/dist/core/handlers/cartridge-handler.d.ts.map +1 -1
- package/dist/core/handlers/cartridge-handler.js +10 -28
- package/dist/core/handlers/cartridge-handler.js.map +1 -1
- package/dist/core/handlers/client-factory.d.ts +12 -2
- package/dist/core/handlers/client-factory.d.ts.map +1 -1
- package/dist/core/handlers/client-factory.js +28 -1
- package/dist/core/handlers/client-factory.js.map +1 -1
- package/dist/core/handlers/code-version-handler.d.ts +11 -11
- package/dist/core/handlers/code-version-handler.d.ts.map +1 -1
- package/dist/core/handlers/code-version-handler.js +13 -27
- package/dist/core/handlers/code-version-handler.js.map +1 -1
- package/dist/core/handlers/docs-handler.d.ts +6 -12
- package/dist/core/handlers/docs-handler.d.ts.map +1 -1
- package/dist/core/handlers/docs-handler.js +11 -36
- package/dist/core/handlers/docs-handler.js.map +1 -1
- package/dist/core/handlers/isml-handler.d.ts +11 -0
- package/dist/core/handlers/isml-handler.d.ts.map +1 -0
- package/dist/core/handlers/isml-handler.js +18 -0
- package/dist/core/handlers/isml-handler.js.map +1 -0
- package/dist/core/handlers/job-log-handler.d.ts +8 -7
- package/dist/core/handlers/job-log-handler.d.ts.map +1 -1
- package/dist/core/handlers/job-log-handler.js +14 -5
- package/dist/core/handlers/job-log-handler.js.map +1 -1
- package/dist/core/handlers/log-handler.d.ts +8 -7
- package/dist/core/handlers/log-handler.d.ts.map +1 -1
- package/dist/core/handlers/log-handler.js +14 -5
- package/dist/core/handlers/log-handler.js.map +1 -1
- package/dist/core/handlers/script-debugger-handler.d.ts +18 -0
- package/dist/core/handlers/script-debugger-handler.d.ts.map +1 -0
- package/dist/core/handlers/script-debugger-handler.js +31 -0
- package/dist/core/handlers/script-debugger-handler.js.map +1 -0
- package/dist/core/handlers/sfra-handler.d.ts +6 -12
- package/dist/core/handlers/sfra-handler.d.ts.map +1 -1
- package/dist/core/handlers/sfra-handler.js +11 -36
- package/dist/core/handlers/sfra-handler.js.map +1 -1
- package/dist/core/handlers/simple-client-handler.d.ts +41 -0
- package/dist/core/handlers/simple-client-handler.d.ts.map +1 -0
- package/dist/core/handlers/simple-client-handler.js +49 -0
- package/dist/core/handlers/simple-client-handler.js.map +1 -0
- package/dist/core/handlers/system-object-handler.d.ts +11 -11
- package/dist/core/handlers/system-object-handler.d.ts.map +1 -1
- package/dist/core/handlers/system-object-handler.js +13 -27
- package/dist/core/handlers/system-object-handler.js.map +1 -1
- package/dist/core/handlers/validation-helpers.d.ts +22 -24
- package/dist/core/handlers/validation-helpers.d.ts.map +1 -1
- package/dist/core/handlers/validation-helpers.js +89 -39
- package/dist/core/handlers/validation-helpers.js.map +1 -1
- package/dist/core/instruction-advisor.d.ts +28 -0
- package/dist/core/instruction-advisor.d.ts.map +1 -0
- package/dist/core/instruction-advisor.js +114 -0
- package/dist/core/instruction-advisor.js.map +1 -0
- package/dist/core/server.d.ts +25 -0
- package/dist/core/server.d.ts.map +1 -1
- package/dist/core/server.js +151 -11
- package/dist/core/server.js.map +1 -1
- package/dist/core/tool-definitions.d.ts +6 -854
- package/dist/core/tool-definitions.d.ts.map +1 -1
- package/dist/core/tool-definitions.js +8 -1064
- package/dist/core/tool-definitions.js.map +1 -1
- package/dist/core/tool-schemas/agent-instruction-tools.d.ts +77 -0
- package/dist/core/tool-schemas/agent-instruction-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/agent-instruction-tools.js +72 -0
- package/dist/core/tool-schemas/agent-instruction-tools.js.map +1 -0
- package/dist/core/tool-schemas/cartridge-tools.d.ts +27 -0
- package/dist/core/tool-schemas/cartridge-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/cartridge-tools.js +29 -0
- package/dist/core/tool-schemas/cartridge-tools.js.map +1 -0
- package/dist/core/tool-schemas/code-version-tools.d.ts +28 -0
- package/dist/core/tool-schemas/code-version-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/code-version-tools.js +28 -0
- package/dist/core/tool-schemas/code-version-tools.js.map +1 -0
- package/dist/core/tool-schemas/documentation-tools.d.ts +139 -0
- package/dist/core/tool-schemas/documentation-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/documentation-tools.js +104 -0
- package/dist/core/tool-schemas/documentation-tools.js.map +1 -0
- package/dist/core/tool-schemas/index.d.ts +17 -0
- package/dist/core/tool-schemas/index.d.ts.map +1 -0
- package/dist/core/tool-schemas/index.js +19 -0
- package/dist/core/tool-schemas/index.js.map +1 -0
- package/dist/core/tool-schemas/isml-tools.d.ts +98 -0
- package/dist/core/tool-schemas/isml-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/isml-tools.js +89 -0
- package/dist/core/tool-schemas/isml-tools.js.map +1 -0
- package/dist/core/tool-schemas/log-tools.d.ts +221 -0
- package/dist/core/tool-schemas/log-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/log-tools.js +180 -0
- package/dist/core/tool-schemas/log-tools.js.map +1 -0
- package/dist/core/tool-schemas/script-debugger-tools.d.ts +44 -0
- package/dist/core/tool-schemas/script-debugger-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/script-debugger-tools.js +83 -0
- package/dist/core/tool-schemas/script-debugger-tools.js.map +1 -0
- package/dist/core/tool-schemas/sfra-tools.d.ts +63 -0
- package/dist/core/tool-schemas/sfra-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/sfra-tools.js +65 -0
- package/dist/core/tool-schemas/sfra-tools.js.map +1 -0
- package/dist/core/tool-schemas/shared-schemas.d.ts +350 -0
- package/dist/core/tool-schemas/shared-schemas.d.ts.map +1 -0
- package/dist/core/tool-schemas/shared-schemas.js +153 -0
- package/dist/core/tool-schemas/shared-schemas.js.map +1 -0
- package/dist/core/tool-schemas/system-object-tools.d.ts +511 -0
- package/dist/core/tool-schemas/system-object-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/system-object-tools.js +126 -0
- package/dist/core/tool-schemas/system-object-tools.js.map +1 -0
- package/dist/docs/dw_net/HTTPClient.md +46 -2
- package/dist/docs/dw_net/HTTPClientLoggingConfig.md +296 -0
- package/dist/docs/dw_order/Basket.md +7 -7
- package/dist/docs/dw_order/BasketMgr.md +22 -6
- package/dist/docs/dw_order.hooks/BasketMergeHooks.md +42 -0
- package/dist/docs/dw_svc/ServiceCallback.md +2 -2
- package/dist/docs/isml/isactivedatacontext.md +382 -0
- package/dist/docs/isml/isactivedatahead.md +566 -0
- package/dist/docs/isml/isanalyticsoff.md +537 -0
- package/dist/docs/isml/isapplepay.md +667 -0
- package/dist/docs/isml/isbreak.md +687 -0
- package/dist/docs/isml/isbuynow.md +682 -0
- package/dist/docs/isml/iscache.md +802 -0
- package/dist/docs/isml/iscomment.md +794 -0
- package/dist/docs/isml/iscomponent.md +797 -0
- package/dist/docs/isml/iscontent.md +594 -0
- package/dist/docs/isml/iscontinue.md +563 -0
- package/dist/docs/isml/iscookie.md +798 -0
- package/dist/docs/isml/isdecorate.md +818 -0
- package/dist/docs/isml/isif.md +737 -0
- package/dist/docs/isml/isinclude.md +874 -0
- package/dist/docs/isml/isloop.md +377 -0
- package/dist/docs/isml/ismodule.md +844 -0
- package/dist/docs/isml/isnext.md +672 -0
- package/dist/docs/isml/isobject.md +760 -0
- package/dist/docs/isml/ispayment.md +577 -0
- package/dist/docs/isml/ispaymentmessages.md +664 -0
- package/dist/docs/isml/isprint.md +875 -0
- package/dist/docs/isml/isredirect.md +716 -0
- package/dist/docs/isml/isremove.md +725 -0
- package/dist/docs/isml/isreplace.md +783 -0
- package/dist/docs/isml/isscript.md +859 -0
- package/dist/docs/isml/isselect.md +908 -0
- package/dist/docs/isml/isset.md +585 -0
- package/dist/docs/isml/isslot.md +824 -0
- package/dist/docs/isml/isstatus.md +711 -0
- package/dist/main.d.ts +16 -0
- package/dist/main.d.ts.map +1 -1
- package/dist/main.js +60 -28
- package/dist/main.js.map +1 -1
- package/dist/services/index.d.ts +4 -2
- package/dist/services/index.d.ts.map +1 -1
- package/dist/services/index.js +2 -2
- package/dist/services/index.js.map +1 -1
- package/dist/tool-configs/agent-instructions-tool-config.d.ts +6 -0
- package/dist/tool-configs/agent-instructions-tool-config.d.ts.map +1 -0
- package/dist/tool-configs/agent-instructions-tool-config.js +74 -0
- package/dist/tool-configs/agent-instructions-tool-config.js.map +1 -0
- package/dist/tool-configs/code-version-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/code-version-tool-config.js +0 -5
- package/dist/tool-configs/code-version-tool-config.js.map +1 -1
- package/dist/tool-configs/docs-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/docs-tool-config.js +0 -7
- package/dist/tool-configs/docs-tool-config.js.map +1 -1
- package/dist/tool-configs/isml-tool-config.d.ts +11 -0
- package/dist/tool-configs/isml-tool-config.d.ts.map +1 -0
- package/dist/tool-configs/isml-tool-config.js +77 -0
- package/dist/tool-configs/isml-tool-config.js.map +1 -0
- package/dist/tool-configs/job-log-tool-config.d.ts +1 -2
- package/dist/tool-configs/job-log-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/job-log-tool-config.js +11 -15
- package/dist/tool-configs/job-log-tool-config.js.map +1 -1
- package/dist/tool-configs/log-tool-config.d.ts +1 -2
- package/dist/tool-configs/log-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/log-tool-config.js +35 -51
- package/dist/tool-configs/log-tool-config.js.map +1 -1
- package/dist/tool-configs/script-debugger-tool-config.d.ts +11 -0
- package/dist/tool-configs/script-debugger-tool-config.d.ts.map +1 -0
- package/dist/tool-configs/script-debugger-tool-config.js +35 -0
- package/dist/tool-configs/script-debugger-tool-config.js.map +1 -0
- package/dist/tool-configs/sfra-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/sfra-tool-config.js +0 -11
- package/dist/tool-configs/sfra-tool-config.js.map +1 -1
- package/dist/tool-configs/system-object-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/system-object-tool-config.js +0 -5
- package/dist/tool-configs/system-object-tool-config.js.map +1 -1
- package/dist/types/types.d.ts +2 -0
- package/dist/types/types.d.ts.map +1 -1
- package/dist/utils/cache.d.ts +12 -10
- package/dist/utils/cache.d.ts.map +1 -1
- package/dist/utils/cache.js +47 -47
- package/dist/utils/cache.js.map +1 -1
- package/dist/utils/category-utils.d.ts +31 -0
- package/dist/utils/category-utils.d.ts.map +1 -0
- package/dist/utils/category-utils.js +45 -0
- package/dist/utils/category-utils.js.map +1 -0
- package/dist/utils/log-tool-constants.d.ts +16 -13
- package/dist/utils/log-tool-constants.d.ts.map +1 -1
- package/dist/utils/log-tool-constants.js +10 -11
- package/dist/utils/log-tool-constants.js.map +1 -1
- package/dist/utils/logger.d.ts +11 -0
- package/dist/utils/logger.d.ts.map +1 -1
- package/dist/utils/logger.js +35 -1
- package/dist/utils/logger.js.map +1 -1
- package/dist/utils/markdown-utils.d.ts +60 -0
- package/dist/utils/markdown-utils.d.ts.map +1 -0
- package/dist/utils/markdown-utils.js +206 -0
- package/dist/utils/markdown-utils.js.map +1 -0
- package/dist/utils/path-resolver.d.ts +12 -4
- package/dist/utils/path-resolver.d.ts.map +1 -1
- package/dist/utils/path-resolver.js +22 -8
- package/dist/utils/path-resolver.js.map +1 -1
- package/dist/utils/path-validation.d.ts +40 -0
- package/dist/utils/path-validation.d.ts.map +1 -0
- package/dist/utils/path-validation.js +84 -0
- package/dist/utils/path-validation.js.map +1 -0
- package/docs/dw_net/HTTPClient.md +46 -2
- package/docs/dw_net/HTTPClientLoggingConfig.md +296 -0
- package/docs/dw_order/Basket.md +7 -7
- package/docs/dw_order/BasketMgr.md +22 -6
- package/docs/dw_order.hooks/BasketMergeHooks.md +42 -0
- package/docs/dw_svc/ServiceCallback.md +2 -2
- package/docs/isml/isactivedatacontext.md +382 -0
- package/docs/isml/isactivedatahead.md +566 -0
- package/docs/isml/isanalyticsoff.md +537 -0
- package/docs/isml/isapplepay.md +667 -0
- package/docs/isml/isbreak.md +687 -0
- package/docs/isml/isbuynow.md +682 -0
- package/docs/isml/iscache.md +802 -0
- package/docs/isml/iscomment.md +794 -0
- package/docs/isml/iscomponent.md +797 -0
- package/docs/isml/iscontent.md +594 -0
- package/docs/isml/iscontinue.md +563 -0
- package/docs/isml/iscookie.md +798 -0
- package/docs/isml/isdecorate.md +818 -0
- package/docs/isml/isif.md +737 -0
- package/docs/isml/isinclude.md +874 -0
- package/docs/isml/isloop.md +377 -0
- package/docs/isml/ismodule.md +844 -0
- package/docs/isml/isnext.md +672 -0
- package/docs/isml/isobject.md +760 -0
- package/docs/isml/ispayment.md +577 -0
- package/docs/isml/ispaymentmessages.md +664 -0
- package/docs/isml/isprint.md +875 -0
- package/docs/isml/isredirect.md +716 -0
- package/docs/isml/isremove.md +725 -0
- package/docs/isml/isreplace.md +783 -0
- package/docs/isml/isscript.md +859 -0
- package/docs/isml/isselect.md +908 -0
- package/docs/isml/isset.md +585 -0
- package/docs/isml/isslot.md +824 -0
- package/docs/isml/isstatus.md +711 -0
- package/docs-site-v2/.vitepress/config.mts +190 -0
- package/docs-site-v2/.vitepress/theme/components/AssistantTabs.vue +96 -0
- package/docs-site-v2/.vitepress/theme/components/Callout.vue +10 -0
- package/docs-site-v2/.vitepress/theme/components/Collapsible.vue +14 -0
- package/docs-site-v2/.vitepress/theme/components/DwJsonBuilder.vue +82 -0
- package/docs-site-v2/.vitepress/theme/components/HomeSections.vue +552 -0
- package/docs-site-v2/.vitepress/theme/components/InstructionFilesTabs.vue +87 -0
- package/docs-site-v2/.vitepress/theme/components/ModeTabs.vue +70 -0
- package/docs-site-v2/.vitepress/theme/components/NewcomerCTA.vue +14 -0
- package/docs-site-v2/.vitepress/theme/components/QuickStartCards.vue +20 -0
- package/docs-site-v2/.vitepress/theme/components/QuickStartHero.vue +20 -0
- package/docs-site-v2/.vitepress/theme/components/SkillsList.vue +48 -0
- package/docs-site-v2/.vitepress/theme/components/ToolExplorer.vue +85 -0
- package/docs-site-v2/.vitepress/theme/custom.css +1373 -0
- package/docs-site-v2/.vitepress/theme/index.ts +39 -0
- package/docs-site-v2/data/skills.ts +147 -0
- package/docs-site-v2/data/tools.ts +490 -0
- package/docs-site-v2/development/index.md +151 -0
- package/docs-site-v2/examples/index.md +333 -0
- package/docs-site-v2/features/index.md +144 -0
- package/docs-site-v2/guide/ai-interfaces.md +58 -0
- package/docs-site-v2/guide/configuration.md +208 -0
- package/docs-site-v2/guide/index.md +50 -0
- package/docs-site-v2/index.md +32 -0
- package/docs-site-v2/package-lock.json +2511 -0
- package/docs-site-v2/package.json +15 -0
- package/docs-site-v2/public/android-chrome-192x192.png +0 -0
- package/docs-site-v2/public/android-chrome-512x512.png +0 -0
- package/docs-site-v2/public/apple-touch-icon.png +0 -0
- package/docs-site-v2/public/favicon-16x16.png +0 -0
- package/docs-site-v2/public/favicon-32x32.png +0 -0
- package/docs-site-v2/public/favicon.ico +0 -0
- package/docs-site-v2/public/index.css +4174 -0
- package/docs-site-v2/public/llms.txt +44 -0
- package/docs-site-v2/public/logo-dark.svg +8 -0
- package/docs-site-v2/public/logo.svg +8 -0
- package/{docs-site → docs-site-v2}/public/robots.txt +1 -6
- package/{docs-site → docs-site-v2}/public/site.webmanifest +1 -1
- package/{docs-site → docs-site-v2}/public/sitemap.xml +33 -12
- package/docs-site-v2/script-debugger/index.md +105 -0
- package/docs-site-v2/scripts/generate-llms.js +71 -0
- package/docs-site-v2/scripts/generate-sitemap.js +97 -0
- package/docs-site-v2/security/index.md +115 -0
- package/docs-site-v2/skills/index.md +40 -0
- package/docs-site-v2/tools/index.md +36 -0
- package/docs-site-v2/troubleshooting/index.md +204 -0
- package/eslint.config.js +3 -1
- package/memories/repo/docs-site-v2-build.json +11 -0
- package/package.json +18 -14
- package/scripts/validate-server-json.js +68 -0
- package/server.json +4 -6
- package/src/clients/agent-instructions-client.ts +370 -0
- package/src/clients/base/abstract-documentation-client.ts +405 -0
- package/src/clients/base/oauth-token.ts +52 -2
- package/src/clients/cartridge/cartridge-generation-client.ts +302 -0
- package/src/clients/cartridge/cartridge-structure.ts +37 -0
- package/src/clients/cartridge/cartridge-templates.ts +246 -0
- package/src/clients/cartridge/index.ts +6 -0
- package/src/clients/docs/documentation-scanner.ts +44 -28
- package/src/clients/docs-client.ts +54 -14
- package/src/clients/isml-client.ts +353 -0
- package/src/clients/ocapi/code-versions-client.ts +7 -1
- package/src/clients/ocapi-client.ts +11 -166
- package/src/clients/script-debugger/index.ts +5 -0
- package/src/clients/script-debugger/script-debugger-client.ts +754 -0
- package/src/clients/sfra-client.ts +134 -397
- package/src/config/configuration-factory.ts +6 -1
- package/src/config/dw-json-loader.ts +96 -15
- package/src/config/workspace-roots.ts +540 -0
- package/src/constants/index.ts +1 -0
- package/src/core/handlers/abstract-client-handler.ts +85 -0
- package/src/core/handlers/agent-instructions-handler.ts +48 -0
- package/src/core/handlers/base-handler.ts +17 -127
- package/src/core/handlers/cartridge-handler.ts +13 -33
- package/src/core/handlers/client-factory.ts +32 -2
- package/src/core/handlers/code-version-handler.ts +17 -32
- package/src/core/handlers/docs-handler.ts +12 -44
- package/src/core/handlers/isml-handler.ts +19 -0
- package/src/core/handlers/job-log-handler.ts +19 -8
- package/src/core/handlers/log-handler.ts +19 -8
- package/src/core/handlers/script-debugger-handler.ts +46 -0
- package/src/core/handlers/sfra-handler.ts +12 -44
- package/src/core/handlers/simple-client-handler.ts +78 -0
- package/src/core/handlers/system-object-handler.ts +17 -32
- package/src/core/handlers/validation-helpers.ts +87 -47
- package/src/core/instruction-advisor.ts +122 -0
- package/src/core/server.ts +178 -13
- package/src/core/tool-definitions.ts +25 -1071
- package/src/core/tool-schemas/agent-instruction-tools.ts +72 -0
- package/src/core/tool-schemas/cartridge-tools.ts +29 -0
- package/src/core/tool-schemas/code-version-tools.ts +28 -0
- package/src/core/tool-schemas/documentation-tools.ts +104 -0
- package/src/core/tool-schemas/index.ts +27 -0
- package/src/core/tool-schemas/isml-tools.ts +89 -0
- package/src/core/tool-schemas/log-tools.ts +196 -0
- package/src/core/tool-schemas/script-debugger-tools.ts +83 -0
- package/src/core/tool-schemas/sfra-tools.ts +65 -0
- package/src/core/tool-schemas/shared-schemas.ts +158 -0
- package/src/core/tool-schemas/system-object-tools.ts +127 -0
- package/src/main.ts +63 -30
- package/src/services/index.ts +4 -10
- package/src/tool-configs/agent-instructions-tool-config.ts +83 -0
- package/src/tool-configs/cartridge-tool-config.ts +1 -1
- package/src/tool-configs/code-version-tool-config.ts +0 -5
- package/src/tool-configs/docs-tool-config.ts +0 -7
- package/src/tool-configs/isml-tool-config.ts +87 -0
- package/src/tool-configs/job-log-tool-config.ts +18 -17
- package/src/tool-configs/log-tool-config.ts +49 -64
- package/src/tool-configs/script-debugger-tool-config.ts +69 -0
- package/src/tool-configs/sfra-tool-config.ts +0 -11
- package/src/tool-configs/system-object-tool-config.ts +0 -5
- package/src/types/types.ts +2 -0
- package/src/utils/cache.ts +49 -54
- package/src/utils/category-utils.ts +70 -0
- package/src/utils/log-tool-constants.ts +25 -17
- package/src/utils/logger.ts +38 -1
- package/src/utils/markdown-utils.ts +280 -0
- package/src/utils/path-resolver.ts +25 -9
- package/src/utils/path-validation.ts +113 -0
- package/tests/base-handler.test.ts +1 -1
- package/tests/cache.test.ts +2 -2
- package/tests/cartridge-handler.test.ts +4 -4
- package/tests/client-factory.test.ts +1 -1
- package/tests/code-version-handler.test.ts +3 -3
- package/tests/docs-handler.test.ts +2 -2
- package/tests/documentation-scanner.test.ts +4 -4
- package/tests/isml-client.test.ts +463 -0
- package/tests/isml-handler.test.ts +375 -0
- package/tests/job-log-handler.test.ts +1 -1
- package/tests/log-handler.test.ts +8 -8
- package/tests/log-validation.test.ts +149 -0
- package/tests/mcp/README.md +22 -18
- package/tests/mcp/node/activate-code-version-advanced.full-mode.programmatic.test.js +30 -12
- package/tests/mcp/node/evaluate-script.full-mode.programmatic.test.js +387 -0
- package/tests/mcp/node/generate-cartridge-structure.docs-only.programmatic.test.js +14 -8
- package/tests/mcp/node/get-isml-categories.programmatic.test.js +278 -0
- package/tests/mcp/node/get-isml-element.programmatic.test.js +278 -0
- package/tests/mcp/node/get-isml-elements-by-category.programmatic.test.js +363 -0
- package/tests/mcp/node/get-sfra-categories.docs-only.programmatic.test.js +24 -24
- package/tests/mcp/node/get-sfra-document.programmatic.test.js +4 -2
- package/tests/mcp/node/list-isml-elements.programmatic.test.js +311 -0
- package/tests/mcp/node/list-sfcc-classes.docs-only.programmatic.test.js +2 -33
- package/tests/mcp/node/search-isml-elements.programmatic.test.js +325 -0
- package/tests/mcp/node/search-sfcc-classes.docs-only.programmatic.test.js +5 -9
- package/tests/mcp/node/search-sfcc-methods.docs-only.programmatic.test.js +7 -9
- package/tests/mcp/node/tools.docs-only.programmatic.test.js +42 -65
- package/tests/mcp/node/tools.full-mode.programmatic.test.js +7 -8
- package/tests/mcp/yaml/activate-code-version.full-mode.test.mcp.yml +2 -2
- package/tests/mcp/yaml/evaluate-script.full-mode.test.mcp.yml +281 -0
- package/tests/mcp/yaml/get-isml-categories.docs-only.test.mcp.yml +330 -0
- package/tests/mcp/yaml/get-isml-element.docs-only.test.mcp.yml +294 -0
- package/tests/mcp/yaml/get-isml-elements-by-category.docs-only.test.mcp.yml +334 -0
- package/tests/mcp/yaml/get-sfcc-class-info.docs-only.test.mcp.yml +2 -2
- package/tests/mcp/yaml/get-sfra-categories.docs-only.test.mcp.yml +13 -13
- package/tests/mcp/yaml/get-sfra-categories.full-mode.test.mcp.yml +13 -13
- package/tests/mcp/yaml/get-system-object-definitions.docs-only.test.mcp.yml +1 -16
- package/tests/mcp/yaml/list-isml-elements.docs-only.test.mcp.yml +212 -0
- package/tests/mcp/yaml/search-isml-elements.docs-only.test.mcp.yml +312 -0
- package/tests/mcp/yaml/search-sfcc-classes.docs-only.test.mcp.yml +1 -1
- package/tests/mcp/yaml/search-sfcc-classes.full-mode.test.mcp.yml +1 -1
- package/tests/mcp/yaml/search-site-preferences.docs-only.test.mcp.yml +1 -1
- package/tests/mcp/yaml/tools.docs-only.test.mcp.yml +3 -57
- package/tests/mcp/yaml/tools.full-mode.test.mcp.yml +3 -3
- package/tests/oauth-token.test.ts +107 -12
- package/tests/ocapi-client.test.ts +53 -106
- package/tests/script-debugger-client.test.ts +430 -0
- package/tests/servers/sfcc-mock-server/src/app.js +15 -0
- package/tests/servers/sfcc-mock-server/src/routes/cartridge-webdav.js +258 -0
- package/tests/servers/sfcc-mock-server/src/routes/ocapi/debugger-handler.js +396 -0
- package/tests/servers/sfcc-mock-server/src/routes/ocapi.js +5 -0
- package/tests/servers/sfcc-mock-server/src/routes/storefront.js +86 -0
- package/tests/servers/sfcc-mock-server/src/routes/webdav.js +6 -4
- package/tests/validation-helpers.test.ts +0 -31
- package/tests/workspace-roots.test.ts +227 -0
- package/ai-instructions/claude-desktop/claude_custom_instructions.md +0 -321
- package/ai-instructions/cursor/.cursor/rules/debugging-workflows.mdc +0 -171
- package/ai-instructions/cursor/.cursor/rules/hooks-development.mdc +0 -168
- package/ai-instructions/cursor/.cursor/rules/isml-templates.mdc +0 -209
- package/ai-instructions/cursor/.cursor/rules/job-framework.mdc +0 -379
- package/ai-instructions/cursor/.cursor/rules/performance-optimization.mdc +0 -215
- package/ai-instructions/cursor/.cursor/rules/scapi-endpoints.mdc +0 -98
- package/ai-instructions/cursor/.cursor/rules/security-patterns.mdc +0 -375
- package/ai-instructions/cursor/.cursor/rules/sfcc-development.mdc +0 -144
- package/ai-instructions/cursor/.cursor/rules/sfra-controllers.mdc +0 -376
- package/ai-instructions/cursor/.cursor/rules/sfra-models.mdc +0 -412
- package/ai-instructions/cursor/.cursor/rules/system-objects.mdc +0 -383
- package/ai-instructions/cursor/.cursor/rules/testing-patterns.mdc +0 -418
- package/dist/clients/best-practices-client.d.ts +0 -57
- package/dist/clients/best-practices-client.d.ts.map +0 -1
- package/dist/clients/best-practices-client.js +0 -288
- package/dist/clients/best-practices-client.js.map +0 -1
- package/dist/clients/cartridge-generation-client.d.ts +0 -57
- package/dist/clients/cartridge-generation-client.d.ts.map +0 -1
- package/dist/clients/cartridge-generation-client.js +0 -384
- package/dist/clients/cartridge-generation-client.js.map +0 -1
- package/dist/clients/logs/index.d.ts +0 -13
- package/dist/clients/logs/index.d.ts.map +0 -1
- package/dist/clients/logs/index.js +0 -15
- package/dist/clients/logs/index.js.map +0 -1
- package/dist/clients/logs/log-analyzer.d.ts +0 -55
- package/dist/clients/logs/log-analyzer.d.ts.map +0 -1
- package/dist/clients/logs/log-analyzer.js +0 -228
- package/dist/clients/logs/log-analyzer.js.map +0 -1
- package/dist/clients/logs/log-client.d.ts +0 -87
- package/dist/clients/logs/log-client.d.ts.map +0 -1
- package/dist/clients/logs/log-client.js +0 -418
- package/dist/clients/logs/log-client.js.map +0 -1
- package/dist/clients/logs/log-constants.d.ts +0 -37
- package/dist/clients/logs/log-constants.d.ts.map +0 -1
- package/dist/clients/logs/log-constants.js +0 -37
- package/dist/clients/logs/log-constants.js.map +0 -1
- package/dist/clients/logs/log-file-discovery.d.ts +0 -62
- package/dist/clients/logs/log-file-discovery.d.ts.map +0 -1
- package/dist/clients/logs/log-file-discovery.js +0 -238
- package/dist/clients/logs/log-file-discovery.js.map +0 -1
- package/dist/clients/logs/log-file-reader.d.ts +0 -53
- package/dist/clients/logs/log-file-reader.d.ts.map +0 -1
- package/dist/clients/logs/log-file-reader.js +0 -194
- package/dist/clients/logs/log-file-reader.js.map +0 -1
- package/dist/clients/logs/log-formatter.d.ts +0 -90
- package/dist/clients/logs/log-formatter.d.ts.map +0 -1
- package/dist/clients/logs/log-formatter.js +0 -189
- package/dist/clients/logs/log-formatter.js.map +0 -1
- package/dist/clients/logs/log-processor.d.ts +0 -91
- package/dist/clients/logs/log-processor.d.ts.map +0 -1
- package/dist/clients/logs/log-processor.js +0 -328
- package/dist/clients/logs/log-processor.js.map +0 -1
- package/dist/clients/logs/log-types.d.ts +0 -69
- package/dist/clients/logs/log-types.d.ts.map +0 -1
- package/dist/clients/logs/log-types.js +0 -5
- package/dist/clients/logs/log-types.js.map +0 -1
- package/dist/clients/logs/webdav-client-manager.d.ts +0 -28
- package/dist/clients/logs/webdav-client-manager.d.ts.map +0 -1
- package/dist/clients/logs/webdav-client-manager.js +0 -77
- package/dist/clients/logs/webdav-client-manager.js.map +0 -1
- package/dist/core/handlers/abstract-log-tool-handler.d.ts +0 -35
- package/dist/core/handlers/abstract-log-tool-handler.d.ts.map +0 -1
- package/dist/core/handlers/abstract-log-tool-handler.js +0 -46
- package/dist/core/handlers/abstract-log-tool-handler.js.map +0 -1
- package/dist/core/handlers/best-practices-handler.d.ts +0 -17
- package/dist/core/handlers/best-practices-handler.d.ts.map +0 -1
- package/dist/core/handlers/best-practices-handler.js +0 -43
- package/dist/core/handlers/best-practices-handler.js.map +0 -1
- package/dist/core/handlers/job-log-tool-config.d.ts +0 -8
- package/dist/core/handlers/job-log-tool-config.d.ts.map +0 -1
- package/dist/core/handlers/job-log-tool-config.js +0 -76
- package/dist/core/handlers/job-log-tool-config.js.map +0 -1
- package/dist/core/handlers/log-tool-config.d.ts +0 -8
- package/dist/core/handlers/log-tool-config.d.ts.map +0 -1
- package/dist/core/handlers/log-tool-config.js +0 -73
- package/dist/core/handlers/log-tool-config.js.map +0 -1
- package/dist/docs/best-practices/isml_templates.md +0 -1933
- package/dist/docs/best-practices/job_framework.md +0 -1173
- package/dist/docs/best-practices/scapi_custom_endpoint.md +0 -963
- package/dist/docs/best-practices/sfra_client_side_js.md +0 -736
- package/dist/docs/best-practices/sfra_models.md +0 -1142
- package/dist/tool-configs/best-practices-tool-config.d.ts +0 -11
- package/dist/tool-configs/best-practices-tool-config.d.ts.map +0 -1
- package/dist/tool-configs/best-practices-tool-config.js +0 -59
- package/dist/tool-configs/best-practices-tool-config.js.map +0 -1
- package/dist/utils/job-log-tool-config.d.ts +0 -8
- package/dist/utils/job-log-tool-config.d.ts.map +0 -1
- package/dist/utils/job-log-tool-config.js +0 -76
- package/dist/utils/job-log-tool-config.js.map +0 -1
- package/dist/utils/job-log-utils.d.ts +0 -34
- package/dist/utils/job-log-utils.d.ts.map +0 -1
- package/dist/utils/job-log-utils.js +0 -60
- package/dist/utils/job-log-utils.js.map +0 -1
- package/dist/utils/log-cache.d.ts +0 -53
- package/dist/utils/log-cache.d.ts.map +0 -1
- package/dist/utils/log-cache.js +0 -114
- package/dist/utils/log-cache.js.map +0 -1
- package/dist/utils/log-tool-config.d.ts +0 -8
- package/dist/utils/log-tool-config.d.ts.map +0 -1
- package/dist/utils/log-tool-config.js +0 -73
- package/dist/utils/log-tool-config.js.map +0 -1
- package/dist/utils/log-tool-utils.d.ts +0 -39
- package/dist/utils/log-tool-utils.d.ts.map +0 -1
- package/dist/utils/log-tool-utils.js +0 -94
- package/dist/utils/log-tool-utils.js.map +0 -1
- package/docs/best-practices/isml_templates.md +0 -1933
- package/docs/best-practices/job_framework.md +0 -1173
- package/docs/best-practices/scapi_custom_endpoint.md +0 -963
- package/docs/best-practices/sfra_client_side_js.md +0 -736
- package/docs/best-practices/sfra_models.md +0 -1142
- package/docs-site/App.tsx +0 -103
- package/docs-site/README.md +0 -113
- package/docs-site/components/Badge.tsx +0 -38
- package/docs-site/components/BreadcrumbSchema.tsx +0 -34
- package/docs-site/components/CodeBlock.tsx +0 -132
- package/docs-site/components/Collapsible.tsx +0 -40
- package/docs-site/components/ConfigBuilder.tsx +0 -118
- package/docs-site/components/ConfigHero.tsx +0 -19
- package/docs-site/components/ConfigModeTabs.tsx +0 -42
- package/docs-site/components/Layout.tsx +0 -174
- package/docs-site/components/LightCodeContainer.tsx +0 -44
- package/docs-site/components/NewcomerCTA.tsx +0 -57
- package/docs-site/components/NextStepsStrip.tsx +0 -23
- package/docs-site/components/OnThisPage.tsx +0 -91
- package/docs-site/components/SEO.tsx +0 -79
- package/docs-site/components/Search.tsx +0 -207
- package/docs-site/components/Sidebar.tsx +0 -96
- package/docs-site/components/StructuredData.tsx +0 -72
- package/docs-site/components/ToolCard.tsx +0 -84
- package/docs-site/components/ToolFilters.tsx +0 -39
- package/docs-site/components/Typography.tsx +0 -30
- package/docs-site/components/VersionBadge.tsx +0 -18
- package/docs-site/components/icons.tsx +0 -37
- package/docs-site/constants.tsx +0 -34
- package/docs-site/index.html +0 -62
- package/docs-site/main.tsx +0 -16
- package/docs-site/metadata.json +0 -5
- package/docs-site/package-lock.json +0 -3966
- package/docs-site/package.json +0 -35
- package/docs-site/pages/AIInterfacesPage.tsx +0 -610
- package/docs-site/pages/ConfigurationPage.tsx +0 -315
- package/docs-site/pages/DevelopmentPage.tsx +0 -607
- package/docs-site/pages/ExamplesPage.tsx +0 -558
- package/docs-site/pages/FeaturesPage.tsx +0 -353
- package/docs-site/pages/HomePage.tsx +0 -1046
- package/docs-site/pages/SecurityPage.tsx +0 -372
- package/docs-site/pages/ToolsPage.tsx +0 -205
- package/docs-site/pages/TroubleshootingPage.tsx +0 -590
- package/docs-site/postcss.config.js +0 -6
- package/docs-site/public/.well-known/security.txt +0 -6
- package/docs-site/public/android-chrome-192x192.png +0 -0
- package/docs-site/public/android-chrome-512x512.png +0 -0
- package/docs-site/public/apple-touch-icon.png +0 -0
- package/docs-site/public/favicon-16x16.png +0 -0
- package/docs-site/public/favicon-32x32.png +0 -0
- package/docs-site/public/favicon.ico +0 -0
- package/docs-site/public/llms.txt +0 -47
- package/docs-site/scripts/generate-search-index.js +0 -323
- package/docs-site/scripts/generate-sitemap.js +0 -156
- package/docs-site/scripts/search-dev.js +0 -112
- package/docs-site/src/styles/input.css +0 -248
- package/docs-site/src/styles/prism-theme.css +0 -124
- package/docs-site/tailwind.config.js +0 -70
- package/docs-site/tsconfig.json +0 -29
- package/docs-site/types.ts +0 -16
- package/docs-site/utils/search.ts +0 -132
- package/docs-site/utils/toolsData.ts +0 -116
- package/docs-site/vite.config.ts +0 -63
- package/src/clients/best-practices-client.ts +0 -332
- package/src/clients/cartridge-generation-client.ts +0 -507
- package/src/clients/logs/index.ts +0 -18
- package/src/clients/logs/log-analyzer.ts +0 -289
- package/src/clients/logs/log-client.ts +0 -540
- package/src/clients/logs/log-constants.ts +0 -53
- package/src/clients/logs/log-file-discovery.ts +0 -299
- package/src/clients/logs/log-file-reader.ts +0 -227
- package/src/clients/logs/log-formatter.ts +0 -258
- package/src/clients/logs/log-processor.ts +0 -402
- package/src/clients/logs/log-types.ts +0 -80
- package/src/clients/logs/webdav-client-manager.ts +0 -93
- package/src/core/handlers/abstract-log-tool-handler.ts +0 -64
- package/src/core/handlers/best-practices-handler.ts +0 -55
- package/src/core/handlers/job-log-tool-config.ts +0 -89
- package/src/core/handlers/log-tool-config.ts +0 -98
- package/src/tool-configs/best-practices-tool-config.ts +0 -68
- package/src/utils/job-log-tool-config.ts +0 -89
- package/src/utils/job-log-utils.ts +0 -78
- package/src/utils/log-cache.ts +0 -134
- package/src/utils/log-tool-config.ts +0 -98
- package/src/utils/log-tool-utils.ts +0 -122
- package/tests/best-practices-handler.test.ts +0 -236
- package/tests/job-log-utils.test.ts +0 -182
- package/tests/mcp/node/get-available-best-practice-guides.docs-only.programmatic.test.js +0 -516
- package/tests/mcp/node/get-best-practice-guide.docs-only.programmatic.test.js +0 -733
- package/tests/mcp/node/get-hook-reference.docs-only.programmatic.test.js +0 -185
- package/tests/mcp/node/search-best-practices.docs-only.programmatic.test.js +0 -836
- package/tests/mcp/yaml/get-available-best-practice-guides.docs-only.test.mcp.yml +0 -885
- package/tests/mcp/yaml/get-available-best-practice-guides.full-mode.test.mcp.yml +0 -885
- package/tests/mcp/yaml/get-best-practice-guide.docs-only.test.mcp.yml +0 -462
- package/tests/mcp/yaml/get-best-practice-guide.full-mode.test.mcp.yml +0 -462
- package/tests/mcp/yaml/get-hook-reference.docs-only.test.mcp.yml +0 -321
- package/tests/mcp/yaml/get-hook-reference.full-mode.test.mcp.yml +0 -321
- package/tests/mcp/yaml/search-best-practices.docs-only.test.mcp.yml +0 -655
- package/tests/mcp/yaml/search-best-practices.full-mode.test.mcp.yml +0 -655
- /package/{docs-site → docs-site-v2}/public/404.html +0 -0
- /package/{docs-site → docs-site-v2}/public/explain-product-pricing-methods-no-mcp.png +0 -0
- /package/{docs-site → docs-site-v2}/public/explain-product-pricing-methods.png +0 -0
|
@@ -1,733 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Programmatic tests for get_best_practice_guide tool
|
|
3
|
-
*
|
|
4
|
-
* These tests provide advanced verification capabilities beyond YAML pattern matching,
|
|
5
|
-
* including dynamic validation, comprehensive content analysis,
|
|
6
|
-
* cross-guide relationship testing, and advanced error categorization for the SFCC
|
|
7
|
-
* best practice guide retrieval functionality.
|
|
8
|
-
*
|
|
9
|
-
* Response format discovered via aegis query:
|
|
10
|
-
* - Success: { content: [{ type: "text", text: "{\"title\":\"...\",\"description\":\"...\",\"sections\":[...],\"content\":\"...\"}" }], isError: false }
|
|
11
|
-
* - Error: { content: [{ type: "text", text: "Error: guideName must be a non-empty string" }], isError: true }
|
|
12
|
-
* - Invalid guide: { content: [{ type: "text", text: "null" }], isError: false }
|
|
13
|
-
* - JSON structure: title, description, sections array, content markdown
|
|
14
|
-
*/
|
|
15
|
-
|
|
16
|
-
import { test, describe, before, after, beforeEach } from 'node:test';
|
|
17
|
-
import { strict as assert } from 'node:assert';
|
|
18
|
-
import { connect } from 'mcp-aegis';
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* Content analysis utility for comprehensive guide validation
|
|
22
|
-
*/
|
|
23
|
-
class ContentAnalyzer {
|
|
24
|
-
constructor() {
|
|
25
|
-
this.contentPatterns = {
|
|
26
|
-
security: [
|
|
27
|
-
/CSRF|cross-site request forgery/i,
|
|
28
|
-
/XSS|cross-site scripting/i,
|
|
29
|
-
/authentication|authorization/i,
|
|
30
|
-
/encryption|cryptography/i,
|
|
31
|
-
/validation|sanitization/i
|
|
32
|
-
],
|
|
33
|
-
performance: [
|
|
34
|
-
/performance|optimization/i,
|
|
35
|
-
/caching|cache/i,
|
|
36
|
-
/memory|cpu/i,
|
|
37
|
-
/scalability|throughput/i,
|
|
38
|
-
/monitoring|metrics/i
|
|
39
|
-
],
|
|
40
|
-
sfra: [
|
|
41
|
-
/controller|middleware/i,
|
|
42
|
-
/server\.get|server\.post/i,
|
|
43
|
-
/SFRA|storefront reference architecture/i,
|
|
44
|
-
/isml|template/i,
|
|
45
|
-
/scss|sass/i,
|
|
46
|
-
/model|view/i
|
|
47
|
-
],
|
|
48
|
-
sfra_scss: [
|
|
49
|
-
/@import\s+['"]~base\//i,
|
|
50
|
-
/\$[a-z0-9_-]+\s*:/i,
|
|
51
|
-
/@include|mixins?/i,
|
|
52
|
-
/BEM|\b[a-z0-9]+__(?:[a-z0-9-]+)|\b[a-z0-9]+--[a-z0-9-]+/i,
|
|
53
|
-
/prefers-reduced-motion|focus ring|wcag/i
|
|
54
|
-
],
|
|
55
|
-
cartridge: [
|
|
56
|
-
/cartridge path/i,
|
|
57
|
-
/override mechanism/i,
|
|
58
|
-
/app_storefront_base/i,
|
|
59
|
-
/plugin_|app_custom_|int_|bm_/i,
|
|
60
|
-
/deployment|upload/i
|
|
61
|
-
]
|
|
62
|
-
};
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
analyzeGuide(guideData) {
|
|
66
|
-
const analysis = {
|
|
67
|
-
structuralIntegrity: this.checkStructuralIntegrity(guideData),
|
|
68
|
-
contentDepth: this.assessContentDepth(guideData),
|
|
69
|
-
codeExamples: this.extractCodeExamples(guideData),
|
|
70
|
-
crossReferences: this.findCrossReferences(guideData),
|
|
71
|
-
technicalAccuracy: this.validateTechnicalContent(guideData),
|
|
72
|
-
readabilityMetrics: this.calculateReadabilityMetrics(guideData)
|
|
73
|
-
};
|
|
74
|
-
|
|
75
|
-
return analysis;
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
checkStructuralIntegrity(guideData) {
|
|
79
|
-
const requiredFields = ['title', 'description', 'sections', 'content'];
|
|
80
|
-
const missingFields = requiredFields.filter(field => !guideData[field]);
|
|
81
|
-
|
|
82
|
-
return {
|
|
83
|
-
isComplete: missingFields.length === 0,
|
|
84
|
-
missingFields,
|
|
85
|
-
sectionsCount: Array.isArray(guideData.sections) ? guideData.sections.length : 0,
|
|
86
|
-
hasValidMarkdown: typeof guideData.content === 'string' && guideData.content.includes('#')
|
|
87
|
-
};
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
assessContentDepth(guideData) {
|
|
91
|
-
const content = guideData.content || '';
|
|
92
|
-
const wordCount = content.split(/\s+/).length;
|
|
93
|
-
const paragraphCount = content.split('\n\n').length;
|
|
94
|
-
const headingCount = (content.match(/^#+\s/gm) || []).length;
|
|
95
|
-
|
|
96
|
-
return {
|
|
97
|
-
wordCount,
|
|
98
|
-
paragraphCount,
|
|
99
|
-
headingCount,
|
|
100
|
-
averageWordsPerParagraph: wordCount / Math.max(paragraphCount, 1),
|
|
101
|
-
depthScore: this.calculateDepthScore(wordCount, headingCount, paragraphCount)
|
|
102
|
-
};
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
calculateDepthScore(wordCount, headingCount, paragraphCount) {
|
|
106
|
-
// Scoring based on content richness
|
|
107
|
-
let score = 0;
|
|
108
|
-
if (wordCount > 2000) score += 3;
|
|
109
|
-
else if (wordCount > 1000) score += 2;
|
|
110
|
-
else if (wordCount > 500) score += 1;
|
|
111
|
-
|
|
112
|
-
if (headingCount > 8) score += 2;
|
|
113
|
-
else if (headingCount > 4) score += 1;
|
|
114
|
-
|
|
115
|
-
if (paragraphCount > 15) score += 2;
|
|
116
|
-
else if (paragraphCount > 8) score += 1;
|
|
117
|
-
|
|
118
|
-
return Math.min(score, 5); // Max score of 5
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
extractCodeExamples(guideData) {
|
|
122
|
-
const content = guideData.content || '';
|
|
123
|
-
const codeBlocks = content.match(/```[\s\S]*?```/g) || [];
|
|
124
|
-
const inlineCode = content.match(/`[^`\n]+`/g) || [];
|
|
125
|
-
|
|
126
|
-
const languages = codeBlocks.map(block => {
|
|
127
|
-
const match = block.match(/```(\w+)/);
|
|
128
|
-
return match ? match[1] : 'unknown';
|
|
129
|
-
});
|
|
130
|
-
|
|
131
|
-
return {
|
|
132
|
-
codeBlockCount: codeBlocks.length,
|
|
133
|
-
inlineCodeCount: inlineCode.length,
|
|
134
|
-
languages: [...new Set(languages)],
|
|
135
|
-
hasJavaScript: languages.includes('javascript'),
|
|
136
|
-
hasJSON: languages.includes('json'),
|
|
137
|
-
hasBash: languages.includes('bash'),
|
|
138
|
-
hasHTML: languages.includes('html') || languages.includes('isml')
|
|
139
|
-
};
|
|
140
|
-
}
|
|
141
|
-
|
|
142
|
-
findCrossReferences(guideData) {
|
|
143
|
-
const content = guideData.content || '';
|
|
144
|
-
const mcpReferences = (content.match(/MCP server|MCP tool|`\w+_\w+`/g) || []).length;
|
|
145
|
-
const sfccReferences = (content.match(/dw\.\w+|SFCC|Salesforce Commerce Cloud/g) || []).length;
|
|
146
|
-
const externalReferences = (content.match(/https?:\/\/[^\s)]+/g) || []).length;
|
|
147
|
-
|
|
148
|
-
return {
|
|
149
|
-
mcpReferences,
|
|
150
|
-
sfccReferences,
|
|
151
|
-
externalReferences,
|
|
152
|
-
totalReferences: mcpReferences + sfccReferences + externalReferences,
|
|
153
|
-
hasIntegrationWorkflow: content.includes('MCP Integration Workflow')
|
|
154
|
-
};
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
validateTechnicalContent(guideData) {
|
|
158
|
-
const content = guideData.content || '';
|
|
159
|
-
const guideName = this.inferGuideType(guideData);
|
|
160
|
-
const expectedPatterns = this.contentPatterns[guideName] || [];
|
|
161
|
-
|
|
162
|
-
const matchedPatterns = expectedPatterns.filter(pattern => pattern.test(content));
|
|
163
|
-
|
|
164
|
-
let modernPattern = /dw\.crypto\.Cipher|server\.append|server\.prepend/i;
|
|
165
|
-
if (guideName === 'sfra_scss') {
|
|
166
|
-
modernPattern = /@include|prefers-reduced-motion|mixins?|@import\s+['"]~base\//i;
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
return {
|
|
170
|
-
guideName,
|
|
171
|
-
expectedPatterns: expectedPatterns.length,
|
|
172
|
-
matchedPatterns: matchedPatterns.length,
|
|
173
|
-
accuracyScore: expectedPatterns.length > 0 ?
|
|
174
|
-
(matchedPatterns.length / expectedPatterns.length) : 1,
|
|
175
|
-
hasDeprecatedReferences: /WeakCipher|WeakMac|WeakMessageDigest/i.test(content),
|
|
176
|
-
hasModernPractices: modernPattern.test(content)
|
|
177
|
-
};
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
inferGuideType(guideData) {
|
|
181
|
-
const title = (guideData.title || '').toLowerCase();
|
|
182
|
-
if (title.includes('security')) return 'security';
|
|
183
|
-
if (title.includes('performance')) return 'performance';
|
|
184
|
-
if (title.includes('scss') || title.includes('styling')) return 'sfra_scss';
|
|
185
|
-
if (title.includes('sfra') || title.includes('controller')) return 'sfra';
|
|
186
|
-
if (title.includes('cartridge')) return 'cartridge';
|
|
187
|
-
return 'general';
|
|
188
|
-
}
|
|
189
|
-
|
|
190
|
-
calculateReadabilityMetrics(guideData) {
|
|
191
|
-
const content = guideData.content || '';
|
|
192
|
-
const sentences = content.split(/[.!?]+/).filter(s => s.trim().length > 0);
|
|
193
|
-
const words = content.split(/\s+/).filter(w => w.length > 0);
|
|
194
|
-
|
|
195
|
-
const avgWordsPerSentence = words.length / Math.max(sentences.length, 1);
|
|
196
|
-
const avgCharsPerWord = words.reduce((sum, word) => sum + word.length, 0) / Math.max(words.length, 1);
|
|
197
|
-
|
|
198
|
-
return {
|
|
199
|
-
sentenceCount: sentences.length,
|
|
200
|
-
wordCount: words.length,
|
|
201
|
-
avgWordsPerSentence,
|
|
202
|
-
avgCharsPerWord,
|
|
203
|
-
readabilityScore: this.calculateFleschScore(avgWordsPerSentence, avgCharsPerWord)
|
|
204
|
-
};
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
calculateFleschScore(avgWordsPerSentence, avgCharsPerWord) {
|
|
208
|
-
// Simplified Flesch Reading Ease approximation
|
|
209
|
-
return Math.max(0, 206.835 - (1.015 * avgWordsPerSentence) - (84.6 * (avgCharsPerWord / 4.7)));
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
/**
|
|
214
|
-
* Error categorization utility for comprehensive error analysis
|
|
215
|
-
*/
|
|
216
|
-
class ErrorAnalyzer {
|
|
217
|
-
static categorizeError(errorText) {
|
|
218
|
-
const patterns = [
|
|
219
|
-
{ type: 'validation', keywords: ['required', 'invalid', 'missing', 'empty string'] },
|
|
220
|
-
{ type: 'not_found', keywords: ['not found', 'does not exist', 'null'] },
|
|
221
|
-
{ type: 'permission', keywords: ['permission', 'unauthorized', 'forbidden'] },
|
|
222
|
-
{ type: 'network', keywords: ['connection', 'timeout', 'unreachable'] },
|
|
223
|
-
{ type: 'parsing', keywords: ['parse', 'syntax', 'format'] }
|
|
224
|
-
];
|
|
225
|
-
|
|
226
|
-
for (const pattern of patterns) {
|
|
227
|
-
if (pattern.keywords.some(keyword =>
|
|
228
|
-
errorText.toLowerCase().includes(keyword))) {
|
|
229
|
-
return pattern.type;
|
|
230
|
-
}
|
|
231
|
-
}
|
|
232
|
-
return 'unknown';
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
static assessErrorQuality(errorText) {
|
|
236
|
-
return {
|
|
237
|
-
isInformative: errorText.length > 20,
|
|
238
|
-
hasContext: errorText.includes('guideName'),
|
|
239
|
-
isActionable: /must|should|required|expected/i.test(errorText),
|
|
240
|
-
category: this.categorizeError(errorText)
|
|
241
|
-
};
|
|
242
|
-
}
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* Custom assertion helpers for MCP response validation
|
|
247
|
-
*/
|
|
248
|
-
function assertValidMCPResponse(result, expectError = false) {
|
|
249
|
-
assert.ok(result.content, 'Should have content');
|
|
250
|
-
assert.ok(Array.isArray(result.content), 'Content should be array');
|
|
251
|
-
assert.equal(typeof result.isError, 'boolean', 'isError should be boolean');
|
|
252
|
-
assert.equal(result.isError, expectError, `isError should be ${expectError}`);
|
|
253
|
-
}
|
|
254
|
-
|
|
255
|
-
function assertGuideContent(result, expectedGuideName) {
|
|
256
|
-
assertValidMCPResponse(result);
|
|
257
|
-
assert.equal(result.content[0].type, 'text');
|
|
258
|
-
|
|
259
|
-
const text = result.content[0].text;
|
|
260
|
-
if (text === 'null') {
|
|
261
|
-
// Invalid guide name returns null
|
|
262
|
-
return null;
|
|
263
|
-
}
|
|
264
|
-
|
|
265
|
-
const guideData = JSON.parse(text);
|
|
266
|
-
assert.ok(guideData.title, 'Guide should have title');
|
|
267
|
-
assert.ok(guideData.description, 'Guide should have description');
|
|
268
|
-
assert.ok(Array.isArray(guideData.sections), 'Guide should have sections array');
|
|
269
|
-
assert.ok(guideData.content, 'Guide should have content');
|
|
270
|
-
|
|
271
|
-
if (expectedGuideName) {
|
|
272
|
-
assert.ok(
|
|
273
|
-
guideData.title.toLowerCase().includes(expectedGuideName.replace('_', ' ')) ||
|
|
274
|
-
guideData.description.toLowerCase().includes(expectedGuideName.replace('_', ' ')),
|
|
275
|
-
`Guide should be related to ${expectedGuideName}`
|
|
276
|
-
);
|
|
277
|
-
}
|
|
278
|
-
|
|
279
|
-
return guideData;
|
|
280
|
-
}
|
|
281
|
-
|
|
282
|
-
function assertErrorResponse(result, expectedErrorType) {
|
|
283
|
-
assertValidMCPResponse(result, true);
|
|
284
|
-
assert.equal(result.content[0].type, 'text');
|
|
285
|
-
|
|
286
|
-
const errorText = result.content[0].text;
|
|
287
|
-
assert.ok(errorText.includes('Error:'), 'Should be error message');
|
|
288
|
-
|
|
289
|
-
const errorAnalysis = ErrorAnalyzer.assessErrorQuality(errorText);
|
|
290
|
-
assert.ok(errorAnalysis.isInformative, 'Error should be informative');
|
|
291
|
-
|
|
292
|
-
if (expectedErrorType) {
|
|
293
|
-
assert.equal(errorAnalysis.category, expectedErrorType,
|
|
294
|
-
`Error should be categorized as ${expectedErrorType}`);
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
return errorAnalysis;
|
|
298
|
-
}
|
|
299
|
-
|
|
300
|
-
describe('get_best_practice_guide Tool - Advanced Programmatic Tests', () => {
|
|
301
|
-
let client;
|
|
302
|
-
let contentAnalyzer;
|
|
303
|
-
|
|
304
|
-
before(async () => {
|
|
305
|
-
client = await connect('./aegis.config.docs-only.json');
|
|
306
|
-
contentAnalyzer = new ContentAnalyzer();
|
|
307
|
-
});
|
|
308
|
-
|
|
309
|
-
after(async () => {
|
|
310
|
-
if (client?.connected) {
|
|
311
|
-
await client.disconnect();
|
|
312
|
-
}
|
|
313
|
-
});
|
|
314
|
-
|
|
315
|
-
beforeEach(() => {
|
|
316
|
-
// CRITICAL: Clear all buffers to prevent leaking between tests
|
|
317
|
-
client.clearAllBuffers(); // Recommended - comprehensive protection
|
|
318
|
-
});
|
|
319
|
-
|
|
320
|
-
describe('Protocol Compliance and Basic Functionality', () => {
|
|
321
|
-
test('should retrieve valid cartridge creation guide', async () => {
|
|
322
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
323
|
-
guideName: 'cartridge_creation'
|
|
324
|
-
});
|
|
325
|
-
|
|
326
|
-
const guideData = assertGuideContent(result, 'cartridge');
|
|
327
|
-
assert.ok(guideData.title.includes('Cartridge'), 'Should be cartridge guide');
|
|
328
|
-
assert.ok(guideData.content.includes('Core Principles'), 'Should have core principles');
|
|
329
|
-
});
|
|
330
|
-
|
|
331
|
-
test('should retrieve security best practices guide', async () => {
|
|
332
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
333
|
-
guideName: 'security'
|
|
334
|
-
});
|
|
335
|
-
|
|
336
|
-
const guideData = assertGuideContent(result, 'security');
|
|
337
|
-
assert.ok(guideData.title.toLowerCase().includes('secure') ||
|
|
338
|
-
guideData.title.toLowerCase().includes('security'), 'Should be security guide');
|
|
339
|
-
assert.ok(guideData.content.includes('CSRF') || guideData.content.includes('XSS') ||
|
|
340
|
-
guideData.content.includes('Security'), 'Should contain security concepts');
|
|
341
|
-
});
|
|
342
|
-
|
|
343
|
-
test('should retrieve SFRA client-side JavaScript guide', async () => {
|
|
344
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
345
|
-
guideName: 'sfra_client_side_js'
|
|
346
|
-
});
|
|
347
|
-
|
|
348
|
-
const guideData = assertGuideContent(result);
|
|
349
|
-
assert.ok(guideData.title.toLowerCase().includes('client-side javascript') ||
|
|
350
|
-
guideData.description.toLowerCase().includes('client-side javascript'),
|
|
351
|
-
'Guide should reference client-side JavaScript in title or description');
|
|
352
|
-
assert.ok(/ajax|assets\.js|debounce|event delegation/i.test(guideData.content),
|
|
353
|
-
'Guide content should include client-side patterns like AJAX or assets.js');
|
|
354
|
-
});
|
|
355
|
-
|
|
356
|
-
test('should retrieve SFRA SCSS guide', async () => {
|
|
357
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
358
|
-
guideName: 'sfra_scss'
|
|
359
|
-
});
|
|
360
|
-
|
|
361
|
-
const guideData = assertGuideContent(result);
|
|
362
|
-
assert.ok(guideData.title.toLowerCase().includes('scss') ||
|
|
363
|
-
guideData.description.toLowerCase().includes('scss'),
|
|
364
|
-
'Guide should reference SCSS in title or description');
|
|
365
|
-
assert.ok(/@import|_variables\.scss|mixins|sass/i.test(guideData.content),
|
|
366
|
-
'Guide content should highlight SCSS override patterns and mixins');
|
|
367
|
-
});
|
|
368
|
-
|
|
369
|
-
test('should handle invalid guide name gracefully', async () => {
|
|
370
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
371
|
-
guideName: 'nonexistent_guide'
|
|
372
|
-
});
|
|
373
|
-
|
|
374
|
-
assertValidMCPResponse(result);
|
|
375
|
-
assert.equal(result.content[0].text, 'null', 'Should return null for invalid guide');
|
|
376
|
-
});
|
|
377
|
-
|
|
378
|
-
test('should validate required parameters', async () => {
|
|
379
|
-
const result = await client.callTool('get_best_practice_guide', {});
|
|
380
|
-
|
|
381
|
-
assertErrorResponse(result, 'validation');
|
|
382
|
-
});
|
|
383
|
-
|
|
384
|
-
test('should handle empty guide name', async () => {
|
|
385
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
386
|
-
guideName: ''
|
|
387
|
-
});
|
|
388
|
-
|
|
389
|
-
assertErrorResponse(result, 'validation');
|
|
390
|
-
});
|
|
391
|
-
});
|
|
392
|
-
|
|
393
|
-
describe('Comprehensive Guide Validation', () => {
|
|
394
|
-
const availableGuides = [
|
|
395
|
-
'cartridge_creation',
|
|
396
|
-
'security',
|
|
397
|
-
'performance',
|
|
398
|
-
'sfra_controllers',
|
|
399
|
-
'sfra_models',
|
|
400
|
-
'sfra_client_side_js',
|
|
401
|
-
'sfra_scss',
|
|
402
|
-
'ocapi_hooks',
|
|
403
|
-
'scapi_hooks',
|
|
404
|
-
'scapi_custom_endpoint',
|
|
405
|
-
'isml_templates',
|
|
406
|
-
'job_framework',
|
|
407
|
-
'localserviceregistry'
|
|
408
|
-
];
|
|
409
|
-
|
|
410
|
-
test('should validate all available guides have proper structure', async () => {
|
|
411
|
-
const guideAnalyses = new Map();
|
|
412
|
-
|
|
413
|
-
for (const guideName of availableGuides) {
|
|
414
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
415
|
-
guideName
|
|
416
|
-
});
|
|
417
|
-
|
|
418
|
-
const guideData = assertGuideContent(result);
|
|
419
|
-
const analysis = contentAnalyzer.analyzeGuide(guideData);
|
|
420
|
-
guideAnalyses.set(guideName, analysis);
|
|
421
|
-
|
|
422
|
-
// Structural integrity checks
|
|
423
|
-
assert.ok(analysis.structuralIntegrity.isComplete,
|
|
424
|
-
`${guideName} should have complete structure`);
|
|
425
|
-
assert.ok(analysis.structuralIntegrity.sectionsCount > 0,
|
|
426
|
-
`${guideName} should have sections`);
|
|
427
|
-
assert.ok(analysis.structuralIntegrity.hasValidMarkdown,
|
|
428
|
-
`${guideName} should have valid markdown`);
|
|
429
|
-
|
|
430
|
-
// Content depth validation
|
|
431
|
-
assert.ok(analysis.contentDepth.wordCount > 500,
|
|
432
|
-
`${guideName} should have substantial content (>500 words)`);
|
|
433
|
-
assert.ok(analysis.contentDepth.depthScore >= 2,
|
|
434
|
-
`${guideName} should have good content depth`);
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
// Analyze overall guide quality
|
|
438
|
-
const averageDepthScore = Array.from(guideAnalyses.values())
|
|
439
|
-
.reduce((sum, analysis) => sum + analysis.contentDepth.depthScore, 0) /
|
|
440
|
-
guideAnalyses.size;
|
|
441
|
-
|
|
442
|
-
assert.ok(averageDepthScore >= 3,
|
|
443
|
-
`Average guide depth score should be >= 3, got ${averageDepthScore}`);
|
|
444
|
-
});
|
|
445
|
-
|
|
446
|
-
test('should validate technical accuracy across guide types', async () => {
|
|
447
|
-
const techGuides = ['security', 'sfra_controllers', 'sfra_client_side_js', 'sfra_scss', 'cartridge_creation'];
|
|
448
|
-
|
|
449
|
-
for (const guideName of techGuides) {
|
|
450
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
451
|
-
guideName
|
|
452
|
-
});
|
|
453
|
-
|
|
454
|
-
const guideData = assertGuideContent(result);
|
|
455
|
-
const analysis = contentAnalyzer.analyzeGuide(guideData);
|
|
456
|
-
|
|
457
|
-
// Technical accuracy validation
|
|
458
|
-
assert.ok(analysis.technicalAccuracy.accuracyScore >= 0.7,
|
|
459
|
-
`${guideName} should have high technical accuracy`);
|
|
460
|
-
|
|
461
|
-
// Modern practices validation
|
|
462
|
-
if (guideName === 'security') {
|
|
463
|
-
assert.ok(analysis.technicalAccuracy.hasModernPractices,
|
|
464
|
-
'Security guide should reference modern practices');
|
|
465
|
-
assert.ok(!analysis.technicalAccuracy.hasDeprecatedReferences ||
|
|
466
|
-
analysis.technicalAccuracy.hasModernPractices,
|
|
467
|
-
'Security guide should prefer modern over deprecated practices');
|
|
468
|
-
}
|
|
469
|
-
|
|
470
|
-
// Code examples validation
|
|
471
|
-
if (['sfra_controllers', 'sfra_client_side_js', 'sfra_scss', 'cartridge_creation'].includes(guideName)) {
|
|
472
|
-
assert.ok(analysis.codeExamples.codeBlockCount > 0,
|
|
473
|
-
`${guideName} should have code examples`);
|
|
474
|
-
|
|
475
|
-
if (guideName === 'sfra_scss') {
|
|
476
|
-
const hasScssLanguage = analysis.codeExamples.languages.includes('scss');
|
|
477
|
-
const mentionsScssPatterns = /@import|\$[a-zA-Z_-]+|mixins?/i.test(guideData.content);
|
|
478
|
-
assert.ok(hasScssLanguage || mentionsScssPatterns,
|
|
479
|
-
'SFRA SCSS guide should showcase SCSS override patterns');
|
|
480
|
-
} else {
|
|
481
|
-
assert.ok(analysis.codeExamples.hasJavaScript,
|
|
482
|
-
`${guideName} should have JavaScript examples`);
|
|
483
|
-
}
|
|
484
|
-
}
|
|
485
|
-
}
|
|
486
|
-
});
|
|
487
|
-
|
|
488
|
-
test('should validate cross-references and integration patterns', async () => {
|
|
489
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
490
|
-
guideName: 'cartridge_creation'
|
|
491
|
-
});
|
|
492
|
-
|
|
493
|
-
const guideData = assertGuideContent(result);
|
|
494
|
-
const analysis = contentAnalyzer.analyzeGuide(guideData);
|
|
495
|
-
|
|
496
|
-
// Cross-reference validation
|
|
497
|
-
assert.ok(analysis.crossReferences.mcpReferences > 0,
|
|
498
|
-
'Cartridge guide should reference MCP tools');
|
|
499
|
-
assert.ok(analysis.crossReferences.hasIntegrationWorkflow,
|
|
500
|
-
'Cartridge guide should have MCP integration workflow');
|
|
501
|
-
assert.ok(analysis.crossReferences.sfccReferences > 0,
|
|
502
|
-
'Cartridge guide should reference SFCC concepts');
|
|
503
|
-
});
|
|
504
|
-
});
|
|
505
|
-
|
|
506
|
-
describe('Advanced Error Handling and Edge Cases', () => {
|
|
507
|
-
test('should provide detailed error categorization', async () => {
|
|
508
|
-
const errorScenarios = [
|
|
509
|
-
{ params: {}, expectedCategory: 'validation' },
|
|
510
|
-
{ params: { guideName: '' }, expectedCategory: 'validation' },
|
|
511
|
-
{ params: { guideName: null }, expectedCategory: 'validation' },
|
|
512
|
-
{ params: { guideName: 123 }, expectedCategory: 'validation' }
|
|
513
|
-
];
|
|
514
|
-
|
|
515
|
-
for (const scenario of errorScenarios) {
|
|
516
|
-
const result = await client.callTool('get_best_practice_guide', scenario.params);
|
|
517
|
-
|
|
518
|
-
if (result.isError) {
|
|
519
|
-
const errorAnalysis = assertErrorResponse(result, scenario.expectedCategory);
|
|
520
|
-
assert.ok(errorAnalysis.isActionable,
|
|
521
|
-
'Error message should be actionable');
|
|
522
|
-
} else {
|
|
523
|
-
// Some invalid params might return null instead of error
|
|
524
|
-
assert.equal(result.content[0].text, 'null',
|
|
525
|
-
'Invalid params should return null if not error');
|
|
526
|
-
}
|
|
527
|
-
}
|
|
528
|
-
});
|
|
529
|
-
|
|
530
|
-
test('should handle malformed requests gracefully', async () => {
|
|
531
|
-
const malformedScenarios = [
|
|
532
|
-
{ guideName: 'a'.repeat(1000) }, // Very long guide name
|
|
533
|
-
{ guideName: 'guide\nwith\nnewlines' }, // Guide name with newlines
|
|
534
|
-
{ guideName: 'guide with spaces' }, // Guide name with spaces
|
|
535
|
-
{ extraParam: 'unexpected', guideName: 'security' } // Extra parameters
|
|
536
|
-
];
|
|
537
|
-
|
|
538
|
-
for (const params of malformedScenarios) {
|
|
539
|
-
const result = await client.callTool('get_best_practice_guide', params);
|
|
540
|
-
|
|
541
|
-
// Should either return valid response or informative error
|
|
542
|
-
if (result.isError) {
|
|
543
|
-
assertErrorResponse(result);
|
|
544
|
-
} else {
|
|
545
|
-
// If it succeeds or returns null, that's also acceptable
|
|
546
|
-
assertValidMCPResponse(result);
|
|
547
|
-
}
|
|
548
|
-
}
|
|
549
|
-
});
|
|
550
|
-
|
|
551
|
-
test('should maintain consistency across error conditions', async () => {
|
|
552
|
-
const errorConditions = [
|
|
553
|
-
{ guideName: 'invalid1' },
|
|
554
|
-
{ guideName: 'invalid2' },
|
|
555
|
-
{ guideName: 'nonexistent' }
|
|
556
|
-
];
|
|
557
|
-
|
|
558
|
-
const errorResponses = [];
|
|
559
|
-
for (const params of errorConditions) {
|
|
560
|
-
const result = await client.callTool('get_best_practice_guide', params);
|
|
561
|
-
errorResponses.push(result);
|
|
562
|
-
}
|
|
563
|
-
|
|
564
|
-
// All invalid guide names should behave consistently
|
|
565
|
-
const responseTypes = errorResponses.map(r =>
|
|
566
|
-
r.isError ? 'error' : (r.content[0].text === 'null' ? 'null' : 'unexpected')
|
|
567
|
-
);
|
|
568
|
-
|
|
569
|
-
const uniqueResponseTypes = [...new Set(responseTypes)];
|
|
570
|
-
assert.equal(uniqueResponseTypes.length, 1,
|
|
571
|
-
'All invalid guide names should have consistent response type');
|
|
572
|
-
});
|
|
573
|
-
});
|
|
574
|
-
|
|
575
|
-
describe('Multi-Step Integration Workflows', () => {
|
|
576
|
-
test('should support guide discovery to detailed retrieval workflow', async () => {
|
|
577
|
-
// Step 1: Discover available guides
|
|
578
|
-
const availableResult = await client.callTool('get_available_best_practice_guides', {});
|
|
579
|
-
assertValidMCPResponse(availableResult);
|
|
580
|
-
|
|
581
|
-
const availableGuides = JSON.parse(availableResult.content[0].text);
|
|
582
|
-
assert.ok(Array.isArray(availableGuides), 'Should return guides array');
|
|
583
|
-
assert.ok(availableGuides.length > 0, 'Should have available guides');
|
|
584
|
-
|
|
585
|
-
// Step 2: Retrieve detailed guide for each discovered guide
|
|
586
|
-
for (const guide of availableGuides.slice(0, 3)) { // Test first 3 for performance
|
|
587
|
-
const detailResult = await client.callTool('get_best_practice_guide', {
|
|
588
|
-
guideName: guide.name
|
|
589
|
-
});
|
|
590
|
-
|
|
591
|
-
const guideData = assertGuideContent(detailResult);
|
|
592
|
-
|
|
593
|
-
// Validate consistency between discovery and detailed retrieval
|
|
594
|
-
// Note: Descriptions may be slightly different between discovery and detailed view
|
|
595
|
-
assert.ok(guideData.description.toLowerCase().includes('best practices') ||
|
|
596
|
-
guideData.description.toLowerCase().includes('guide') ||
|
|
597
|
-
guide.description.toLowerCase().includes('best practices'),
|
|
598
|
-
'Guide descriptions should be conceptually consistent');
|
|
599
|
-
}
|
|
600
|
-
});
|
|
601
|
-
|
|
602
|
-
test('should support cross-guide relationship analysis', async () => {
|
|
603
|
-
// Get related guides
|
|
604
|
-
const cartridgeResult = await client.callTool('get_best_practice_guide', {
|
|
605
|
-
guideName: 'cartridge_creation'
|
|
606
|
-
});
|
|
607
|
-
const securityResult = await client.callTool('get_best_practice_guide', {
|
|
608
|
-
guideName: 'security'
|
|
609
|
-
});
|
|
610
|
-
const sfraResult = await client.callTool('get_best_practice_guide', {
|
|
611
|
-
guideName: 'sfra_controllers'
|
|
612
|
-
});
|
|
613
|
-
|
|
614
|
-
const cartridgeGuide = assertGuideContent(cartridgeResult);
|
|
615
|
-
const securityGuide = assertGuideContent(securityResult);
|
|
616
|
-
const sfraGuide = assertGuideContent(sfraResult);
|
|
617
|
-
|
|
618
|
-
// Analyze cross-references between guides
|
|
619
|
-
const cartridgeAnalysis = contentAnalyzer.analyzeGuide(cartridgeGuide);
|
|
620
|
-
const securityAnalysis = contentAnalyzer.analyzeGuide(securityGuide);
|
|
621
|
-
const sfraAnalysis = contentAnalyzer.analyzeGuide(sfraGuide);
|
|
622
|
-
|
|
623
|
-
// Validate that guides appropriately reference each other
|
|
624
|
-
assert.ok(cartridgeAnalysis.crossReferences.mcpReferences > 0,
|
|
625
|
-
'Cartridge guide should reference other MCP tools');
|
|
626
|
-
|
|
627
|
-
// Security guide should have practical implementation focus
|
|
628
|
-
assert.ok(securityAnalysis.codeExamples.codeBlockCount > 0,
|
|
629
|
-
'Security guide should have code examples');
|
|
630
|
-
|
|
631
|
-
// SFRA guide should reference server concepts
|
|
632
|
-
assert.ok(sfraAnalysis.technicalAccuracy.hasModernPractices,
|
|
633
|
-
'SFRA guide should reference modern practices');
|
|
634
|
-
});
|
|
635
|
-
|
|
636
|
-
test('should validate comprehensive development workflow coverage', async () => {
|
|
637
|
-
// Simulate a complete development workflow
|
|
638
|
-
const workflowGuides = [
|
|
639
|
-
'cartridge_creation', // Project setup
|
|
640
|
-
'sfra_controllers', // Server-side implementation
|
|
641
|
-
'sfra_client_side_js', // Client-side enhancements
|
|
642
|
-
'sfra_scss', // Styling and theming overrides
|
|
643
|
-
'security', // Security review
|
|
644
|
-
'performance' // Optimization
|
|
645
|
-
];
|
|
646
|
-
|
|
647
|
-
const workflowAnalysis = new Map();
|
|
648
|
-
|
|
649
|
-
for (const guideName of workflowGuides) {
|
|
650
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
651
|
-
guideName
|
|
652
|
-
});
|
|
653
|
-
|
|
654
|
-
const guideData = assertGuideContent(result);
|
|
655
|
-
const analysis = contentAnalyzer.analyzeGuide(guideData);
|
|
656
|
-
workflowAnalysis.set(guideName, analysis);
|
|
657
|
-
}
|
|
658
|
-
|
|
659
|
-
// Validate workflow completeness
|
|
660
|
-
const totalCodeExamples = Array.from(workflowAnalysis.values())
|
|
661
|
-
.reduce((sum, analysis) => sum + analysis.codeExamples.codeBlockCount, 0);
|
|
662
|
-
|
|
663
|
-
assert.ok(totalCodeExamples >= 10,
|
|
664
|
-
'Workflow guides should provide substantial code examples');
|
|
665
|
-
|
|
666
|
-
const totalCrossReferences = Array.from(workflowAnalysis.values())
|
|
667
|
-
.reduce((sum, analysis) => sum + analysis.crossReferences.totalReferences, 0);
|
|
668
|
-
|
|
669
|
-
assert.ok(totalCrossReferences >= 20,
|
|
670
|
-
'Workflow guides should have extensive cross-references');
|
|
671
|
-
|
|
672
|
-
// Validate that each workflow stage has appropriate depth
|
|
673
|
-
workflowAnalysis.forEach((analysis, guideName) => {
|
|
674
|
-
assert.ok(analysis.contentDepth.depthScore >= 3,
|
|
675
|
-
`${guideName} should have sufficient depth for workflow stage`);
|
|
676
|
-
});
|
|
677
|
-
});
|
|
678
|
-
});
|
|
679
|
-
|
|
680
|
-
describe('Content Quality and Accessibility', () => {
|
|
681
|
-
test('should validate readability across all guides', async () => {
|
|
682
|
-
const testGuides = ['cartridge_creation', 'security', 'sfra_controllers', 'sfra_client_side_js', 'sfra_scss'];
|
|
683
|
-
|
|
684
|
-
for (const guideName of testGuides) {
|
|
685
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
686
|
-
guideName
|
|
687
|
-
});
|
|
688
|
-
|
|
689
|
-
const guideData = assertGuideContent(result);
|
|
690
|
-
const analysis = contentAnalyzer.analyzeGuide(guideData);
|
|
691
|
-
|
|
692
|
-
// Readability validation
|
|
693
|
-
assert.ok(analysis.readabilityMetrics.avgWordsPerSentence < 25,
|
|
694
|
-
`${guideName} should have readable sentence length`);
|
|
695
|
-
assert.ok(analysis.readabilityMetrics.readabilityScore > 30,
|
|
696
|
-
`${guideName} should have acceptable readability score`);
|
|
697
|
-
|
|
698
|
-
// Content structure validation
|
|
699
|
-
assert.ok(analysis.contentDepth.headingCount >= 5,
|
|
700
|
-
`${guideName} should have good content organization`);
|
|
701
|
-
assert.ok(analysis.contentDepth.averageWordsPerParagraph < 200,
|
|
702
|
-
`${guideName} should have digestible paragraph sizes`);
|
|
703
|
-
}
|
|
704
|
-
});
|
|
705
|
-
|
|
706
|
-
test('should ensure comprehensive coverage of technical topics', async () => {
|
|
707
|
-
const technicalGuides = {
|
|
708
|
-
'security': ['CSRF', 'XSS', 'authentication', 'encryption'],
|
|
709
|
-
'performance': ['performance', 'optimization'], // Simplified expectations
|
|
710
|
-
'sfra_controllers': ['server.get', 'middleware', 'ISML'],
|
|
711
|
-
'sfra_client_side_js': ['ajax', 'assets.js', 'debounce', 'validation'],
|
|
712
|
-
'sfra_scss': ['@import', '_variables.scss', 'mixins', 'scss']
|
|
713
|
-
};
|
|
714
|
-
|
|
715
|
-
for (const [guideName, expectedTopics] of Object.entries(technicalGuides)) {
|
|
716
|
-
const result = await client.callTool('get_best_practice_guide', {
|
|
717
|
-
guideName
|
|
718
|
-
});
|
|
719
|
-
|
|
720
|
-
const guideData = assertGuideContent(result);
|
|
721
|
-
const content = guideData.content.toLowerCase();
|
|
722
|
-
|
|
723
|
-
const coveredTopics = expectedTopics.filter(topic =>
|
|
724
|
-
content.includes(topic.toLowerCase())
|
|
725
|
-
);
|
|
726
|
-
|
|
727
|
-
const coverageRatio = coveredTopics.length / expectedTopics.length;
|
|
728
|
-
assert.ok(coverageRatio >= 0.7,
|
|
729
|
-
`${guideName} should cover at least 70% of expected topics, covered ${coverageRatio * 100}%`);
|
|
730
|
-
}
|
|
731
|
-
});
|
|
732
|
-
});
|
|
733
|
-
});
|