@ikas/code-components-mcp 2.2.2 → 2.4.0
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/data/framework.json +1 -1
- package/data/storefront-api.json +31 -3
- package/data/storefront-types.json +5 -2
- package/dist/index.js +1250 -216
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
4
|
+
import { execFile } from "child_process";
|
|
4
5
|
import * as fs from "fs";
|
|
6
|
+
import * as os from "os";
|
|
5
7
|
import * as path from "path";
|
|
6
8
|
import { fileURLToPath } from "url";
|
|
7
9
|
import { z } from "zod";
|
|
@@ -96,9 +98,16 @@ function loadStorefrontTypes() {
|
|
|
96
98
|
}
|
|
97
99
|
return null;
|
|
98
100
|
}
|
|
99
|
-
const SUBTREE_KINDS = [
|
|
101
|
+
const SUBTREE_KINDS = [
|
|
102
|
+
"children",
|
|
103
|
+
"components",
|
|
104
|
+
"sub-components",
|
|
105
|
+
];
|
|
100
106
|
function normalizeName(value) {
|
|
101
|
-
return value
|
|
107
|
+
return value
|
|
108
|
+
.trim()
|
|
109
|
+
.replace(/^`+|`+$/g, "")
|
|
110
|
+
.trim();
|
|
102
111
|
}
|
|
103
112
|
const storefrontData = loadStorefrontData();
|
|
104
113
|
const frameworkData = loadJsonFile("../data/framework.json");
|
|
@@ -259,7 +268,11 @@ function searchMigrationTopics(query) {
|
|
|
259
268
|
const descScore = matchScore(topic.description, query) * 2;
|
|
260
269
|
const contentScore = matchScore(topic.content, query);
|
|
261
270
|
const tagScore = topic.tags.some((t) => matchScore(t, query) > 0) ? 5 : 0;
|
|
262
|
-
return {
|
|
271
|
+
return {
|
|
272
|
+
key,
|
|
273
|
+
topic,
|
|
274
|
+
score: titleScore + descScore + contentScore + tagScore,
|
|
275
|
+
};
|
|
263
276
|
})
|
|
264
277
|
.filter((item) => item.score > 0)
|
|
265
278
|
.sort((a, b) => b.score - a.score);
|
|
@@ -286,7 +299,7 @@ function analyzeOldTheme(themeJson) {
|
|
|
286
299
|
parts.push(`> **CRITICAL:** The old system (\`@ikas/storefront\`) and the new code-component system (\`@ikas/bp-storefront\`) are **entirely different packages**. Even when type names look the same (e.g., \`IkasImage\`, \`IkasProduct\`), they are different types with different properties. The prop type systems are also completely separate — old theme.json prop types and new ikas.config.json prop types have different semantics even when names match. **Never assume old-system knowledge applies to the new system.** Always use \`get_type_definition\`, \`get_model_guide\`, and \`get_function_doc\` to look up the correct new-system APIs.\n`);
|
|
287
300
|
parts.push(`## Summary Statistics\n`);
|
|
288
301
|
parts.push(`- **Components:** ${components.length}`);
|
|
289
|
-
parts.push(`- **Custom Data Definitions:** ${customData.filter(cd => cd.isRoot).length}`);
|
|
302
|
+
parts.push(`- **Custom Data Definitions:** ${customData.filter((cd) => cd.isRoot).length}`);
|
|
290
303
|
parts.push(`- **Prop Groups:** ${groups.length}`);
|
|
291
304
|
// Component analysis
|
|
292
305
|
parts.push(`\n## Components (${components.length})\n`);
|
|
@@ -325,7 +338,11 @@ function analyzeOldTheme(themeJson) {
|
|
|
325
338
|
const typesSummary = Object.entries(propTypeCounts)
|
|
326
339
|
.map(([t, c]) => `${t}×${c}`)
|
|
327
340
|
.join(", ");
|
|
328
|
-
const headerFooter = comp.isHeader
|
|
341
|
+
const headerFooter = comp.isHeader
|
|
342
|
+
? " [HEADER]"
|
|
343
|
+
: comp.isFooter
|
|
344
|
+
? " [FOOTER]"
|
|
345
|
+
: "";
|
|
329
346
|
parts.push(`### ${comp.displayName || comp.dir || comp.id}${headerFooter}`);
|
|
330
347
|
parts.push(`- **Dir:** \`${comp.dir || "?"}\` | **Props:** ${props.length} (${typesSummary})`);
|
|
331
348
|
parts.push(`- **Recommended new type:** section`);
|
|
@@ -340,7 +357,7 @@ function analyzeOldTheme(themeJson) {
|
|
|
340
357
|
parts.push("");
|
|
341
358
|
}
|
|
342
359
|
// Custom data analysis
|
|
343
|
-
const rootCustomData = customData.filter(cd => cd.isRoot);
|
|
360
|
+
const rootCustomData = customData.filter((cd) => cd.isRoot);
|
|
344
361
|
if (rootCustomData.length > 0) {
|
|
345
362
|
parts.push(`\n## Custom Data Definitions (${rootCustomData.length})\n`);
|
|
346
363
|
for (const cd of rootCustomData) {
|
|
@@ -350,7 +367,9 @@ function analyzeOldTheme(themeJson) {
|
|
|
350
367
|
const describeNested = (items, indent) => {
|
|
351
368
|
const lines = [];
|
|
352
369
|
for (const item of items) {
|
|
353
|
-
const key = item.key
|
|
370
|
+
const key = item.key
|
|
371
|
+
? `\`${item.key}\``
|
|
372
|
+
: item.typescriptName || item.name || "unnamed";
|
|
354
373
|
lines.push(`${indent}- ${key}: ${item.type}${item.isRequired ? " (required)" : ""}`);
|
|
355
374
|
if (item.nestedData && item.nestedData.length > 0) {
|
|
356
375
|
lines.push(...describeNested(item.nestedData, indent + " "));
|
|
@@ -362,7 +381,7 @@ function analyzeOldTheme(themeJson) {
|
|
|
362
381
|
parts.push(...describeNested(cd.nestedData, " "));
|
|
363
382
|
}
|
|
364
383
|
if (cd.enumOptions && cd.enumOptions.length > 0) {
|
|
365
|
-
parts.push(`- **Enum options:** ${cd.enumOptions.map(o => `"${o.value}"`).join(", ")}`);
|
|
384
|
+
parts.push(`- **Enum options:** ${cd.enumOptions.map((o) => `"${o.value}"`).join(", ")}`);
|
|
366
385
|
}
|
|
367
386
|
// Find which components reference this customData
|
|
368
387
|
const referencingComponents = [];
|
|
@@ -444,7 +463,9 @@ function scanSharedSubcomponents(sourceDir) {
|
|
|
444
463
|
const walk = (dir) => {
|
|
445
464
|
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
446
465
|
if (entry.isDirectory()) {
|
|
447
|
-
if (entry.name === "node_modules" ||
|
|
466
|
+
if (entry.name === "node_modules" ||
|
|
467
|
+
entry.name === "__generated__" ||
|
|
468
|
+
entry.name.startsWith("."))
|
|
448
469
|
continue;
|
|
449
470
|
walk(path.join(dir, entry.name));
|
|
450
471
|
}
|
|
@@ -479,10 +500,14 @@ function scanSharedSubcomponents(sourceDir) {
|
|
|
479
500
|
if (!importPath.startsWith("."))
|
|
480
501
|
continue;
|
|
481
502
|
// Skip imports of generated types, utils, hooks
|
|
482
|
-
if (importPath.includes("__generated__") ||
|
|
503
|
+
if (importPath.includes("__generated__") ||
|
|
504
|
+
importPath.includes("/utils") ||
|
|
505
|
+
importPath.includes("/hooks"))
|
|
483
506
|
continue;
|
|
484
507
|
// Extract base name from path
|
|
485
|
-
const pathSegments = importPath
|
|
508
|
+
const pathSegments = importPath
|
|
509
|
+
.split("/")
|
|
510
|
+
.filter((s) => s && s !== "." && s !== "..");
|
|
486
511
|
if (pathSegments.length === 0)
|
|
487
512
|
continue;
|
|
488
513
|
const lastSegment = pathSegments[pathSegments.length - 1];
|
|
@@ -493,7 +518,10 @@ function scanSharedSubcomponents(sourceDir) {
|
|
|
493
518
|
continue;
|
|
494
519
|
seenInFile.add(key);
|
|
495
520
|
if (!importUsage.has(key)) {
|
|
496
|
-
importUsage.set(key, {
|
|
521
|
+
importUsage.set(key, {
|
|
522
|
+
usingComponents: new Set(),
|
|
523
|
+
rawImportPath: importPath,
|
|
524
|
+
});
|
|
497
525
|
}
|
|
498
526
|
importUsage.get(key).usingComponents.add(componentDir);
|
|
499
527
|
}
|
|
@@ -502,7 +530,7 @@ function scanSharedSubcomponents(sourceDir) {
|
|
|
502
530
|
const shared = [];
|
|
503
531
|
for (const [name, { usingComponents, rawImportPath }] of importUsage) {
|
|
504
532
|
// Don't flag the component itself (e.g., Navbar imports from ../Navbar/something)
|
|
505
|
-
const users = [...usingComponents].filter(c => c !== name);
|
|
533
|
+
const users = [...usingComponents].filter((c) => c !== name);
|
|
506
534
|
if (users.length >= 3) {
|
|
507
535
|
shared.push({ name, usedBy: users.sort(), importPaths: [rawImportPath] });
|
|
508
536
|
}
|
|
@@ -519,7 +547,7 @@ function toKebabCase(s) {
|
|
|
519
547
|
}
|
|
520
548
|
function classifyComplexity(comp, customDataMap) {
|
|
521
549
|
const props = comp.props || [];
|
|
522
|
-
const customCount = props.filter(p => p.type === "CUSTOM").length;
|
|
550
|
+
const customCount = props.filter((p) => p.type === "CUSTOM").length;
|
|
523
551
|
if (customCount === 0 && props.length < 10)
|
|
524
552
|
return "simple";
|
|
525
553
|
// Check for deeply nested CUSTOM (customData referencing another customData)
|
|
@@ -530,7 +558,9 @@ function classifyComplexity(comp, customDataMap) {
|
|
|
530
558
|
if (cd?.nestedData) {
|
|
531
559
|
const hasNested = (items) => {
|
|
532
560
|
for (const item of items) {
|
|
533
|
-
if (item.type === "DYNAMIC_LIST" ||
|
|
561
|
+
if (item.type === "DYNAMIC_LIST" ||
|
|
562
|
+
item.type === "STATIC_LIST" ||
|
|
563
|
+
item.customDataId)
|
|
534
564
|
return true;
|
|
535
565
|
if (item.nestedData && hasNested(item.nestedData))
|
|
536
566
|
return true;
|
|
@@ -562,7 +592,7 @@ function generateMigrationPlan(theme, projectName, oldSourceDir) {
|
|
|
562
592
|
parts.push(`# Theme Migration Plan — \`${projectName}\``);
|
|
563
593
|
parts.push("");
|
|
564
594
|
parts.push(`**Generated:** ${new Date().toISOString().slice(0, 10)}`);
|
|
565
|
-
parts.push(`**Source:** ${components.length} old components, ${customData.filter(cd => cd.isRoot).length} custom data types, ${(theme.pages || []).length} pages`);
|
|
595
|
+
parts.push(`**Source:** ${components.length} old components, ${customData.filter((cd) => cd.isRoot).length} custom data types, ${(theme.pages || []).length} pages`);
|
|
566
596
|
parts.push("");
|
|
567
597
|
parts.push(`> ## READ THIS FIRST`);
|
|
568
598
|
parts.push(`>`);
|
|
@@ -652,16 +682,22 @@ function generateMigrationPlan(theme, projectName, oldSourceDir) {
|
|
|
652
682
|
const cdType = cd.type || "?";
|
|
653
683
|
let shape = "";
|
|
654
684
|
if (cd.type === "ENUM") {
|
|
655
|
-
const opts = (cd.enumOptions || [])
|
|
685
|
+
const opts = (cd.enumOptions || [])
|
|
686
|
+
.map((o) => o.value || o.displayName)
|
|
687
|
+
.filter(Boolean);
|
|
656
688
|
shape = ` — shape: \`enum {${opts.slice(0, 6).join(", ")}${opts.length > 6 ? ", ..." : ""}}\``;
|
|
657
689
|
}
|
|
658
690
|
else if (cd.nestedData && cd.nestedData.length > 0) {
|
|
659
691
|
const first = cd.nestedData[0];
|
|
660
|
-
const fields = (first?.nestedData || cd.nestedData || [])
|
|
692
|
+
const fields = (first?.nestedData || cd.nestedData || [])
|
|
693
|
+
.map((f) => `${f.key || f.name || "?"}: ${f.type || "?"}`)
|
|
694
|
+
.slice(0, 8);
|
|
661
695
|
shape = ` — shape: \`{${fields.join(", ")}}\``;
|
|
662
696
|
}
|
|
663
697
|
const usedBy = cd.id ? usageByCustomDataId.get(cd.id) || [] : [];
|
|
664
|
-
const usedByStr = usedBy.length > 0
|
|
698
|
+
const usedByStr = usedBy.length > 0
|
|
699
|
+
? ` — used by: ${usedBy.slice(0, 6).join(", ")}${usedBy.length > 6 ? `, +${usedBy.length - 6} more` : ""}`
|
|
700
|
+
: ` — _not directly referenced by any section's props (may be nested inside another customData)_`;
|
|
665
701
|
parts.push(`- \`${cdName}\` (${cdType})${shape}${usedByStr}`);
|
|
666
702
|
}
|
|
667
703
|
parts.push("");
|
|
@@ -695,7 +731,11 @@ function generateMigrationPlan(theme, projectName, oldSourceDir) {
|
|
|
695
731
|
const oldName = comp.displayName || comp.dir || comp.id || "Unknown";
|
|
696
732
|
const kebabName = toKebabCase(comp.dir || comp.displayName || comp.id || "unknown");
|
|
697
733
|
const newId = `${projectName}-${kebabName}`;
|
|
698
|
-
const headerFooter = comp.isHeader
|
|
734
|
+
const headerFooter = comp.isHeader
|
|
735
|
+
? " **[HEADER]**"
|
|
736
|
+
: comp.isFooter
|
|
737
|
+
? " **[FOOTER]**"
|
|
738
|
+
: "";
|
|
699
739
|
const propCount = (comp.props || []).length;
|
|
700
740
|
// Detect children from CUSTOM DYNAMIC_LIST props
|
|
701
741
|
const children = [];
|
|
@@ -705,8 +745,13 @@ function generateMigrationPlan(theme, projectName, oldSourceDir) {
|
|
|
705
745
|
if (cd && (cd.type === "DYNAMIC_LIST" || cd.type === "STATIC_LIST")) {
|
|
706
746
|
const itemObj = cd.nestedData?.[0];
|
|
707
747
|
if (itemObj) {
|
|
708
|
-
const childName = itemObj.typescriptName ||
|
|
709
|
-
|
|
748
|
+
const childName = itemObj.typescriptName ||
|
|
749
|
+
(itemObj.name
|
|
750
|
+
? itemObj.name.replace(/[^a-zA-Z0-9]/g, "")
|
|
751
|
+
: `${oldName}Item`);
|
|
752
|
+
const fields = (itemObj.nestedData || [])
|
|
753
|
+
.map((f) => f.key || f.name || "?")
|
|
754
|
+
.slice(0, 8);
|
|
710
755
|
children.push({ propName: p.name || "?", childName, fields });
|
|
711
756
|
}
|
|
712
757
|
}
|
|
@@ -765,11 +810,25 @@ function generateMigrationPlan(theme, projectName, oldSourceDir) {
|
|
|
765
810
|
}
|
|
766
811
|
// Known libraries we detect in old themes and want to flag for replacement
|
|
767
812
|
const KNOWN_LIBRARIES = [
|
|
768
|
-
"swiper",
|
|
769
|
-
"react
|
|
770
|
-
"react
|
|
771
|
-
"
|
|
772
|
-
"
|
|
813
|
+
"swiper",
|
|
814
|
+
"@headlessui/react",
|
|
815
|
+
"@heroicons/react",
|
|
816
|
+
"recharts",
|
|
817
|
+
"react-player",
|
|
818
|
+
"react-simple-star-rating",
|
|
819
|
+
"react-slider",
|
|
820
|
+
"react-compound-slider",
|
|
821
|
+
"react-zoom-pan-pinch",
|
|
822
|
+
"react-hot-toast",
|
|
823
|
+
"react-fast-marquee",
|
|
824
|
+
"react-indiana-drag-scroll",
|
|
825
|
+
"react-simple-typewriter",
|
|
826
|
+
"react-timer-hook",
|
|
827
|
+
"date-fns",
|
|
828
|
+
"slugify",
|
|
829
|
+
"classnames",
|
|
830
|
+
"clsx",
|
|
831
|
+
"@react-pdf/renderer",
|
|
773
832
|
];
|
|
774
833
|
// Heuristic: member-access patterns on old storefront stores/singletons that likely need new-system equivalents
|
|
775
834
|
const OLD_STOREFRONT_CALL_REGEX = /\b(customerStore|cartStore|productStore|categoryStore|orderStore|searchStore|favoritesStore|i18nStore|Router|useStore)\.\w+/g;
|
|
@@ -788,7 +847,8 @@ function scanSectionSource(componentDir, propNames) {
|
|
|
788
847
|
// Collect all .tsx/.ts files in the component dir
|
|
789
848
|
try {
|
|
790
849
|
for (const entry of fs.readdirSync(componentDir, { withFileTypes: true })) {
|
|
791
|
-
if (entry.isFile() &&
|
|
850
|
+
if (entry.isFile() &&
|
|
851
|
+
(entry.name.endsWith(".tsx") || entry.name.endsWith(".ts"))) {
|
|
792
852
|
result.sourceFiles.push(path.join(componentDir, entry.name));
|
|
793
853
|
}
|
|
794
854
|
}
|
|
@@ -805,7 +865,18 @@ function scanSectionSource(componentDir, propNames) {
|
|
|
805
865
|
const subCompSet = new Map();
|
|
806
866
|
const callSet = new Set();
|
|
807
867
|
// Packages we treat as "framework" and don't flag for replacement (but do note in reactPackageUsage)
|
|
808
|
-
const REACT_PACKAGES = new Set([
|
|
868
|
+
const REACT_PACKAGES = new Set([
|
|
869
|
+
"react",
|
|
870
|
+
"react-dom",
|
|
871
|
+
"next",
|
|
872
|
+
"next/link",
|
|
873
|
+
"next/image",
|
|
874
|
+
"next/router",
|
|
875
|
+
"next/head",
|
|
876
|
+
"next/script",
|
|
877
|
+
"mobx-react-lite",
|
|
878
|
+
"mobx",
|
|
879
|
+
]);
|
|
809
880
|
for (const file of result.sourceFiles) {
|
|
810
881
|
let content;
|
|
811
882
|
try {
|
|
@@ -819,7 +890,7 @@ function scanSectionSource(componentDir, propNames) {
|
|
|
819
890
|
while ((m = importRegex.exec(content)) !== null) {
|
|
820
891
|
const p = m[1];
|
|
821
892
|
if (p.startsWith(".")) {
|
|
822
|
-
const segs = p.split("/").filter(s => s && s !== "." && s !== "..");
|
|
893
|
+
const segs = p.split("/").filter((s) => s && s !== "." && s !== "..");
|
|
823
894
|
const last = segs[segs.length - 1];
|
|
824
895
|
if (last && /^[A-Z]/.test(last) && !last.includes("__generated__")) {
|
|
825
896
|
subCompSet.set(last, p);
|
|
@@ -827,7 +898,9 @@ function scanSectionSource(componentDir, propNames) {
|
|
|
827
898
|
}
|
|
828
899
|
else if (!p.startsWith("@ikas/")) {
|
|
829
900
|
// Classify: known library, react-family, or unknown-external
|
|
830
|
-
const base = p.startsWith("@")
|
|
901
|
+
const base = p.startsWith("@")
|
|
902
|
+
? p.split("/").slice(0, 2).join("/")
|
|
903
|
+
: p.split("/")[0];
|
|
831
904
|
if (REACT_PACKAGES.has(p) || REACT_PACKAGES.has(base)) {
|
|
832
905
|
reactSet.add(base);
|
|
833
906
|
}
|
|
@@ -890,7 +963,10 @@ function scanSectionSource(componentDir, propNames) {
|
|
|
890
963
|
}
|
|
891
964
|
}
|
|
892
965
|
}
|
|
893
|
-
result.importedSubComponents = [...subCompSet.entries()].map(([name, p]) => ({
|
|
966
|
+
result.importedSubComponents = [...subCompSet.entries()].map(([name, p]) => ({
|
|
967
|
+
name,
|
|
968
|
+
path: p,
|
|
969
|
+
}));
|
|
894
970
|
result.importedLibraries = [...libSet].sort();
|
|
895
971
|
result.importedUnknownLibraries = [...unknownLibSet].sort();
|
|
896
972
|
result.reactPackageUsage = [...reactSet].sort();
|
|
@@ -906,27 +982,38 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
906
982
|
customDataMap.set(cd.id, cd);
|
|
907
983
|
}
|
|
908
984
|
// Find the component — try match by dir, displayName, id, or new-id
|
|
909
|
-
const target = components.find(c => {
|
|
985
|
+
const target = components.find((c) => {
|
|
910
986
|
if (!c)
|
|
911
987
|
return false;
|
|
912
|
-
if (c.dir === sectionName ||
|
|
988
|
+
if (c.dir === sectionName ||
|
|
989
|
+
c.displayName === sectionName ||
|
|
990
|
+
c.id === sectionName)
|
|
913
991
|
return true;
|
|
914
992
|
const kebab = toKebabCase(c.dir || c.displayName || c.id || "");
|
|
915
993
|
const newId = `${projectName}-${kebab}`;
|
|
916
994
|
return newId === sectionName;
|
|
917
995
|
});
|
|
918
996
|
if (!target) {
|
|
919
|
-
const available = components
|
|
997
|
+
const available = components
|
|
998
|
+
.map((c) => c.dir || c.displayName || c.id)
|
|
999
|
+
.filter(Boolean)
|
|
1000
|
+
.join(", ");
|
|
920
1001
|
return `Section "${sectionName}" not found in theme. Available: ${available}`;
|
|
921
1002
|
}
|
|
922
1003
|
const parts = [];
|
|
923
1004
|
const oldName = target.displayName || target.dir || target.id || "Unknown";
|
|
924
1005
|
const kebabName = toKebabCase(target.dir || target.displayName || target.id || "unknown");
|
|
925
1006
|
const sectionId = `${projectName}-${kebabName}`;
|
|
926
|
-
const sectionPascal = (target.dir || target.displayName || "").replace(/[^a-zA-Z0-9]/g, "") ||
|
|
1007
|
+
const sectionPascal = (target.dir || target.displayName || "").replace(/[^a-zA-Z0-9]/g, "") ||
|
|
1008
|
+
kebabName
|
|
1009
|
+
.split("-")
|
|
1010
|
+
.map((s) => s[0]?.toUpperCase() + s.slice(1))
|
|
1011
|
+
.join("");
|
|
927
1012
|
// Scan the old source for imports, libraries, field usage
|
|
928
|
-
const propNames = (target.props || [])
|
|
929
|
-
|
|
1013
|
+
const propNames = (target.props || [])
|
|
1014
|
+
.map((p) => p.name || "")
|
|
1015
|
+
.filter(Boolean);
|
|
1016
|
+
const sourceScan = oldSourceDir && target.dir
|
|
930
1017
|
? scanSectionSource(path.join(oldSourceDir, target.dir), propNames)
|
|
931
1018
|
: null;
|
|
932
1019
|
parts.push(`# Section Migration Plan: ${oldName}`);
|
|
@@ -972,7 +1059,7 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
972
1059
|
}
|
|
973
1060
|
if (sourceScan.reactPackageUsage.length > 0) {
|
|
974
1061
|
parts.push("");
|
|
975
|
-
parts.push(`**React/Next.js framework imports detected:** ${sourceScan.reactPackageUsage.map(p => `\`${p}\``).join(", ")}. These do NOT carry over — the new system is Preact. See \`get_migration_guide("react-to-preact")\` for conversion patterns (hooks, observer, event types, routing).`);
|
|
1062
|
+
parts.push(`**React/Next.js framework imports detected:** ${sourceScan.reactPackageUsage.map((p) => `\`${p}\``).join(", ")}. These do NOT carry over — the new system is Preact. See \`get_migration_guide("react-to-preact")\` for conversion patterns (hooks, observer, event types, routing).`);
|
|
976
1063
|
}
|
|
977
1064
|
if (sourceScan.oldStorefrontCalls.length > 0) {
|
|
978
1065
|
parts.push("");
|
|
@@ -1018,7 +1105,11 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1018
1105
|
if (oldType === "SLIDER") {
|
|
1019
1106
|
newType = "NUMBER";
|
|
1020
1107
|
notes = `Was SLIDER(min=${p.sliderData?.min}, max=${p.sliderData?.max}) — replace \`.value\` access with direct number`;
|
|
1021
|
-
const prop = {
|
|
1108
|
+
const prop = {
|
|
1109
|
+
name: newName,
|
|
1110
|
+
displayName: p.displayName || newName,
|
|
1111
|
+
type: "NUMBER",
|
|
1112
|
+
};
|
|
1022
1113
|
if (p.isRequired)
|
|
1023
1114
|
prop.required = true;
|
|
1024
1115
|
parentPropsJson.push(prop);
|
|
@@ -1026,7 +1117,11 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1026
1117
|
else if (oldType === "PRODUCT_DETAIL") {
|
|
1027
1118
|
newType = "PRODUCT";
|
|
1028
1119
|
notes = "Renamed — PRODUCT_DETAIL → PRODUCT";
|
|
1029
|
-
const prop = {
|
|
1120
|
+
const prop = {
|
|
1121
|
+
name: newName,
|
|
1122
|
+
displayName: p.displayName || newName,
|
|
1123
|
+
type: "PRODUCT",
|
|
1124
|
+
};
|
|
1030
1125
|
if (p.isRequired)
|
|
1031
1126
|
prop.required = true;
|
|
1032
1127
|
parentPropsJson.push(prop);
|
|
@@ -1037,7 +1132,10 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1037
1132
|
if (cd.type === "DYNAMIC_LIST" || cd.type === "STATIC_LIST") {
|
|
1038
1133
|
// Child component needed
|
|
1039
1134
|
const itemObj = cd.nestedData?.[0];
|
|
1040
|
-
const childName = itemObj?.typescriptName ||
|
|
1135
|
+
const childName = itemObj?.typescriptName ||
|
|
1136
|
+
(itemObj?.name
|
|
1137
|
+
? itemObj.name.replace(/[^a-zA-Z0-9]/g, "")
|
|
1138
|
+
: `${sectionPascal}Item`);
|
|
1041
1139
|
const childProps = [];
|
|
1042
1140
|
const nestedWarnings = [];
|
|
1043
1141
|
for (const f of (itemObj?.nestedData || [])) {
|
|
@@ -1048,11 +1146,18 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1048
1146
|
fType = "NUMBER";
|
|
1049
1147
|
else if (fType === "PRODUCT_DETAIL")
|
|
1050
1148
|
fType = "PRODUCT";
|
|
1051
|
-
else if (fType === "CUSTOM" ||
|
|
1149
|
+
else if (fType === "CUSTOM" ||
|
|
1150
|
+
fType === "DYNAMIC_LIST" ||
|
|
1151
|
+
fType === "STATIC_LIST" ||
|
|
1152
|
+
fType === "OBJECT") {
|
|
1052
1153
|
nestedWarnings.push(`\`${f.key}\` (${fType})`);
|
|
1053
1154
|
fType = "COMPONENT_LIST";
|
|
1054
1155
|
}
|
|
1055
|
-
const prop = {
|
|
1156
|
+
const prop = {
|
|
1157
|
+
name: f.key,
|
|
1158
|
+
displayName: f.name || f.key,
|
|
1159
|
+
type: fType,
|
|
1160
|
+
};
|
|
1056
1161
|
if (f.isRequired)
|
|
1057
1162
|
prop.required = true;
|
|
1058
1163
|
childProps.push(prop);
|
|
@@ -1064,10 +1169,14 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1064
1169
|
if (childProps.length === 0 && sourceScan?.propFieldUsage[oldName]) {
|
|
1065
1170
|
const inferred = sourceScan.propFieldUsage[oldName];
|
|
1066
1171
|
for (const fieldName of inferred) {
|
|
1067
|
-
childProps.push({
|
|
1172
|
+
childProps.push({
|
|
1173
|
+
name: fieldName,
|
|
1174
|
+
displayName: fieldName,
|
|
1175
|
+
type: "TEXT",
|
|
1176
|
+
});
|
|
1068
1177
|
}
|
|
1069
1178
|
if (inferred.length > 0) {
|
|
1070
|
-
notes = `Was CUSTOM → ${cd.type} with empty customData. **Inferred props from source usage:** ${inferred.map(f => `\`${f}\``).join(", ")}. Verify types and required flags — default inferred type is TEXT.`;
|
|
1179
|
+
notes = `Was CUSTOM → ${cd.type} with empty customData. **Inferred props from source usage:** ${inferred.map((f) => `\`${f}\``).join(", ")}. Verify types and required flags — default inferred type is TEXT.`;
|
|
1071
1180
|
}
|
|
1072
1181
|
}
|
|
1073
1182
|
children.push({
|
|
@@ -1096,7 +1205,11 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1096
1205
|
let fType = f.type;
|
|
1097
1206
|
if (fType === "SLIDER")
|
|
1098
1207
|
fType = "NUMBER";
|
|
1099
|
-
const prop = {
|
|
1208
|
+
const prop = {
|
|
1209
|
+
name: f.key,
|
|
1210
|
+
displayName: f.name || f.key,
|
|
1211
|
+
type: fType,
|
|
1212
|
+
};
|
|
1100
1213
|
if (f.isRequired)
|
|
1101
1214
|
prop.required = true;
|
|
1102
1215
|
parentPropsJson.push(prop);
|
|
@@ -1111,7 +1224,8 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1111
1224
|
}
|
|
1112
1225
|
else if (cd.type === "ENUM") {
|
|
1113
1226
|
newType = "ENUM";
|
|
1114
|
-
const enumName = cd.typescriptName ||
|
|
1227
|
+
const enumName = cd.typescriptName ||
|
|
1228
|
+
(cd.name ? cd.name.replace(/[^a-zA-Z0-9]/g, "") : "Enum");
|
|
1115
1229
|
const options = (cd.enumOptions || []).reduce((acc, o) => {
|
|
1116
1230
|
if (o.displayName && o.value)
|
|
1117
1231
|
acc[o.displayName] = o.value;
|
|
@@ -1119,7 +1233,12 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1119
1233
|
}, {});
|
|
1120
1234
|
enumsNeeded.push({ name: enumName, options });
|
|
1121
1235
|
notes = `Was CUSTOM (ENUM) — create enum \`${enumName}\` via \`config add-enum\` first, then reference its enumId here`;
|
|
1122
|
-
const prop = {
|
|
1236
|
+
const prop = {
|
|
1237
|
+
name: newName,
|
|
1238
|
+
displayName: p.displayName || newName,
|
|
1239
|
+
type: "ENUM",
|
|
1240
|
+
enumTypeId: `<ENUM_ID_FROM_add-enum_${enumName}>`,
|
|
1241
|
+
};
|
|
1123
1242
|
if (p.isRequired)
|
|
1124
1243
|
prop.required = true;
|
|
1125
1244
|
parentPropsJson.push(prop);
|
|
@@ -1128,7 +1247,11 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1128
1247
|
}
|
|
1129
1248
|
else {
|
|
1130
1249
|
// Direct mapping
|
|
1131
|
-
const prop = {
|
|
1250
|
+
const prop = {
|
|
1251
|
+
name: newName,
|
|
1252
|
+
displayName: p.displayName || newName,
|
|
1253
|
+
type: newType,
|
|
1254
|
+
};
|
|
1132
1255
|
if (p.isRequired)
|
|
1133
1256
|
prop.required = true;
|
|
1134
1257
|
parentPropsJson.push(prop);
|
|
@@ -1137,7 +1260,9 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1137
1260
|
}
|
|
1138
1261
|
parts.push("");
|
|
1139
1262
|
// Custom Data Decision Callouts — per prop referencing a customData type
|
|
1140
|
-
const customDataPropsForCallouts = (target.props || []).filter((p) => p.type === "CUSTOM" &&
|
|
1263
|
+
const customDataPropsForCallouts = (target.props || []).filter((p) => p.type === "CUSTOM" &&
|
|
1264
|
+
p.customDataId &&
|
|
1265
|
+
customDataMap.has(p.customDataId));
|
|
1141
1266
|
if (customDataPropsForCallouts.length > 0) {
|
|
1142
1267
|
parts.push(`## Custom Data Decisions to Make`);
|
|
1143
1268
|
parts.push("");
|
|
@@ -1152,7 +1277,9 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1152
1277
|
let shape = "";
|
|
1153
1278
|
let shapeKind = "unknown";
|
|
1154
1279
|
if (cd.type === "ENUM") {
|
|
1155
|
-
const opts = (cd.enumOptions || [])
|
|
1280
|
+
const opts = (cd.enumOptions || [])
|
|
1281
|
+
.map((o) => o.value || o.displayName)
|
|
1282
|
+
.filter(Boolean);
|
|
1156
1283
|
shape = `enum {${opts.slice(0, 6).join(", ")}${opts.length > 6 ? ", ..." : ""}}`;
|
|
1157
1284
|
shapeKind = "enum";
|
|
1158
1285
|
}
|
|
@@ -1185,7 +1312,8 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1185
1312
|
if (shapeKind === "enum") {
|
|
1186
1313
|
parts.push(`**Default: enum prop.** Flat scalar set; use \`config add-enum\`.`);
|
|
1187
1314
|
parts.push("");
|
|
1188
|
-
const enumName = cd.typescriptName ||
|
|
1315
|
+
const enumName = cd.typescriptName ||
|
|
1316
|
+
(cd.name ? cd.name.replace(/[^a-zA-Z0-9]/g, "") : "Enum");
|
|
1189
1317
|
const enumOptions = (cd.enumOptions || []).reduce((acc, o) => {
|
|
1190
1318
|
if (o.displayName && o.value)
|
|
1191
1319
|
acc[o.displayName] = o.value;
|
|
@@ -1220,7 +1348,10 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1220
1348
|
parts.push(`> See \`get_migration_guide("component-composition-decision-guide")\` for when \`COMPONENT_LIST\` is overkill.`);
|
|
1221
1349
|
parts.push("");
|
|
1222
1350
|
}
|
|
1223
|
-
const compName = cd.typescriptName ||
|
|
1351
|
+
const compName = cd.typescriptName ||
|
|
1352
|
+
(cd.name
|
|
1353
|
+
? cd.name.replace(/[^a-zA-Z0-9]/g, "")
|
|
1354
|
+
: `${sectionPascal}Item`);
|
|
1224
1355
|
const compPropsForCli = [];
|
|
1225
1356
|
for (const f of fieldSource) {
|
|
1226
1357
|
if (!f.key)
|
|
@@ -1230,7 +1361,11 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1230
1361
|
fType = "NUMBER";
|
|
1231
1362
|
else if (fType === "PRODUCT_DETAIL")
|
|
1232
1363
|
fType = "PRODUCT";
|
|
1233
|
-
compPropsForCli.push({
|
|
1364
|
+
compPropsForCli.push({
|
|
1365
|
+
name: f.key,
|
|
1366
|
+
displayName: f.name || f.key,
|
|
1367
|
+
type: fType,
|
|
1368
|
+
});
|
|
1234
1369
|
}
|
|
1235
1370
|
parts.push("```bash");
|
|
1236
1371
|
if (isMinimal) {
|
|
@@ -1269,7 +1404,10 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1269
1404
|
existing.usedByProps.push(ch.propName);
|
|
1270
1405
|
}
|
|
1271
1406
|
else {
|
|
1272
|
-
uniqueChildren.set(ch.childName, {
|
|
1407
|
+
uniqueChildren.set(ch.childName, {
|
|
1408
|
+
child: ch,
|
|
1409
|
+
usedByProps: [ch.propName],
|
|
1410
|
+
});
|
|
1273
1411
|
}
|
|
1274
1412
|
}
|
|
1275
1413
|
if (uniqueChildren.size > 0) {
|
|
@@ -1282,7 +1420,7 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1282
1420
|
for (const { child: ch, usedByProps } of uniqueChildren.values()) {
|
|
1283
1421
|
parts.push(`### \`${ch.childName}\``);
|
|
1284
1422
|
const propsLabel = usedByProps.length > 1
|
|
1285
|
-
? `Used by parent props: ${usedByProps.map(p => `\`${p}\``).join(", ")} (${usedByProps.length}×)`
|
|
1423
|
+
? `Used by parent props: ${usedByProps.map((p) => `\`${p}\``).join(", ")} (${usedByProps.length}×)`
|
|
1286
1424
|
: `For parent prop: \`${usedByProps[0]}\``;
|
|
1287
1425
|
parts.push(propsLabel);
|
|
1288
1426
|
parts.push(`Old customData: "${ch.customDataName}"`);
|
|
@@ -1328,12 +1466,15 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1328
1466
|
parts.push(`- **Every COMPONENT_LIST slot needs a child component to render individual items.** A product list needs a ProductCard child, a blog list needs a BlogCard child, etc. Check if the child already exists (run \`config list\` to see all components and their opaque ids; reuse the existing id in \`filteredComponentIds\`). If not, create it as a registered component and use the \`componentId\` from the CLI's response.`);
|
|
1329
1467
|
}
|
|
1330
1468
|
// Check if the section itself has data-driven list props (PRODUCT_LIST, BLOG_LIST, CATEGORY_LIST)
|
|
1331
|
-
const dataListProps = (target.props || []).filter(p => p.type === "PRODUCT_LIST" ||
|
|
1469
|
+
const dataListProps = (target.props || []).filter((p) => p.type === "PRODUCT_LIST" ||
|
|
1470
|
+
p.type === "BLOG_LIST" ||
|
|
1471
|
+
p.type === "CATEGORY_LIST" ||
|
|
1472
|
+
p.type === "BRAND_LIST");
|
|
1332
1473
|
if (dataListProps.length > 0) {
|
|
1333
1474
|
parts.push("");
|
|
1334
1475
|
parts.push(`### Data-Driven List Rendering`);
|
|
1335
1476
|
parts.push("");
|
|
1336
|
-
parts.push(`This section has data-driven list props: ${dataListProps.map(p => `\`${p.name}\` (${p.type})`).join(", ")}.`);
|
|
1477
|
+
parts.push(`This section has data-driven list props: ${dataListProps.map((p) => `\`${p.name}\` (${p.type})`).join(", ")}.`);
|
|
1337
1478
|
parts.push(`These are NOT COMPONENT_LIST — the data comes from dynamic queries (filters, categories, search), not hand-picked items. Render items **internally** by mapping over the data:`);
|
|
1338
1479
|
parts.push("");
|
|
1339
1480
|
parts.push("```tsx");
|
|
@@ -1360,9 +1501,22 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1360
1501
|
parts.push(`See \`get_migration_guide("custom-data-conversion")\` → "Two Ways to Render Lists" for the full pattern.`);
|
|
1361
1502
|
}
|
|
1362
1503
|
// Detect form-page sections (0 or few props, name suggests a form/auth page)
|
|
1363
|
-
const formKeywords = [
|
|
1504
|
+
const formKeywords = [
|
|
1505
|
+
"login",
|
|
1506
|
+
"register",
|
|
1507
|
+
"forgot",
|
|
1508
|
+
"recover",
|
|
1509
|
+
"password",
|
|
1510
|
+
"account",
|
|
1511
|
+
"email",
|
|
1512
|
+
"verification",
|
|
1513
|
+
"activate",
|
|
1514
|
+
"contact",
|
|
1515
|
+
"checkout",
|
|
1516
|
+
"address",
|
|
1517
|
+
];
|
|
1364
1518
|
const lowerDir = (target.dir || "").toLowerCase();
|
|
1365
|
-
const isLikelyFormPage = formKeywords.some(kw => lowerDir.includes(kw));
|
|
1519
|
+
const isLikelyFormPage = formKeywords.some((kw) => lowerDir.includes(kw));
|
|
1366
1520
|
if (isLikelyFormPage) {
|
|
1367
1521
|
parts.push("");
|
|
1368
1522
|
parts.push(`### Form Page Pattern`);
|
|
@@ -1391,7 +1545,9 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1391
1545
|
// Fallback heuristic only when source scan unavailable
|
|
1392
1546
|
const heuristicLibs = [];
|
|
1393
1547
|
const lowerName = oldName.toLowerCase();
|
|
1394
|
-
if (lowerName.includes("slider") ||
|
|
1548
|
+
if (lowerName.includes("slider") ||
|
|
1549
|
+
lowerName.includes("carousel") ||
|
|
1550
|
+
lowerName.includes("banner")) {
|
|
1395
1551
|
heuristicLibs.push("swiper");
|
|
1396
1552
|
}
|
|
1397
1553
|
if (lowerName.includes("marquee"))
|
|
@@ -1400,7 +1556,9 @@ function generateSectionMigrationPlan(theme, sectionName, projectName, oldSource
|
|
|
1400
1556
|
heuristicLibs.push("react-player");
|
|
1401
1557
|
if (lowerName.includes("chart"))
|
|
1402
1558
|
heuristicLibs.push("recharts");
|
|
1403
|
-
if (lowerName.includes("star") ||
|
|
1559
|
+
if (lowerName.includes("star") ||
|
|
1560
|
+
lowerName.includes("rating") ||
|
|
1561
|
+
lowerName.includes("review"))
|
|
1404
1562
|
heuristicLibs.push("react-simple-star-rating");
|
|
1405
1563
|
if (heuristicLibs.length > 0) {
|
|
1406
1564
|
parts.push(`### Likely Library Replacements (heuristic — source not scanned)`);
|
|
@@ -1472,8 +1630,7 @@ function levenshtein(a, b) {
|
|
|
1472
1630
|
const cost = a.charCodeAt(i - 1) === b.charCodeAt(j - 1) ? 0 : 1;
|
|
1473
1631
|
curr[j] = Math.min(curr[j - 1] + 1, // insertion
|
|
1474
1632
|
prev[j] + 1, // deletion
|
|
1475
|
-
prev[j - 1] + cost
|
|
1476
|
-
);
|
|
1633
|
+
prev[j - 1] + cost);
|
|
1477
1634
|
}
|
|
1478
1635
|
for (let j = 0; j <= n; j++)
|
|
1479
1636
|
prev[j] = curr[j];
|
|
@@ -1504,17 +1661,29 @@ function searchFunctions(query) {
|
|
|
1504
1661
|
const scored = storefrontData.functions
|
|
1505
1662
|
.map((fn) => {
|
|
1506
1663
|
const nameScore = matchScore(fn.name, query) * 3;
|
|
1507
|
-
const displayNameScore = fn.displayName
|
|
1664
|
+
const displayNameScore = fn.displayName
|
|
1665
|
+
? matchScore(fn.displayName, query) * 3
|
|
1666
|
+
: 0;
|
|
1508
1667
|
const descScore = matchScore(fn.description, query);
|
|
1509
|
-
const catScore = fn.categories.some((c) => matchScore(c, query) > 0)
|
|
1668
|
+
const catScore = fn.categories.some((c) => matchScore(c, query) > 0)
|
|
1669
|
+
? 5
|
|
1670
|
+
: 0;
|
|
1510
1671
|
const paramScore = fn.params.some((p) => matchScore(p.name, query) > 0 || matchScore(p.description, query) > 0)
|
|
1511
1672
|
? 2
|
|
1512
1673
|
: 0;
|
|
1513
1674
|
const sigScore = matchScore(fn.signature, query) * 2;
|
|
1514
|
-
const typeScore = fn.parameterTypes?.some((t) => matchScore(t, query) > 0)
|
|
1675
|
+
const typeScore = fn.parameterTypes?.some((t) => matchScore(t, query) > 0)
|
|
1676
|
+
? 8
|
|
1677
|
+
: 0;
|
|
1515
1678
|
return {
|
|
1516
1679
|
fn,
|
|
1517
|
-
score: nameScore +
|
|
1680
|
+
score: nameScore +
|
|
1681
|
+
displayNameScore +
|
|
1682
|
+
descScore +
|
|
1683
|
+
catScore +
|
|
1684
|
+
paramScore +
|
|
1685
|
+
sigScore +
|
|
1686
|
+
typeScore,
|
|
1518
1687
|
};
|
|
1519
1688
|
})
|
|
1520
1689
|
.filter((item) => item.score > 0)
|
|
@@ -1528,7 +1697,11 @@ function searchFrameworkTopics(query) {
|
|
|
1528
1697
|
const descScore = matchScore(topic.description, query) * 2;
|
|
1529
1698
|
const contentScore = matchScore(topic.content, query);
|
|
1530
1699
|
const tagScore = topic.tags.some((t) => matchScore(t, query) > 0) ? 5 : 0;
|
|
1531
|
-
return {
|
|
1700
|
+
return {
|
|
1701
|
+
key,
|
|
1702
|
+
topic,
|
|
1703
|
+
score: titleScore + descScore + contentScore + tagScore,
|
|
1704
|
+
};
|
|
1532
1705
|
})
|
|
1533
1706
|
.filter((item) => item.score > 0)
|
|
1534
1707
|
.sort((a, b) => b.score - a.score);
|
|
@@ -1543,7 +1716,9 @@ function searchTypes(query) {
|
|
|
1543
1716
|
const propScore = td.properties?.some((p) => matchScore(p.name, query) > 0 || matchScore(p.type, query) > 0)
|
|
1544
1717
|
? 4
|
|
1545
1718
|
: 0;
|
|
1546
|
-
const enumScore = td.enumValues?.some((v) => matchScore(v, query) > 0)
|
|
1719
|
+
const enumScore = td.enumValues?.some((v) => matchScore(v, query) > 0)
|
|
1720
|
+
? 4
|
|
1721
|
+
: 0;
|
|
1547
1722
|
return { td, score: nameScore + domainScore + propScore + enumScore };
|
|
1548
1723
|
})
|
|
1549
1724
|
.filter((item) => item.score > 0)
|
|
@@ -1585,8 +1760,12 @@ function formatFunctionDoc(fn) {
|
|
|
1585
1760
|
return lines.join("\n");
|
|
1586
1761
|
}
|
|
1587
1762
|
function formatFunctionSummary(fn) {
|
|
1588
|
-
const desc = fn.description
|
|
1589
|
-
|
|
1763
|
+
const desc = fn.description
|
|
1764
|
+
? fn.description.split(".")[0] + "."
|
|
1765
|
+
: "No description.";
|
|
1766
|
+
const alias = fn.displayName && fn.displayName !== fn.name
|
|
1767
|
+
? ` (alias: ${fn.displayName})`
|
|
1768
|
+
: "";
|
|
1590
1769
|
return `- \`${fn.name}\`${alias} - ${desc}`;
|
|
1591
1770
|
}
|
|
1592
1771
|
function formatTypeDefinition(td, opts = {}) {
|
|
@@ -1627,7 +1806,9 @@ function formatTypeDefinition(td, opts = {}) {
|
|
|
1627
1806
|
const fn = storefrontData.functions.find((f) => f.name === fnName);
|
|
1628
1807
|
if (fn) {
|
|
1629
1808
|
const desc = fn.description ? fn.description.split(".")[0] + "." : "";
|
|
1630
|
-
const alias = fn.displayName && fn.displayName !== fn.name
|
|
1809
|
+
const alias = fn.displayName && fn.displayName !== fn.name
|
|
1810
|
+
? ` (alias: ${fn.displayName})`
|
|
1811
|
+
: "";
|
|
1631
1812
|
lines.push(`- **\`${fn.name}\`**${alias} — ${desc}`);
|
|
1632
1813
|
lines.push(` \`${fn.signature}\``);
|
|
1633
1814
|
}
|
|
@@ -1636,7 +1817,9 @@ function formatTypeDefinition(td, opts = {}) {
|
|
|
1636
1817
|
}
|
|
1637
1818
|
}
|
|
1638
1819
|
lines.push("");
|
|
1639
|
-
lines.push(
|
|
1820
|
+
lines.push('Use `get_functions_for_type("' +
|
|
1821
|
+
td.name +
|
|
1822
|
+
'")` for full documentation of these functions.');
|
|
1640
1823
|
}
|
|
1641
1824
|
return lines.join("\n");
|
|
1642
1825
|
}
|
|
@@ -1654,7 +1837,13 @@ const server = new McpServer({
|
|
|
1654
1837
|
name: "ikas-code-components",
|
|
1655
1838
|
version: "0.1.0",
|
|
1656
1839
|
}, {
|
|
1657
|
-
instructions: "Examples and section templates from this server are API reference only — reuse imports, function calls, and data-access patterns; create your own JSX structure, CSS class names, and visual design
|
|
1840
|
+
instructions: "Examples and section templates from this server are API reference only — reuse imports, function calls, and data-access patterns; create your own JSX structure, CSS class names, and visual design.\n\n" +
|
|
1841
|
+
"Live-editor actions (require `ikas-component dev` running with the editor connected): `list_editor_pages` → page ids; `list_imported_sections` → imported component ids; `import_section` → import a built component; `add_section_to_page` → place one section (`add_sections_to_page` places MANY at once and can set their props in the same call — fastest way to build a page); `list_page_sections` → the sections placed on a page (LEAN roster: per-placement `elementId`, `componentId`, `propCount`, which props are filled — NO schema/values, so it never truncates); `get_component_props` → a component's prop blueprint (types, ENUM valid `options`, COMPONENT_LIST `allowedComponentIds`) for any section OR child id; `get_section_values` → one section's current prop values (for read-modify-write); `get_page_by_type` → a theme page id by pageType (e.g. CATEGORY), to build PAGE links to entities (`create_page` adds that page if it does not exist yet, so you never guess a slug); `update_section_prop` → change a single prop value of a placed section (`update_page_sections` fills MANY sections/props of a page in ONE call — strongly prefer it to cut round-trips when filling content); `upload_image` → upload one image (file or URL) and get an image id (`upload_images` uploads many in one call — prefer it for several); `search_products` / `list_categories` / `list_brands` / `list_blogs` / `list_blog_categories` → find real entity ids for PRODUCT/CATEGORY/BRAND/BLOG/BLOG_CATEGORY prop values; `publish_theme` → publish the theme LIVE and get back the preview URL to review (guarded — needs `confirm:true`, and `confirm_production:true` for the main theme; only call it when the user explicitly asks to publish). For the full end-to-end process (placing a section and filling its content, with per-prop value shapes and COMPONENT_LIST rules), call `get_editor_workflow` first.\n\n" +
|
|
1842
|
+
"To CHANGE/EDIT a prop value (text, color, boolean, number, etc.) of a section that is already on a page, this IS supported: call `list_page_sections(page_id)` to get the placement `elementId` and the prop names/ids, then `update_section_prop(page_id, element_id, prop_name|prop_id, value)`. Do not assume prop editing is unavailable.\n\n" +
|
|
1843
|
+
"TWO DISTINCT JOBS — do not confuse them, and do not jump to writing code for the second one:\n" +
|
|
1844
|
+
"(A) DEFINING props / authoring a component = changing which props a component HAS. This edits the component source/config (types.ts via `ikas-component config add-prop`/`add-component`, JSX in index.tsx, etc.) and requires a rebuild. Use this ONLY when the needed prop does not exist yet, or the user explicitly asks to build/modify the component's code or prop schema.\n" +
|
|
1845
|
+
"(B) SETTING prop VALUES / filling content = giving values to props that ALREADY exist on a section placed on a page. This is pure data entry via `list_page_sections` + `update_section_prop` (and `upload_image` for images). It writes NO code and needs NO rebuild.\n" +
|
|
1846
|
+
"When the user says things like 'fill this section', 'set the heading/title/text/image/link', 'populate', 'change the content/value', or 'enter this data', that is JOB (B): use `update_section_prop`. First call `list_page_sections` and check the existing `props` — if the prop is already there (it usually is), just set its value. Only fall back to JOB (A) if the required prop genuinely does not exist in that section's `props`. Writing a new component or adding a prop to fill in a value the section already supports is the wrong move.",
|
|
1658
1847
|
});
|
|
1659
1848
|
// Tool: search_docs
|
|
1660
1849
|
server.tool("search_docs", "Search across all ikas storefront API docs, framework guides, and migration guides. Returns matching functions, framework topics, and migration topics ranked by relevance.", { query: z.string().describe("Search keyword or phrase") }, async ({ query }) => {
|
|
@@ -1695,13 +1884,20 @@ server.tool("search_docs", "Search across all ikas storefront API docs, framewor
|
|
|
1695
1884
|
parts.push("");
|
|
1696
1885
|
parts.push("Use `get_migration_guide(topic)` to get full content for any migration topic.");
|
|
1697
1886
|
}
|
|
1698
|
-
if (functions.length === 0 &&
|
|
1887
|
+
if (functions.length === 0 &&
|
|
1888
|
+
topics.length === 0 &&
|
|
1889
|
+
types.length === 0 &&
|
|
1890
|
+
migrationTopics.length === 0) {
|
|
1699
1891
|
parts.push(`No results found for "${query}". Try different keywords or use \`list_functions()\` to see all available functions.`);
|
|
1700
1892
|
}
|
|
1701
1893
|
return { content: [{ type: "text", text: parts.join("\n") }] };
|
|
1702
1894
|
});
|
|
1703
1895
|
// Tool: get_function_doc
|
|
1704
|
-
server.tool("get_function_doc", "Get full documentation for a specific storefront API function including signature, parameters, return type, and example.", {
|
|
1896
|
+
server.tool("get_function_doc", "Get full documentation for a specific storefront API function including signature, parameters, return type, and example.", {
|
|
1897
|
+
name: z
|
|
1898
|
+
.string()
|
|
1899
|
+
.describe("Function name (e.g. 'addItemToCart', 'Router.navigate')"),
|
|
1900
|
+
}, async ({ name }) => {
|
|
1705
1901
|
const nameLower = name.toLowerCase();
|
|
1706
1902
|
// Phase 1: canonical-name match wins. A real function name always outranks
|
|
1707
1903
|
// any displayName alias so aliases can never shadow the function they're
|
|
@@ -1709,7 +1905,9 @@ server.tool("get_function_doc", "Get full documentation for a specific storefron
|
|
|
1709
1905
|
// [BP-DISPLAY-NAME: hasCustomer] alias).
|
|
1710
1906
|
const byName = storefrontData.functions.find((f) => f.name.toLowerCase() === nameLower);
|
|
1711
1907
|
if (byName) {
|
|
1712
|
-
return {
|
|
1908
|
+
return {
|
|
1909
|
+
content: [{ type: "text", text: formatFunctionDoc(byName) }],
|
|
1910
|
+
};
|
|
1713
1911
|
}
|
|
1714
1912
|
// Phase 2: fall back to displayName aliases.
|
|
1715
1913
|
const byAlias = storefrontData.functions.filter((f) => f.displayName && f.displayName.toLowerCase() === nameLower);
|
|
@@ -1717,7 +1915,9 @@ server.tool("get_function_doc", "Get full documentation for a specific storefron
|
|
|
1717
1915
|
const fn = byAlias[0];
|
|
1718
1916
|
const note = `> Note: "${name}" is a display alias for \`${fn.name}\`.\n\n`;
|
|
1719
1917
|
return {
|
|
1720
|
-
content: [
|
|
1918
|
+
content: [
|
|
1919
|
+
{ type: "text", text: note + formatFunctionDoc(fn) },
|
|
1920
|
+
],
|
|
1721
1921
|
};
|
|
1722
1922
|
}
|
|
1723
1923
|
if (byAlias.length > 1) {
|
|
@@ -1735,7 +1935,9 @@ server.tool("get_function_doc", "Get full documentation for a specific storefron
|
|
|
1735
1935
|
(f.displayName && f.displayName.toLowerCase().includes(nameLower)));
|
|
1736
1936
|
if (matches.length > 0) {
|
|
1737
1937
|
const suggestions = matches.slice(0, 5).map((f) => {
|
|
1738
|
-
const alias = f.displayName && f.displayName !== f.name
|
|
1938
|
+
const alias = f.displayName && f.displayName !== f.name
|
|
1939
|
+
? ` (alias: ${f.displayName})`
|
|
1940
|
+
: "";
|
|
1739
1941
|
return ` - ${f.name}${alias}`;
|
|
1740
1942
|
});
|
|
1741
1943
|
return {
|
|
@@ -1748,7 +1950,12 @@ server.tool("get_function_doc", "Get full documentation for a specific storefron
|
|
|
1748
1950
|
};
|
|
1749
1951
|
}
|
|
1750
1952
|
return {
|
|
1751
|
-
content: [
|
|
1953
|
+
content: [
|
|
1954
|
+
{
|
|
1955
|
+
type: "text",
|
|
1956
|
+
text: `Function "${name}" not found. Use \`list_functions()\` to see all available functions.`,
|
|
1957
|
+
},
|
|
1958
|
+
],
|
|
1752
1959
|
};
|
|
1753
1960
|
});
|
|
1754
1961
|
// Tool: list_functions
|
|
@@ -1798,7 +2005,7 @@ server.tool("list_functions", "List storefront API functions. Without a `categor
|
|
|
1798
2005
|
if (uncategorized > 0) {
|
|
1799
2006
|
lines.push(`- \`Other\` (${uncategorized})`);
|
|
1800
2007
|
}
|
|
1801
|
-
lines.push("",
|
|
2008
|
+
lines.push("", 'Call `list_functions(category: "<name>")` to see one-line summaries for a category.');
|
|
1802
2009
|
return { content: [{ type: "text", text: lines.join("\n") }] };
|
|
1803
2010
|
}
|
|
1804
2011
|
const catLower = category.toLowerCase();
|
|
@@ -1830,7 +2037,11 @@ server.tool("list_functions", "List storefront API functions. Without a `categor
|
|
|
1830
2037
|
return { content: [{ type: "text", text: parts.join("\n") }] };
|
|
1831
2038
|
});
|
|
1832
2039
|
// Tool: get_code_example
|
|
1833
|
-
server.tool("get_code_example", "Get an API usage reference for a specific task. Shows correct function calls, imports, and data-handling patterns from a real production theme. The JSX layout and CSS are illustrative only — create your own original visual design. Call `list_examples()` to see available example IDs.", {
|
|
2040
|
+
server.tool("get_code_example", "Get an API usage reference for a specific task. Shows correct function calls, imports, and data-handling patterns from a real production theme. The JSX layout and CSS are illustrative only — create your own original visual design. Call `list_examples()` to see available example IDs.", {
|
|
2041
|
+
task: z
|
|
2042
|
+
.string()
|
|
2043
|
+
.describe("Task description or example ID (call `list_examples()` for the full list)"),
|
|
2044
|
+
}, async ({ task }) => {
|
|
1834
2045
|
const taskLower = task.toLowerCase();
|
|
1835
2046
|
// Try exact ID match first
|
|
1836
2047
|
let example = storefrontData.codeExamples.find((e) => e.id === taskLower);
|
|
@@ -1850,7 +2061,9 @@ server.tool("get_code_example", "Get an API usage reference for a specific task.
|
|
|
1850
2061
|
}
|
|
1851
2062
|
}
|
|
1852
2063
|
if (!example) {
|
|
1853
|
-
const available = storefrontData.codeExamples
|
|
2064
|
+
const available = storefrontData.codeExamples
|
|
2065
|
+
.map((e) => ` - \`${e.id}\` - ${e.title}`)
|
|
2066
|
+
.join("\n");
|
|
1854
2067
|
return {
|
|
1855
2068
|
content: [
|
|
1856
2069
|
{
|
|
@@ -1873,14 +2086,24 @@ server.tool("get_code_example", "Get an API usage reference for a specific task.
|
|
|
1873
2086
|
if (example.files && example.files.length > 0) {
|
|
1874
2087
|
for (const file of example.files) {
|
|
1875
2088
|
const ext = file.filename.split(".").pop() || "text";
|
|
1876
|
-
const lang = ext === "tsx" || ext === "ts"
|
|
2089
|
+
const lang = ext === "tsx" || ext === "ts"
|
|
2090
|
+
? "typescript"
|
|
2091
|
+
: ext === "css"
|
|
2092
|
+
? "css"
|
|
2093
|
+
: ext === "json"
|
|
2094
|
+
? "json"
|
|
2095
|
+
: "text";
|
|
1877
2096
|
// Add inline originality comments to CSS and TSX files
|
|
1878
2097
|
let content = file.content;
|
|
1879
2098
|
if (ext === "css") {
|
|
1880
|
-
content =
|
|
2099
|
+
content =
|
|
2100
|
+
"/* EXAMPLE STYLING — create your own original CSS with different class names and design */\n" +
|
|
2101
|
+
content;
|
|
1881
2102
|
}
|
|
1882
2103
|
else if (ext === "tsx") {
|
|
1883
|
-
content =
|
|
2104
|
+
content =
|
|
2105
|
+
"// EXAMPLE COMPONENT — use the API patterns but create your own JSX structure and layout\n" +
|
|
2106
|
+
content;
|
|
1884
2107
|
}
|
|
1885
2108
|
parts.push(`### ${file.filename}`, "", `\`\`\`${lang}`, content, "```", "");
|
|
1886
2109
|
}
|
|
@@ -1894,63 +2117,88 @@ server.tool("get_code_example", "Get an API usage reference for a specific task.
|
|
|
1894
2117
|
return { content: [{ type: "text", text: parts.join("\n") }] };
|
|
1895
2118
|
});
|
|
1896
2119
|
// Tool: get_framework_guide
|
|
1897
|
-
server.tool("get_framework_guide", "Get a framework guide on a specific topic (e.g. 'ai-workflow', 'common-pitfalls', 'prop-types', 'css-scoping', 'form-handling'). Call `list_topics()` to see all available topic keys.", {
|
|
2120
|
+
server.tool("get_framework_guide", "Get a framework guide on a specific topic (e.g. 'ai-workflow', 'common-pitfalls', 'prop-types', 'css-scoping', 'form-handling'). Call `list_topics()` to see all available topic keys.", {
|
|
2121
|
+
topic: z
|
|
2122
|
+
.string()
|
|
2123
|
+
.describe("Topic key or keyword (call `list_topics()` for the full list)"),
|
|
2124
|
+
}, async ({ topic }) => {
|
|
1898
2125
|
const topicLower = topic.toLowerCase().replace(/\s+/g, "-");
|
|
1899
2126
|
// Alias mapping for common alternative topic names
|
|
1900
2127
|
const topicAliases = {
|
|
1901
2128
|
"form-handling": "form-patterns",
|
|
1902
|
-
|
|
2129
|
+
forms: "form-patterns",
|
|
1903
2130
|
"data-fetching": "async-data-patterns",
|
|
1904
|
-
|
|
1905
|
-
|
|
2131
|
+
async: "async-data-patterns",
|
|
2132
|
+
loading: "async-data-patterns",
|
|
1906
2133
|
"sub-components": "sub-component-patterns",
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
2134
|
+
subcomponents: "sub-component-patterns",
|
|
2135
|
+
routing: "navigation-patterns",
|
|
2136
|
+
router: "navigation-patterns",
|
|
2137
|
+
observer: "component-structure",
|
|
2138
|
+
reactivity: "component-structure",
|
|
2139
|
+
pitfalls: "common-pitfalls",
|
|
2140
|
+
gotchas: "common-pitfalls",
|
|
2141
|
+
mistakes: "common-pitfalls",
|
|
2142
|
+
header: "header-footer-patterns",
|
|
2143
|
+
footer: "header-footer-patterns",
|
|
2144
|
+
blog: "blog-patterns",
|
|
2145
|
+
cart: "cart-patterns",
|
|
2146
|
+
account: "account-patterns",
|
|
1920
2147
|
"product-detail": "product-detail-patterns",
|
|
1921
2148
|
"product-list": "product-list-patterns",
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
2149
|
+
filtering: "product-list-patterns",
|
|
2150
|
+
reviews: "review-patterns",
|
|
2151
|
+
slider: "slider-overlay-patterns",
|
|
2152
|
+
overlay: "slider-overlay-patterns",
|
|
2153
|
+
modal: "slider-overlay-patterns",
|
|
2154
|
+
architecture: "real-world-architecture",
|
|
2155
|
+
theme: "real-world-architecture",
|
|
1929
2156
|
"global-styles": "global-css",
|
|
1930
|
-
|
|
2157
|
+
global: "global-css",
|
|
1931
2158
|
"css-variables": "global-css",
|
|
1932
2159
|
"custom-properties": "global-css",
|
|
1933
2160
|
};
|
|
1934
2161
|
const resolvedTopic = topicAliases[topicLower] || topicLower;
|
|
1935
2162
|
// Topics that involve MobX store reads get a reminder about root reactivity
|
|
1936
2163
|
const storeTopics = new Set([
|
|
1937
|
-
"product-detail-patterns",
|
|
1938
|
-
"
|
|
1939
|
-
"
|
|
1940
|
-
"
|
|
2164
|
+
"product-detail-patterns",
|
|
2165
|
+
"product-list-patterns",
|
|
2166
|
+
"cart-patterns",
|
|
2167
|
+
"account-patterns",
|
|
2168
|
+
"header-footer-patterns",
|
|
2169
|
+
"review-patterns",
|
|
2170
|
+
"blog-patterns",
|
|
2171
|
+
"form-handling",
|
|
2172
|
+
"async-data-patterns",
|
|
2173
|
+
"component-structure",
|
|
2174
|
+
"imports",
|
|
1941
2175
|
]);
|
|
1942
2176
|
const observerReminder = "> **IMPORTANT: Do NOT use `observer()` on root component exports.** The ikas runtime wraps root renders in MobX `autorun()`, making them automatically reactive. All store reads (`cartStore`, `customerStore`, etc.) in root components are tracked automatically. Only use `observer()` on extracted sub-components.\n\n";
|
|
1943
2177
|
// Try exact key match (with alias resolution)
|
|
1944
2178
|
if (frameworkData.topics[resolvedTopic]) {
|
|
1945
2179
|
const t = frameworkData.topics[resolvedTopic];
|
|
1946
2180
|
const prefix = storeTopics.has(resolvedTopic) ? observerReminder : "";
|
|
1947
|
-
return {
|
|
2181
|
+
return {
|
|
2182
|
+
content: [
|
|
2183
|
+
{
|
|
2184
|
+
type: "text",
|
|
2185
|
+
text: `## ${t.title}\n\n${prefix}${t.content}`,
|
|
2186
|
+
},
|
|
2187
|
+
],
|
|
2188
|
+
};
|
|
1948
2189
|
}
|
|
1949
2190
|
// Try original topic key (without alias) in case it's a direct key
|
|
1950
2191
|
if (resolvedTopic !== topicLower && frameworkData.topics[topicLower]) {
|
|
1951
2192
|
const t = frameworkData.topics[topicLower];
|
|
1952
2193
|
const prefix = storeTopics.has(topicLower) ? observerReminder : "";
|
|
1953
|
-
return {
|
|
2194
|
+
return {
|
|
2195
|
+
content: [
|
|
2196
|
+
{
|
|
2197
|
+
type: "text",
|
|
2198
|
+
text: `## ${t.title}\n\n${prefix}${t.content}`,
|
|
2199
|
+
},
|
|
2200
|
+
],
|
|
2201
|
+
};
|
|
1954
2202
|
}
|
|
1955
2203
|
// Try keyword search
|
|
1956
2204
|
const matches = searchFrameworkTopics(topic);
|
|
@@ -1958,7 +2206,12 @@ server.tool("get_framework_guide", "Get a framework guide on a specific topic (e
|
|
|
1958
2206
|
const best = matches[0];
|
|
1959
2207
|
const prefix = storeTopics.has(best.key) ? observerReminder : "";
|
|
1960
2208
|
return {
|
|
1961
|
-
content: [
|
|
2209
|
+
content: [
|
|
2210
|
+
{
|
|
2211
|
+
type: "text",
|
|
2212
|
+
text: `## ${best.topic.title}\n\n${prefix}${best.topic.content}`,
|
|
2213
|
+
},
|
|
2214
|
+
],
|
|
1962
2215
|
};
|
|
1963
2216
|
}
|
|
1964
2217
|
const available = Object.entries(frameworkData.topics)
|
|
@@ -1974,16 +2227,27 @@ server.tool("get_framework_guide", "Get a framework guide on a specific topic (e
|
|
|
1974
2227
|
};
|
|
1975
2228
|
});
|
|
1976
2229
|
// Tool: get_type_definition
|
|
1977
|
-
server.tool("get_type_definition", "Get the full definition of a storefront type or enum by name (e.g. 'IkasProduct', 'IkasOrderStatus'). Shows all properties with types, extends, or enum values.", {
|
|
2230
|
+
server.tool("get_type_definition", "Get the full definition of a storefront type or enum by name (e.g. 'IkasProduct', 'IkasOrderStatus'). Shows all properties with types, extends, or enum values.", {
|
|
2231
|
+
name: z
|
|
2232
|
+
.string()
|
|
2233
|
+
.describe("Type or enum name (e.g. 'IkasProduct', 'IkasOrderStatus')"),
|
|
2234
|
+
}, async ({ name }) => {
|
|
1978
2235
|
if (!typesData) {
|
|
1979
2236
|
return {
|
|
1980
|
-
content: [
|
|
2237
|
+
content: [
|
|
2238
|
+
{
|
|
2239
|
+
type: "text",
|
|
2240
|
+
text: "Type data not available. Run 'npm run docs:generate' in storefront-docs first.",
|
|
2241
|
+
},
|
|
2242
|
+
],
|
|
1981
2243
|
};
|
|
1982
2244
|
}
|
|
1983
2245
|
const nameLower = name.toLowerCase();
|
|
1984
2246
|
const td = typesData.types.find((t) => t.name.toLowerCase() === nameLower);
|
|
1985
2247
|
if (td) {
|
|
1986
|
-
return {
|
|
2248
|
+
return {
|
|
2249
|
+
content: [{ type: "text", text: formatTypeDefinition(td) }],
|
|
2250
|
+
};
|
|
1987
2251
|
}
|
|
1988
2252
|
// Fuzzy match
|
|
1989
2253
|
const matches = typesData.types.filter((t) => t.name.toLowerCase().includes(nameLower));
|
|
@@ -1999,14 +2263,28 @@ server.tool("get_type_definition", "Get the full definition of a storefront type
|
|
|
1999
2263
|
};
|
|
2000
2264
|
}
|
|
2001
2265
|
return {
|
|
2002
|
-
content: [
|
|
2266
|
+
content: [
|
|
2267
|
+
{
|
|
2268
|
+
type: "text",
|
|
2269
|
+
text: `Type "${name}" not found. Use \`list_types()\` to see all available types.`,
|
|
2270
|
+
},
|
|
2271
|
+
],
|
|
2003
2272
|
};
|
|
2004
2273
|
});
|
|
2005
2274
|
// Tool: get_functions_for_type
|
|
2006
|
-
server.tool("get_functions_for_type", "Get full documentation for all utility functions that operate on a given storefront type. For example, get_functions_for_type('IkasImage') returns getSrc, getDefaultSrc, getThumbnailSrc, createMediaSrcset with full signatures, descriptions, and examples.", {
|
|
2275
|
+
server.tool("get_functions_for_type", "Get full documentation for all utility functions that operate on a given storefront type. For example, get_functions_for_type('IkasImage') returns getSrc, getDefaultSrc, getThumbnailSrc, createMediaSrcset with full signatures, descriptions, and examples.", {
|
|
2276
|
+
typeName: z
|
|
2277
|
+
.string()
|
|
2278
|
+
.describe("Type name (e.g. 'IkasImage', 'IkasProduct', 'IkasOrder')"),
|
|
2279
|
+
}, async ({ typeName }) => {
|
|
2007
2280
|
if (!typesData) {
|
|
2008
2281
|
return {
|
|
2009
|
-
content: [
|
|
2282
|
+
content: [
|
|
2283
|
+
{
|
|
2284
|
+
type: "text",
|
|
2285
|
+
text: "Type data not available. Run 'npm run docs:generate' in storefront-docs first.",
|
|
2286
|
+
},
|
|
2287
|
+
],
|
|
2010
2288
|
};
|
|
2011
2289
|
}
|
|
2012
2290
|
const nameLower = typeName.toLowerCase();
|
|
@@ -2026,7 +2304,12 @@ server.tool("get_functions_for_type", "Get full documentation for all utility fu
|
|
|
2026
2304
|
};
|
|
2027
2305
|
}
|
|
2028
2306
|
return {
|
|
2029
|
-
content: [
|
|
2307
|
+
content: [
|
|
2308
|
+
{
|
|
2309
|
+
type: "text",
|
|
2310
|
+
text: `Type "${typeName}" not found. Use \`list_types()\` to see all available types.`,
|
|
2311
|
+
},
|
|
2312
|
+
],
|
|
2030
2313
|
};
|
|
2031
2314
|
}
|
|
2032
2315
|
if (!td.relatedFunctions || td.relatedFunctions.length === 0) {
|
|
@@ -2057,7 +2340,10 @@ server.tool("get_functions_for_type", "Get full documentation for all utility fu
|
|
|
2057
2340
|
});
|
|
2058
2341
|
// Tool: get_model_guide
|
|
2059
2342
|
server.tool("get_model_guide", "Get an overview of a storefront model type. By default returns the type definition, related function names with one-line summaries, matching example titles/IDs, and related type summaries. Pass `mode: 'full'` to inline full function docs and example code.", {
|
|
2060
|
-
model: z
|
|
2343
|
+
model: z
|
|
2344
|
+
.string()
|
|
2345
|
+
.optional()
|
|
2346
|
+
.describe("Model type name (e.g. 'IkasImage', 'IkasProduct', 'IkasOrder')"),
|
|
2061
2347
|
name: z.string().optional().describe("Alias for 'model'"),
|
|
2062
2348
|
mode: z
|
|
2063
2349
|
.enum(["summary", "full"])
|
|
@@ -2068,12 +2354,22 @@ server.tool("get_model_guide", "Get an overview of a storefront model type. By d
|
|
|
2068
2354
|
const model = modelParam || nameParam;
|
|
2069
2355
|
if (!model) {
|
|
2070
2356
|
return {
|
|
2071
|
-
content: [
|
|
2357
|
+
content: [
|
|
2358
|
+
{
|
|
2359
|
+
type: "text",
|
|
2360
|
+
text: "Please provide a model name (e.g. 'IkasProduct', 'IkasOrder'). Use the 'model' or 'name' parameter.",
|
|
2361
|
+
},
|
|
2362
|
+
],
|
|
2072
2363
|
};
|
|
2073
2364
|
}
|
|
2074
2365
|
if (!typesData) {
|
|
2075
2366
|
return {
|
|
2076
|
-
content: [
|
|
2367
|
+
content: [
|
|
2368
|
+
{
|
|
2369
|
+
type: "text",
|
|
2370
|
+
text: "Type data not available. Run 'npm run docs:generate' in storefront-docs first.",
|
|
2371
|
+
},
|
|
2372
|
+
],
|
|
2077
2373
|
};
|
|
2078
2374
|
}
|
|
2079
2375
|
const modelLower = model.toLowerCase();
|
|
@@ -2095,7 +2391,12 @@ server.tool("get_model_guide", "Get an overview of a storefront model type. By d
|
|
|
2095
2391
|
};
|
|
2096
2392
|
}
|
|
2097
2393
|
return {
|
|
2098
|
-
content: [
|
|
2394
|
+
content: [
|
|
2395
|
+
{
|
|
2396
|
+
type: "text",
|
|
2397
|
+
text: `Model "${model}" not found. Use \`list_types()\` to see all available types.`,
|
|
2398
|
+
},
|
|
2399
|
+
],
|
|
2099
2400
|
};
|
|
2100
2401
|
}
|
|
2101
2402
|
const parts = [`# Model Guide: ${td.name}\n`];
|
|
@@ -2203,13 +2504,23 @@ server.tool("get_model_guide", "Get an overview of a storefront model type. By d
|
|
|
2203
2504
|
server.tool("search_types", "Search storefront types and enums by keyword (e.g. 'price', 'address', 'status'). Returns top matches ranked by relevance.", { query: z.string().describe("Search keyword or phrase") }, async ({ query }) => {
|
|
2204
2505
|
if (!typesData) {
|
|
2205
2506
|
return {
|
|
2206
|
-
content: [
|
|
2507
|
+
content: [
|
|
2508
|
+
{
|
|
2509
|
+
type: "text",
|
|
2510
|
+
text: "Type data not available. Run 'npm run docs:generate' in storefront-docs first.",
|
|
2511
|
+
},
|
|
2512
|
+
],
|
|
2207
2513
|
};
|
|
2208
2514
|
}
|
|
2209
2515
|
const results = searchTypes(query).slice(0, 15);
|
|
2210
2516
|
if (results.length === 0) {
|
|
2211
2517
|
return {
|
|
2212
|
-
content: [
|
|
2518
|
+
content: [
|
|
2519
|
+
{
|
|
2520
|
+
type: "text",
|
|
2521
|
+
text: `No types found matching "${query}". Use \`list_types()\` to see all available types.`,
|
|
2522
|
+
},
|
|
2523
|
+
],
|
|
2213
2524
|
};
|
|
2214
2525
|
}
|
|
2215
2526
|
const parts = [`## Type Search Results for "${query}"\n`];
|
|
@@ -2273,7 +2584,7 @@ server.tool("list_types", "List storefront types and enums. Use `domain` and/or
|
|
|
2273
2584
|
for (const [d, count] of sorted) {
|
|
2274
2585
|
lines.push(`- \`${d}\` (${count})`);
|
|
2275
2586
|
}
|
|
2276
|
-
lines.push("",
|
|
2587
|
+
lines.push("", 'Call `list_types(domain: "<name>")` to see summaries for a domain.');
|
|
2277
2588
|
return { content: [{ type: "text", text: lines.join("\n") }] };
|
|
2278
2589
|
}
|
|
2279
2590
|
const domainLower = domain.toLowerCase();
|
|
@@ -2312,15 +2623,25 @@ server.tool("list_types", "List storefront types and enums. Use `domain` and/or
|
|
|
2312
2623
|
return { content: [{ type: "text", text: parts.join("\n") }] };
|
|
2313
2624
|
});
|
|
2314
2625
|
// Tool: get_prop_types
|
|
2315
|
-
server.tool("get_prop_types", "Get all available ikas.config.json prop types with descriptions, TypeScript types, and examples. Tip: Use `npx ikas-component config add-component --props '[...]'` to create a component with all props in one command, or `add-prop` to add props incrementally. NEVER manually edit types.ts — it is auto-generated by the CLI.", {}, async () => {
|
|
2626
|
+
server.tool("get_prop_types", "Get all available ikas.config.json prop types with descriptions, TypeScript types, and examples. NOTE: these are the TypeScript prop-definition types for authoring a component — they are NOT the runtime JSON value shapes you write via `update_section_prop` (e.g. a TEXT prop is typed `string` here but written as `{ \"value\": \"...\" }`, and an IMAGE is `IkasImage | null` here but written as `{ \"id\": \"...\" }`). For the value shapes to pass to `update_section_prop`, see that tool's description. Tip: Use `npx ikas-component config add-component --props '[...]'` to create a component with all props in one command, or `add-prop` to add props incrementally. NEVER manually edit types.ts — it is auto-generated by the CLI.", {}, async () => {
|
|
2316
2627
|
const propTypesTopic = frameworkData.topics["prop-types"];
|
|
2317
2628
|
if (propTypesTopic) {
|
|
2318
2629
|
return {
|
|
2319
|
-
content: [
|
|
2630
|
+
content: [
|
|
2631
|
+
{
|
|
2632
|
+
type: "text",
|
|
2633
|
+
text: `## ${propTypesTopic.title}\n\n${propTypesTopic.content}`,
|
|
2634
|
+
},
|
|
2635
|
+
],
|
|
2320
2636
|
};
|
|
2321
2637
|
}
|
|
2322
2638
|
return {
|
|
2323
|
-
content: [
|
|
2639
|
+
content: [
|
|
2640
|
+
{
|
|
2641
|
+
type: "text",
|
|
2642
|
+
text: "Prop types documentation not available.",
|
|
2643
|
+
},
|
|
2644
|
+
],
|
|
2324
2645
|
};
|
|
2325
2646
|
});
|
|
2326
2647
|
// Tool: get_section_template
|
|
@@ -2417,7 +2738,8 @@ server.tool("get_section_template", "Get the root files of a starter section tem
|
|
|
2417
2738
|
// the end of the response in the existing recipe-builder block.
|
|
2418
2739
|
{
|
|
2419
2740
|
const snippetStrForBanner = bundle.rootFiles["ikas-config-snippet.json"];
|
|
2420
|
-
if (snippetStrForBanner &&
|
|
2741
|
+
if (snippetStrForBanner &&
|
|
2742
|
+
/<id-of-[A-Za-z0-9_]+>/.test(snippetStrForBanner)) {
|
|
2421
2743
|
const childMatches = Array.from(snippetStrForBanner.matchAll(/<id-of-([A-Za-z0-9_]+)>/g));
|
|
2422
2744
|
const uniqueChildren = Array.from(new Set(childMatches.map((m) => m[1])));
|
|
2423
2745
|
parts.push(`> 🔧 **CONTAINER SECTION — required wiring.** This template hosts ${uniqueChildren.length} child component${uniqueChildren.length === 1 ? "" : "s"} (${uniqueChildren.map((n) => `\`${n}\``).join(", ")}) via a \`COMPONENT_LIST\` slot. Creating the parent alone produces an empty, unusable section. **You MUST follow the full Setup Recipe below**: create each child → capture its \`componentId\` → wire them into the parent's \`filteredComponentIds\` with \`config update-prop\`. Component ids are opaque random strings (e.g. \`7ojrigep-Eml9n5sN3i\`) — they cannot be derived from names, and the CLI rejects unknown ids.`, "");
|
|
@@ -2541,7 +2863,10 @@ server.tool("get_section_template", "Get the root files of a starter section tem
|
|
|
2541
2863
|
try {
|
|
2542
2864
|
const childSnippet = JSON.parse(fs.readFileSync(childSnippetPath, "utf-8"));
|
|
2543
2865
|
const childProps = (childSnippet.props || []).map((p) => {
|
|
2544
|
-
const out = {
|
|
2866
|
+
const out = {
|
|
2867
|
+
name: p.name,
|
|
2868
|
+
type: p.type,
|
|
2869
|
+
};
|
|
2545
2870
|
if (p.displayName)
|
|
2546
2871
|
out.displayName = p.displayName;
|
|
2547
2872
|
if (p.required)
|
|
@@ -2614,10 +2939,7 @@ server.tool("get_section_child", "Fetch one item's files from a section's childr
|
|
|
2614
2939
|
.string()
|
|
2615
2940
|
.optional()
|
|
2616
2941
|
.describe("The item name as listed in `get_section_template`'s response (Children/Components/Sub-components)"),
|
|
2617
|
-
child: z
|
|
2618
|
-
.string()
|
|
2619
|
-
.optional()
|
|
2620
|
-
.describe("Alias for `name`"),
|
|
2942
|
+
child: z.string().optional().describe("Alias for `name`"),
|
|
2621
2943
|
kind: z
|
|
2622
2944
|
.enum(["children", "components", "sub-components"])
|
|
2623
2945
|
.optional()
|
|
@@ -2780,7 +3102,11 @@ server.tool("list_section_types", "List all available `get_section_template` sec
|
|
|
2780
3102
|
});
|
|
2781
3103
|
// --- Migration tools ---
|
|
2782
3104
|
// Tool: analyze_old_theme
|
|
2783
|
-
server.tool("analyze_old_theme", "Analyze an old ikas storefront theme.json and produce a structured migration report. Shows all components, custom data definitions, prop type breakdown, and migration recommendations. Use this as the first step when converting an old theme.", {
|
|
3105
|
+
server.tool("analyze_old_theme", "Analyze an old ikas storefront theme.json and produce a structured migration report. Shows all components, custom data definitions, prop type breakdown, and migration recommendations. Use this as the first step when converting an old theme.", {
|
|
3106
|
+
theme_json: z
|
|
3107
|
+
.string()
|
|
3108
|
+
.describe("The raw JSON content of the old theme.json file"),
|
|
3109
|
+
}, async ({ theme_json }) => {
|
|
2784
3110
|
try {
|
|
2785
3111
|
const parsed = JSON.parse(theme_json);
|
|
2786
3112
|
const analysis = analyzeOldTheme(parsed);
|
|
@@ -2788,102 +3114,162 @@ server.tool("analyze_old_theme", "Analyze an old ikas storefront theme.json and
|
|
|
2788
3114
|
}
|
|
2789
3115
|
catch (err) {
|
|
2790
3116
|
return {
|
|
2791
|
-
content: [
|
|
3117
|
+
content: [
|
|
3118
|
+
{
|
|
3119
|
+
type: "text",
|
|
3120
|
+
text: `Error parsing theme.json: ${err instanceof Error ? err.message : String(err)}. Make sure you're passing valid JSON.`,
|
|
3121
|
+
},
|
|
3122
|
+
],
|
|
2792
3123
|
};
|
|
2793
3124
|
}
|
|
2794
3125
|
});
|
|
2795
3126
|
// Tool: get_migration_guide
|
|
2796
3127
|
const migrationTopicAliases = {
|
|
2797
|
-
|
|
2798
|
-
|
|
2799
|
-
|
|
3128
|
+
overview: "migration-overview",
|
|
3129
|
+
migrate: "migration-overview",
|
|
3130
|
+
custom: "custom-data-conversion",
|
|
2800
3131
|
"custom-data": "custom-data-conversion",
|
|
2801
|
-
|
|
3132
|
+
customdata: "custom-data-conversion",
|
|
2802
3133
|
"dynamic-list": "custom-data-conversion",
|
|
2803
3134
|
"component-list": "custom-data-conversion",
|
|
2804
|
-
|
|
2805
|
-
|
|
3135
|
+
slider: "prop-type-mapping",
|
|
3136
|
+
props: "prop-type-mapping",
|
|
2806
3137
|
"prop-mapping": "prop-type-mapping",
|
|
2807
|
-
|
|
2808
|
-
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
3138
|
+
types: "prop-type-mapping",
|
|
3139
|
+
react: "react-to-preact",
|
|
3140
|
+
preact: "react-to-preact",
|
|
3141
|
+
observer: "react-to-preact",
|
|
3142
|
+
libraries: "library-replacements",
|
|
3143
|
+
swiper: "library-replacements",
|
|
3144
|
+
headlessui: "library-replacements",
|
|
3145
|
+
tailwind: "library-replacements",
|
|
3146
|
+
tailwindcss: "library-replacements",
|
|
3147
|
+
recharts: "library-replacements",
|
|
3148
|
+
marquee: "library-replacements",
|
|
3149
|
+
imports: "storefront-import-mapping",
|
|
3150
|
+
storefront: "storefront-import-mapping",
|
|
2820
3151
|
"bp-storefront": "storefront-import-mapping",
|
|
2821
3152
|
"theme-json": "theme-json-anatomy",
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
3153
|
+
anatomy: "theme-json-anatomy",
|
|
3154
|
+
decompose: "component-decomposition-strategy",
|
|
3155
|
+
decomposition: "component-decomposition-strategy",
|
|
3156
|
+
strategy: "component-decomposition-strategy",
|
|
3157
|
+
project: "complete-project-generation",
|
|
3158
|
+
generate: "complete-project-generation",
|
|
3159
|
+
generation: "complete-project-generation",
|
|
3160
|
+
settings: "settings-conversion",
|
|
3161
|
+
colors: "settings-conversion",
|
|
3162
|
+
fonts: "settings-conversion",
|
|
3163
|
+
find: "finding-new-system-equivalents",
|
|
3164
|
+
search: "finding-new-system-equivalents",
|
|
3165
|
+
discover: "finding-new-system-equivalents",
|
|
3166
|
+
equivalent: "finding-new-system-equivalents",
|
|
3167
|
+
equivalents: "finding-new-system-equivalents",
|
|
3168
|
+
replacement: "finding-new-system-equivalents",
|
|
2838
3169
|
};
|
|
2839
3170
|
const migrationTopicKeys = migrationData
|
|
2840
3171
|
? Object.keys(migrationData.topics)
|
|
2841
3172
|
: [];
|
|
2842
|
-
server.tool("get_migration_guide", `Get a migration guide for converting old ikas themes to the new code-component system. **Start with \`get_migration_guide("iterative-workflow")\` if you're new to this MCP** — it explains the MCP-vs-LLM responsibility split and the four phases.${migrationTopicKeys.length > 0 ? ` Available topics: ${migrationTopicKeys.join(", ")}. Also supports aliases like "custom", "slider", "react", "libraries", "imports", "settings".` : ""} Call with topic "list" to see all available topics.`, {
|
|
3173
|
+
server.tool("get_migration_guide", `Get a migration guide for converting old ikas themes to the new code-component system. **Start with \`get_migration_guide("iterative-workflow")\` if you're new to this MCP** — it explains the MCP-vs-LLM responsibility split and the four phases.${migrationTopicKeys.length > 0 ? ` Available topics: ${migrationTopicKeys.join(", ")}. Also supports aliases like "custom", "slider", "react", "libraries", "imports", "settings".` : ""} Call with topic "list" to see all available topics.`, {
|
|
3174
|
+
topic: z
|
|
3175
|
+
.string()
|
|
3176
|
+
.describe("Migration topic key, alias, or 'list' to see all topics"),
|
|
3177
|
+
}, async ({ topic }) => {
|
|
2843
3178
|
if (!migrationData) {
|
|
2844
|
-
return {
|
|
3179
|
+
return {
|
|
3180
|
+
content: [
|
|
3181
|
+
{
|
|
3182
|
+
type: "text",
|
|
3183
|
+
text: "Migration data not available. Ensure data/migration.json exists.",
|
|
3184
|
+
},
|
|
3185
|
+
],
|
|
3186
|
+
};
|
|
2845
3187
|
}
|
|
2846
3188
|
if (topic.toLowerCase() === "list") {
|
|
2847
3189
|
const available = Object.entries(migrationData.topics)
|
|
2848
3190
|
.map(([key, t]) => `- \`${key}\` — ${t.title}: ${t.description}`)
|
|
2849
3191
|
.join("\n");
|
|
2850
|
-
return {
|
|
3192
|
+
return {
|
|
3193
|
+
content: [
|
|
3194
|
+
{
|
|
3195
|
+
type: "text",
|
|
3196
|
+
text: `## Available Migration Topics\n\n${available}`,
|
|
3197
|
+
},
|
|
3198
|
+
],
|
|
3199
|
+
};
|
|
2851
3200
|
}
|
|
2852
3201
|
const topicLower = topic.toLowerCase().replace(/\s+/g, "-");
|
|
2853
3202
|
const resolvedTopic = migrationTopicAliases[topicLower] || topicLower;
|
|
2854
3203
|
if (migrationData.topics[resolvedTopic]) {
|
|
2855
3204
|
const t = migrationData.topics[resolvedTopic];
|
|
2856
|
-
return {
|
|
3205
|
+
return {
|
|
3206
|
+
content: [
|
|
3207
|
+
{ type: "text", text: `## ${t.title}\n\n${t.content}` },
|
|
3208
|
+
],
|
|
3209
|
+
};
|
|
2857
3210
|
}
|
|
2858
3211
|
// Try original key
|
|
2859
3212
|
if (resolvedTopic !== topicLower && migrationData.topics[topicLower]) {
|
|
2860
3213
|
const t = migrationData.topics[topicLower];
|
|
2861
|
-
return {
|
|
3214
|
+
return {
|
|
3215
|
+
content: [
|
|
3216
|
+
{ type: "text", text: `## ${t.title}\n\n${t.content}` },
|
|
3217
|
+
],
|
|
3218
|
+
};
|
|
2862
3219
|
}
|
|
2863
3220
|
// Keyword search
|
|
2864
3221
|
const matches = searchMigrationTopics(topic);
|
|
2865
3222
|
if (matches.length > 0) {
|
|
2866
3223
|
const best = matches[0];
|
|
2867
|
-
return {
|
|
3224
|
+
return {
|
|
3225
|
+
content: [
|
|
3226
|
+
{
|
|
3227
|
+
type: "text",
|
|
3228
|
+
text: `## ${best.topic.title}\n\n${best.topic.content}`,
|
|
3229
|
+
},
|
|
3230
|
+
],
|
|
3231
|
+
};
|
|
2868
3232
|
}
|
|
2869
3233
|
const available = Object.entries(migrationData.topics)
|
|
2870
3234
|
.map(([key, t]) => ` - \`${key}\` - ${t.title}`)
|
|
2871
3235
|
.join("\n");
|
|
2872
3236
|
return {
|
|
2873
|
-
content: [
|
|
3237
|
+
content: [
|
|
3238
|
+
{
|
|
3239
|
+
type: "text",
|
|
3240
|
+
text: `Migration topic "${topic}" not found. Available topics:\n${available}`,
|
|
3241
|
+
},
|
|
3242
|
+
],
|
|
2874
3243
|
};
|
|
2875
3244
|
});
|
|
2876
3245
|
// Tool: get_migration_example
|
|
2877
|
-
server.tool("get_migration_example", `Get a concrete before/after migration example showing how to convert an old theme component to the new code-component system.${migrationExampleNames.length > 0 ? ` Available examples: ${migrationExampleNames.join(", ")}.` : ""} Call with example "list" to see all examples.`, {
|
|
3246
|
+
server.tool("get_migration_example", `Get a concrete before/after migration example showing how to convert an old theme component to the new code-component system.${migrationExampleNames.length > 0 ? ` Available examples: ${migrationExampleNames.join(", ")}.` : ""} Call with example "list" to see all examples.`, {
|
|
3247
|
+
example: z.string().describe("Example name or 'list' to see all examples"),
|
|
3248
|
+
}, async ({ example }) => {
|
|
2878
3249
|
if (example.toLowerCase() === "list") {
|
|
2879
3250
|
if (migrationExampleNames.length === 0) {
|
|
2880
|
-
return {
|
|
3251
|
+
return {
|
|
3252
|
+
content: [
|
|
3253
|
+
{ type: "text", text: "No migration examples available." },
|
|
3254
|
+
],
|
|
3255
|
+
};
|
|
2881
3256
|
}
|
|
2882
|
-
const list = migrationExampleNames
|
|
3257
|
+
const list = migrationExampleNames
|
|
3258
|
+
.map((name) => {
|
|
2883
3259
|
const ex = loadMigrationExample(name);
|
|
2884
|
-
return ex
|
|
2885
|
-
|
|
2886
|
-
|
|
3260
|
+
return ex
|
|
3261
|
+
? `- \`${name}\` — ${ex.title}: ${ex.description}`
|
|
3262
|
+
: `- \`${name}\``;
|
|
3263
|
+
})
|
|
3264
|
+
.join("\n");
|
|
3265
|
+
return {
|
|
3266
|
+
content: [
|
|
3267
|
+
{
|
|
3268
|
+
type: "text",
|
|
3269
|
+
text: `## Available Migration Examples\n\n${list}`,
|
|
3270
|
+
},
|
|
3271
|
+
],
|
|
3272
|
+
};
|
|
2887
3273
|
}
|
|
2888
3274
|
const exampleLower = example.toLowerCase();
|
|
2889
3275
|
let exName = migrationExampleNames.find((n) => n === exampleLower);
|
|
@@ -2893,19 +3279,26 @@ server.tool("get_migration_example", `Get a concrete before/after migration exam
|
|
|
2893
3279
|
if (!exName) {
|
|
2894
3280
|
const available = migrationExampleNames.join(", ");
|
|
2895
3281
|
return {
|
|
2896
|
-
content: [
|
|
3282
|
+
content: [
|
|
3283
|
+
{
|
|
3284
|
+
type: "text",
|
|
3285
|
+
text: `Migration example "${example}" not found. Available: ${available}`,
|
|
3286
|
+
},
|
|
3287
|
+
],
|
|
2897
3288
|
};
|
|
2898
3289
|
}
|
|
2899
3290
|
const ex = loadMigrationExample(exName);
|
|
2900
3291
|
if (!ex) {
|
|
2901
|
-
return {
|
|
3292
|
+
return {
|
|
3293
|
+
content: [
|
|
3294
|
+
{
|
|
3295
|
+
type: "text",
|
|
3296
|
+
text: `Failed to load migration example "${exName}".`,
|
|
3297
|
+
},
|
|
3298
|
+
],
|
|
3299
|
+
};
|
|
2902
3300
|
}
|
|
2903
|
-
const parts = [
|
|
2904
|
-
`## ${ex.title}`,
|
|
2905
|
-
"",
|
|
2906
|
-
ex.description,
|
|
2907
|
-
"",
|
|
2908
|
-
];
|
|
3301
|
+
const parts = [`## ${ex.title}`, "", ex.description, ""];
|
|
2909
3302
|
for (const [filename, content] of Object.entries(ex.files)) {
|
|
2910
3303
|
const ext = filename.split(".").pop() || "text";
|
|
2911
3304
|
const lang = ext === "tsx" || ext === "ts"
|
|
@@ -2924,13 +3317,31 @@ server.tool("get_migration_example", `Get a concrete before/after migration exam
|
|
|
2924
3317
|
});
|
|
2925
3318
|
// Tool: plan_migration
|
|
2926
3319
|
server.tool("plan_migration", "Generate the **initial** migration plan and (when `project_root` is provided) write it to <project_root>/MIGRATION.md. **This is the only time the MCP writes that file.** From here, you own it: tick checkboxes as you finish work, log custom-data decisions, scan the old source for atomic components (Button, Input, Card, etc.) that theme.json doesn't see, and append them to MIGRATION.md yourself. theme.json is incomplete by design — the MCP can only describe what's listed there. Pass `theme_json_path` for large themes (raw `theme_json` string is supported for backward compat but fails on real-world sizes).", {
|
|
2927
|
-
theme_json: z
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
3320
|
+
theme_json: z
|
|
3321
|
+
.string()
|
|
3322
|
+
.optional()
|
|
3323
|
+
.describe("Raw JSON content of the old theme.json. EITHER this OR theme_json_path is required (not both). For real themes use theme_json_path — raw strings exceed tool/context limits at production sizes."),
|
|
3324
|
+
theme_json_path: z
|
|
3325
|
+
.string()
|
|
3326
|
+
.optional()
|
|
3327
|
+
.describe("Absolute path to the old theme.json file on disk. Preferred for any real-world theme."),
|
|
3328
|
+
project_name: z
|
|
3329
|
+
.string()
|
|
3330
|
+
.optional()
|
|
3331
|
+
.describe("Target new project name, used to prefix migration-tracking IDs (default: 'my-theme')"),
|
|
3332
|
+
old_source_dir: z
|
|
3333
|
+
.string()
|
|
3334
|
+
.optional()
|
|
3335
|
+
.describe("Absolute path to the old project's src/ directory. When provided, the tool scans .tsx files to detect shared sub-components used across 3+ components. This scan is partial — atomic components used by only 1-2 sections will be missed and must be added by the LLM."),
|
|
3336
|
+
project_root: z
|
|
3337
|
+
.string()
|
|
3338
|
+
.optional()
|
|
3339
|
+
.describe("Absolute path to the new project root. When provided, the MCP writes MIGRATION.md to <project_root>/MIGRATION.md and returns a short summary instead of the full markdown body."),
|
|
3340
|
+
overwrite: z
|
|
3341
|
+
.boolean()
|
|
3342
|
+
.optional()
|
|
3343
|
+
.describe("If MIGRATION.md already exists at <project_root>/MIGRATION.md and is non-empty, refuse the write unless this is true. Default: false."),
|
|
3344
|
+
}, async ({ theme_json, theme_json_path, project_name, old_source_dir, project_root, overwrite, }) => {
|
|
2934
3345
|
try {
|
|
2935
3346
|
const parsed = resolveThemeJson(theme_json, theme_json_path);
|
|
2936
3347
|
const projectName = project_name || "my-theme";
|
|
@@ -2991,18 +3402,37 @@ server.tool("plan_migration", "Generate the **initial** migration plan and (when
|
|
|
2991
3402
|
}
|
|
2992
3403
|
catch (err) {
|
|
2993
3404
|
return {
|
|
2994
|
-
content: [
|
|
3405
|
+
content: [
|
|
3406
|
+
{
|
|
3407
|
+
type: "text",
|
|
3408
|
+
text: `Error: ${err instanceof Error ? err.message : String(err)}`,
|
|
3409
|
+
},
|
|
3410
|
+
],
|
|
2995
3411
|
};
|
|
2996
3412
|
}
|
|
2997
3413
|
});
|
|
2998
3414
|
// Tool: get_section_migration_plan
|
|
2999
3415
|
server.tool("get_section_migration_plan", "Returns concrete CLI commands and prop conversions for one section. For each prop that references a customData type, you'll see a 'Decide: enum or component?' callout — log your decision in MIGRATION.md under `## Custom Data Decisions`. Pass `theme_json_path` for large themes.", {
|
|
3000
|
-
theme_json: z
|
|
3001
|
-
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
|
|
3416
|
+
theme_json: z
|
|
3417
|
+
.string()
|
|
3418
|
+
.optional()
|
|
3419
|
+
.describe("Raw JSON content of the old theme.json. EITHER this OR theme_json_path is required (not both)."),
|
|
3420
|
+
theme_json_path: z
|
|
3421
|
+
.string()
|
|
3422
|
+
.optional()
|
|
3423
|
+
.describe("Absolute path to the old theme.json file on disk. Preferred for any real-world theme."),
|
|
3424
|
+
section_name: z
|
|
3425
|
+
.string()
|
|
3426
|
+
.describe("Old component name (e.g. 'Navbar', 'ProductGrid') or dir name, OR the new section ID (e.g. 'my-theme-navbar')"),
|
|
3427
|
+
project_name: z
|
|
3428
|
+
.string()
|
|
3429
|
+
.optional()
|
|
3430
|
+
.describe("Target new project name (must match what was used in plan_migration). Default: 'my-theme'"),
|
|
3431
|
+
old_source_dir: z
|
|
3432
|
+
.string()
|
|
3433
|
+
.optional()
|
|
3434
|
+
.describe("Absolute path to old src/ directory (used to output exact source file paths to read)"),
|
|
3435
|
+
}, async ({ theme_json, theme_json_path, section_name, project_name, old_source_dir, }) => {
|
|
3006
3436
|
try {
|
|
3007
3437
|
const parsed = resolveThemeJson(theme_json, theme_json_path);
|
|
3008
3438
|
const projectName = project_name || "my-theme";
|
|
@@ -3011,10 +3441,614 @@ server.tool("get_section_migration_plan", "Returns concrete CLI commands and pro
|
|
|
3011
3441
|
}
|
|
3012
3442
|
catch (err) {
|
|
3013
3443
|
return {
|
|
3014
|
-
content: [
|
|
3444
|
+
content: [
|
|
3445
|
+
{
|
|
3446
|
+
type: "text",
|
|
3447
|
+
text: `Error: ${err instanceof Error ? err.message : String(err)}`,
|
|
3448
|
+
},
|
|
3449
|
+
],
|
|
3015
3450
|
};
|
|
3016
3451
|
}
|
|
3017
3452
|
});
|
|
3453
|
+
// =============================================================================
|
|
3454
|
+
// Editor-action tools — drive the connected editor over the dev server's WS
|
|
3455
|
+
// (port 5201) by shelling out to `ikas-component <cmd>`. The CLI is the
|
|
3456
|
+
// canonical implementation; these tools are thin advertisements for the LLM.
|
|
3457
|
+
// =============================================================================
|
|
3458
|
+
function resolveIkasComponentBinary(projectRoot) {
|
|
3459
|
+
if (!path.isAbsolute(projectRoot)) {
|
|
3460
|
+
throw new Error(`project_root must be absolute: ${projectRoot}`);
|
|
3461
|
+
}
|
|
3462
|
+
if (!fs.existsSync(projectRoot) || !fs.statSync(projectRoot).isDirectory()) {
|
|
3463
|
+
throw new Error(`project_root is not a directory: ${projectRoot}`);
|
|
3464
|
+
}
|
|
3465
|
+
const binDir = path.join(projectRoot, "node_modules", ".bin");
|
|
3466
|
+
const candidates = os.platform() === "win32"
|
|
3467
|
+
? ["ikas-component.cmd", "ikas-component.exe", "ikas-component"]
|
|
3468
|
+
: ["ikas-component"];
|
|
3469
|
+
for (const name of candidates) {
|
|
3470
|
+
const full = path.join(binDir, name);
|
|
3471
|
+
if (fs.existsSync(full))
|
|
3472
|
+
return full;
|
|
3473
|
+
}
|
|
3474
|
+
throw new Error(`ikas-component CLI not found at ${binDir}. Run \`npm install\` (or \`pnpm install\`) in ${projectRoot} first.`);
|
|
3475
|
+
}
|
|
3476
|
+
async function runIkasComponentCli(projectRoot, args) {
|
|
3477
|
+
const bin = resolveIkasComponentBinary(projectRoot);
|
|
3478
|
+
return new Promise((resolve) => {
|
|
3479
|
+
execFile(bin, args,
|
|
3480
|
+
// Large editor responses (e.g. list_categories on a big store, or
|
|
3481
|
+
// add_sections_to_page echoing many sections) easily exceed Node's default
|
|
3482
|
+
// 1MB stdout buffer, which truncates output mid-JSON and yields a
|
|
3483
|
+
// "no parseable JSON" error. Give it generous headroom.
|
|
3484
|
+
{ cwd: projectRoot, windowsHide: true, maxBuffer: 64 * 1024 * 1024 }, (err, stdout, stderr) => {
|
|
3485
|
+
const exitCode = err && typeof err.code === "number"
|
|
3486
|
+
? err.code
|
|
3487
|
+
: err
|
|
3488
|
+
? 1
|
|
3489
|
+
: 0;
|
|
3490
|
+
resolve({
|
|
3491
|
+
stdout: stdout?.toString() ?? "",
|
|
3492
|
+
stderr: stderr?.toString() ?? "",
|
|
3493
|
+
exitCode,
|
|
3494
|
+
});
|
|
3495
|
+
});
|
|
3496
|
+
});
|
|
3497
|
+
}
|
|
3498
|
+
function parseCliJson(stdout) {
|
|
3499
|
+
const trimmed = stdout.trim();
|
|
3500
|
+
if (!trimmed)
|
|
3501
|
+
return null;
|
|
3502
|
+
// Fast path: the CLI prints exactly one JSON object on stdout.
|
|
3503
|
+
try {
|
|
3504
|
+
return JSON.parse(trimmed);
|
|
3505
|
+
}
|
|
3506
|
+
catch {
|
|
3507
|
+
// Fallback: if anything leaked onto stdout before/after the JSON, scan the
|
|
3508
|
+
// lines and return the last one that parses as JSON.
|
|
3509
|
+
const lines = trimmed
|
|
3510
|
+
.split("\n")
|
|
3511
|
+
.map((l) => l.trim())
|
|
3512
|
+
.filter(Boolean);
|
|
3513
|
+
for (let i = lines.length - 1; i >= 0; i--) {
|
|
3514
|
+
try {
|
|
3515
|
+
return JSON.parse(lines[i]);
|
|
3516
|
+
}
|
|
3517
|
+
catch {
|
|
3518
|
+
// keep scanning
|
|
3519
|
+
}
|
|
3520
|
+
}
|
|
3521
|
+
return null;
|
|
3522
|
+
}
|
|
3523
|
+
}
|
|
3524
|
+
async function callEditorAction(projectRoot, args) {
|
|
3525
|
+
try {
|
|
3526
|
+
const { stdout, stderr, exitCode } = await runIkasComponentCli(projectRoot, args);
|
|
3527
|
+
const parsed = parseCliJson(stdout);
|
|
3528
|
+
if (parsed) {
|
|
3529
|
+
return {
|
|
3530
|
+
content: [
|
|
3531
|
+
{ type: "text", text: JSON.stringify(parsed, null, 2) },
|
|
3532
|
+
],
|
|
3533
|
+
};
|
|
3534
|
+
}
|
|
3535
|
+
return {
|
|
3536
|
+
content: [
|
|
3537
|
+
{
|
|
3538
|
+
type: "text",
|
|
3539
|
+
text: `CLI exited with code ${exitCode} and produced no parseable JSON.\n` +
|
|
3540
|
+
`stdout:\n${stdout || "(empty)"}\nstderr:\n${stderr || "(empty)"}`,
|
|
3541
|
+
},
|
|
3542
|
+
],
|
|
3543
|
+
};
|
|
3544
|
+
}
|
|
3545
|
+
catch (err) {
|
|
3546
|
+
return {
|
|
3547
|
+
content: [
|
|
3548
|
+
{
|
|
3549
|
+
type: "text",
|
|
3550
|
+
text: `Error: ${err instanceof Error ? err.message : String(err)}`,
|
|
3551
|
+
},
|
|
3552
|
+
],
|
|
3553
|
+
};
|
|
3554
|
+
}
|
|
3555
|
+
}
|
|
3556
|
+
//
|
|
3557
|
+
// Tool: list_editor_pages
|
|
3558
|
+
server.tool("list_editor_pages", "List pages in the connected editor's project. Returns id, name, pageType, slug for each page. Requires `ikas-component dev` to be running with the editor connected. Use the returned `id`s as the `pageId` argument to `add_section_to_page`.", {
|
|
3559
|
+
project_root: z
|
|
3560
|
+
.string()
|
|
3561
|
+
.describe("Absolute path to the code-component project (where `node_modules/.bin/ikas-component` lives)."),
|
|
3562
|
+
port: z
|
|
3563
|
+
.number()
|
|
3564
|
+
.optional()
|
|
3565
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3566
|
+
}, async ({ project_root, port }) => {
|
|
3567
|
+
const args = ["list-pages", ...(port ? ["--port", String(port)] : [])];
|
|
3568
|
+
return callEditorAction(project_root, args);
|
|
3569
|
+
});
|
|
3570
|
+
// Tool: list_imported_sections
|
|
3571
|
+
server.tool("list_imported_sections", "List section-type code components already imported into the editor's project (theme.codeComponents, filtered to type=section). Use to confirm a component is ready to be placed on a page. The component must be built (`ikas-component build`/`dev`) and imported (`import_section`) before it can be added to a page. The returned `id` is the editor's id for the imported component — normally identical to the id in `ikas.config.json`, but it can differ if the dev component was deleted and re-scaffolded after a previous import. Always use the `id` from this tool, not from `ikas.config.json`, when calling `add_section_to_page`.", {
|
|
3572
|
+
project_root: z
|
|
3573
|
+
.string()
|
|
3574
|
+
.describe("Absolute path to the code-component project."),
|
|
3575
|
+
port: z
|
|
3576
|
+
.number()
|
|
3577
|
+
.optional()
|
|
3578
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3579
|
+
}, async ({ project_root, port }) => {
|
|
3580
|
+
const args = [
|
|
3581
|
+
"list-imported",
|
|
3582
|
+
"--sections-only",
|
|
3583
|
+
...(port ? ["--port", String(port)] : []),
|
|
3584
|
+
];
|
|
3585
|
+
return callEditorAction(project_root, args);
|
|
3586
|
+
});
|
|
3587
|
+
// Tool: import_section
|
|
3588
|
+
server.tool("import_section", "Import a built section-type code component into the editor's project. This copies the compiled JS/CSS/props into `theme.codeComponents` and auto-creates the wrapper section needed to place it on a page. Idempotent: re-running updates the existing entry in place. Required before `add_section_to_page`. The component must have been built (`ikas-component build`/`dev`).", {
|
|
3589
|
+
project_root: z
|
|
3590
|
+
.string()
|
|
3591
|
+
.describe("Absolute path to the code-component project."),
|
|
3592
|
+
component_id: z
|
|
3593
|
+
.string()
|
|
3594
|
+
.describe("Component id from `ikas.config.json` (strict — no name resolution)."),
|
|
3595
|
+
port: z
|
|
3596
|
+
.number()
|
|
3597
|
+
.optional()
|
|
3598
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3599
|
+
}, async ({ project_root, component_id, port }) => {
|
|
3600
|
+
const args = [
|
|
3601
|
+
"import",
|
|
3602
|
+
"--id",
|
|
3603
|
+
component_id,
|
|
3604
|
+
...(port ? ["--port", String(port)] : []),
|
|
3605
|
+
];
|
|
3606
|
+
return callEditorAction(project_root, args);
|
|
3607
|
+
});
|
|
3608
|
+
// Tool: add_section_to_page
|
|
3609
|
+
server.tool("add_section_to_page", 'Place a SINGLE already-imported section-type code component on a page. Use this ONLY when adding exactly one section. If you are adding more than one section — or building/populating a page — call `add_sections_to_page` instead: it places them all AND fills their props in ONE call. Calling this tool repeatedly (one section per call) is the slow path and should be avoided. Equivalent to right-clicking the section in the dev-components panel and choosing "Add to Page". Errors if the component is not imported, is not section-type, or the page id is unknown. Use `list_editor_pages` to discover page ids and `list_imported_sections` to discover component ids. After placing, change the section\'s prop values with `update_section_prop` / `update_page_sections` (use `list_page_sections` to get the placement\'s `elementId` and prop names).', {
|
|
3610
|
+
project_root: z
|
|
3611
|
+
.string()
|
|
3612
|
+
.describe("Absolute path to the code-component project."),
|
|
3613
|
+
component_id: z
|
|
3614
|
+
.string()
|
|
3615
|
+
.describe("Imported code component id from `list_imported_sections` — NOT the id in `ikas.config.json` (the two are usually the same but can diverge after a rescaffold)."),
|
|
3616
|
+
page_id: z.string().describe("Target page id (from `list_editor_pages`)."),
|
|
3617
|
+
index: z
|
|
3618
|
+
.number()
|
|
3619
|
+
.int()
|
|
3620
|
+
.nonnegative()
|
|
3621
|
+
.optional()
|
|
3622
|
+
.describe("Zero-based insertion index in the page; appends when omitted."),
|
|
3623
|
+
port: z
|
|
3624
|
+
.number()
|
|
3625
|
+
.optional()
|
|
3626
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3627
|
+
}, async ({ project_root, component_id, page_id, index, port }) => {
|
|
3628
|
+
const args = [
|
|
3629
|
+
"add-to-page",
|
|
3630
|
+
"--component-id",
|
|
3631
|
+
component_id,
|
|
3632
|
+
"--page-id",
|
|
3633
|
+
page_id,
|
|
3634
|
+
...(typeof index === "number" ? ["--index", String(index)] : []),
|
|
3635
|
+
...(port ? ["--port", String(port)] : []),
|
|
3636
|
+
];
|
|
3637
|
+
return callEditorAction(project_root, args);
|
|
3638
|
+
});
|
|
3639
|
+
// Tool: add_sections_to_page
|
|
3640
|
+
server.tool("add_sections_to_page", "Place MANY sections on a page in a SINGLE call — and optionally set each section's prop values AT placement time, so you skip the separate fill step. The fastest way to build a page: one round-trip instead of one add (and one fill) per section. Pass `sections`, each `{ component_id, index?, updates?: [{ prop_name|prop_id, value }] }`; values use the same per-type shapes as update_section_prop / get_editor_workflow. Returns the new `elementId` for each placement (plus written prop results). Built-but-unimported section AND child code components are auto-imported. All update values are validated before anything is placed. Use `list_editor_pages` for page ids and `list_imported_sections` for component ids.", {
|
|
3641
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3642
|
+
page_id: z.string().describe("Target page id (from `list_editor_pages`)."),
|
|
3643
|
+
sections: z
|
|
3644
|
+
.array(z.object({
|
|
3645
|
+
component_id: z.string().describe("Imported (or built) section-type code component id."),
|
|
3646
|
+
index: z
|
|
3647
|
+
.number()
|
|
3648
|
+
.int()
|
|
3649
|
+
.nonnegative()
|
|
3650
|
+
.optional()
|
|
3651
|
+
.describe("Zero-based insertion index; appends when omitted."),
|
|
3652
|
+
updates: z
|
|
3653
|
+
.array(z.object({
|
|
3654
|
+
prop_id: z.string().optional().describe("Blueprint prop id (provide this or prop_name)."),
|
|
3655
|
+
prop_name: z.string().optional().describe("Blueprint prop name (alternative to prop_id)."),
|
|
3656
|
+
value: z.any().describe("Prop value, same shape update_section_prop expects for that type."),
|
|
3657
|
+
}))
|
|
3658
|
+
.optional()
|
|
3659
|
+
.describe("Optional prop values to set on this section right after placing it."),
|
|
3660
|
+
}))
|
|
3661
|
+
.describe("Non-empty array of sections to place (in order), each with its componentId and optional prop updates."),
|
|
3662
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3663
|
+
}, async ({ project_root, page_id, sections, port }) => {
|
|
3664
|
+
const normalized = (sections || []).map(s => ({
|
|
3665
|
+
componentId: s.component_id,
|
|
3666
|
+
...(typeof s.index === "number" ? { index: s.index } : {}),
|
|
3667
|
+
...(s.updates
|
|
3668
|
+
? {
|
|
3669
|
+
updates: s.updates.map(u => ({
|
|
3670
|
+
...(u.prop_id ? { propId: u.prop_id } : {}),
|
|
3671
|
+
...(u.prop_name ? { propName: u.prop_name } : {}),
|
|
3672
|
+
value: u.value,
|
|
3673
|
+
})),
|
|
3674
|
+
}
|
|
3675
|
+
: {}),
|
|
3676
|
+
}));
|
|
3677
|
+
const args = [
|
|
3678
|
+
"add-sections-to-page",
|
|
3679
|
+
"--page-id",
|
|
3680
|
+
page_id,
|
|
3681
|
+
"--sections",
|
|
3682
|
+
JSON.stringify(normalized),
|
|
3683
|
+
...(port ? ["--port", String(port)] : []),
|
|
3684
|
+
];
|
|
3685
|
+
return callEditorAction(project_root, args);
|
|
3686
|
+
});
|
|
3687
|
+
// Tool: list_page_sections
|
|
3688
|
+
server.tool("list_page_sections", "List the sections placed on a page — a LEAN ROSTER that never truncates: per-placement `elementId` (the identity of THIS placement — there can be multiple of the same section), `sectionId`, `componentId`, `name`, `propCount`, and `setPropNames` (which props already have a value). It deliberately omits the prop SCHEMA and the prop VALUES (both can be large — Header alone can have ~80 props). To get a section's prop schema (types, ENUM options, allowed children) call `get_component_props(componentId)`; to read its current values call `get_section_values(element_id)`. Use the returned `elementId` with `update_section_prop` / `update_page_sections`. Use `list_editor_pages` for page ids.", {
|
|
3689
|
+
project_root: z
|
|
3690
|
+
.string()
|
|
3691
|
+
.describe("Absolute path to the code-component project."),
|
|
3692
|
+
page_id: z.string().describe("Target page id (from `list_editor_pages`)."),
|
|
3693
|
+
port: z
|
|
3694
|
+
.number()
|
|
3695
|
+
.optional()
|
|
3696
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3697
|
+
}, async ({ project_root, page_id, port }) => {
|
|
3698
|
+
const args = [
|
|
3699
|
+
"list-page-sections",
|
|
3700
|
+
"--page-id",
|
|
3701
|
+
page_id,
|
|
3702
|
+
...(port ? ["--port", String(port)] : []),
|
|
3703
|
+
];
|
|
3704
|
+
return callEditorAction(project_root, args);
|
|
3705
|
+
});
|
|
3706
|
+
// Tool: get_component_props
|
|
3707
|
+
server.tool("get_component_props", "Get prop blueprints straight from the editor (the source of truth) for one or MANY components in a single call — for any section OR child code component ids. Returns `{ components: [...] }`, each prop carrying its `id`, `name`, `type`, `required`, `default`, and crucially: a ready-to-use `writeExample` (the EXACT value shape to pass to update_section_prop / update_page_sections — e.g. PRODUCT_LIST, BLOG_LIST, COMPONENT_LIST, LINK) plus a `writeNote` for variants, so you do NOT have to guess or trial-write the JSON; for ENUM props the `options` (valid `value`s); and for COMPONENT/COMPONENT_LIST props the `allowedComponentIds` (which children the slot permits — when empty, an `allowedComponentsNote` says any imported code component is allowed). Use this (its `writeExample`/`options`/`allowedComponentIds`) instead of guessing or reading ikas.config.json. Pass ALL the section/child ids you need at once (batch). Child component ids come from a parent prop's `allowedComponentIds` (or get_section_template).", {
|
|
3708
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3709
|
+
component_ids: z
|
|
3710
|
+
.array(z.string())
|
|
3711
|
+
.describe("Section/child code-component ids to resolve (batch). From list_imported_sections or a COMPONENT_LIST prop's allowedComponentIds."),
|
|
3712
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3713
|
+
}, async ({ project_root, component_ids, port }) => {
|
|
3714
|
+
const args = [
|
|
3715
|
+
"get-component-props",
|
|
3716
|
+
"--component-ids",
|
|
3717
|
+
(component_ids || []).join(","),
|
|
3718
|
+
...(port ? ["--port", String(port)] : []),
|
|
3719
|
+
];
|
|
3720
|
+
return callEditorAction(project_root, args);
|
|
3721
|
+
});
|
|
3722
|
+
// Tool: get_section_values
|
|
3723
|
+
server.tool("get_section_values", "Get the CURRENT prop values of one or MANY placed sections (each with its full `propValues` plus blueprint `props` — every prop carrying a `writeExample`/`writeNote` for the exact value shape, plus ENUM `options` and COMPONENT_LIST `allowedComponentIds`). `list_page_sections` is lean and omits values to avoid truncation; use this to read sections' values — needed for read-modify-write of a COMPONENT_LIST, or to inspect the exact stored shape of an existing value. Returns `{ sections: [...] }`. Pass all the elementIds you need at once (batch).", {
|
|
3724
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3725
|
+
page_id: z.string().describe("Target page id (from `list_editor_pages`)."),
|
|
3726
|
+
element_ids: z
|
|
3727
|
+
.array(z.string())
|
|
3728
|
+
.describe("Placed-section elementIds to read (batch). From `list_page_sections`."),
|
|
3729
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3730
|
+
}, async ({ project_root, page_id, element_ids, port }) => {
|
|
3731
|
+
const args = [
|
|
3732
|
+
"get-section-values",
|
|
3733
|
+
"--page-id",
|
|
3734
|
+
page_id,
|
|
3735
|
+
"--element-ids",
|
|
3736
|
+
(element_ids || []).join(","),
|
|
3737
|
+
...(port ? ["--port", String(port)] : []),
|
|
3738
|
+
];
|
|
3739
|
+
return callEditorAction(project_root, args);
|
|
3740
|
+
});
|
|
3741
|
+
// Tool: update_section_prop
|
|
3742
|
+
server.tool("update_section_prop", 'Change a single prop value of a section placed on a page. This is the tool for FILLING/SETTING content (heading, text, image, link, etc.) on an existing section — it is pure data entry: it writes NO component code and needs NO rebuild. Do not author a new prop or component to set a value the section already supports; first check the section\'s existing `props` via `list_page_sections`. Target the specific placement by its `element_id` (from `list_page_sections`) and the prop by `prop_id` or `prop_name` (also from `list_page_sections`). `value` is the prop value object as stored by the editor — for scalar props it is wrapped as `{ "value": <scalar> }` (e.g. `{ "value": "Hello" }` for TEXT, `{ "value": true }` for BOOLEAN, `{ "value": 12 }` for NUMBER, `{ "value": "#FF0000" }` for COLOR, `{ "value": "<enum-key>" }` for ENUM). Richer object prop types use their own object shape and are NOT `{ "value": ... }`-wrapped (full catalog in `get_editor_workflow`): IMAGE = `{ "id": "<asset-id>", "altText"?: "<alt>", "isVideo"?: false }` (the `id` MUST reference an already-uploaded asset — call `upload_image` with a `file_path`/`image_url` to get one, or reuse an existing `id` from another section\'s `propValues`); IMAGE_LIST = `{ "images": [ <image>, ... ] }`; VIDEO = `{ "video": { "id": "<asset-id>" }, "thumbnailImage"?: { "id": "..." }, "autoplay"?: false, "controls"?: true, "loop"?: false, "muted"?: false }` (NOT a bare `{ "id": ... }`); SVG = `{ "value": "<svg markup>" }` (value-wrapped, like a scalar); SVG_LIST = `{ "svgs": [ "<svg>", ... ] }`; entity props PRODUCT/CATEGORY/BRAND/BLOG/BLOG_CATEGORY/RAFFLE = `{ "<entity>Id": "...", "usePageData"?: false }` (e.g. `{ "categoryId": "..." }`) — get real ids from `search_products` (PRODUCT), `list_categories`, `list_brands`, `list_blogs`, `list_blog_categories`; list/collection props are typed objects keyed by a `<entity>ListType` discriminator: PRODUCT_LIST = `{ "id": "<unique>", "productListType": "STATIC", "productIds": [ { "productId": "...", "variantId": "..." } ], "initialLimit"?: 12 }` — note productIds is an array of {productId, variantId} PAIRS (from search_products), not bare ids; productListType ∈ ALL|STATIC|DISCOUNTED|RECOMMENDED|CATEGORY|SEARCH|LAST_VIEWED|RELATED_PRODUCTS|VIEWED_TOGETHER|PURCHASED_TOGETHER, and for a dynamic type use e.g. `{ "id": "<unique>", "productListType": "CATEGORY", "category": "<categoryId>" }` (no productIds) or `"ALL"` (no ids). CATEGORY_LIST = `{ "categoryListType": "STATIC", "categoryIds": ["..."] }` or `{ "categoryListType": "ALL" }`. BRAND_LIST = `{ "brandListType": "STATIC", "brandIds": ["..."] }` or ALL. BLOG_LIST = `{ "blogListType": "STATIC", "blogIds": ["..."] }`, `{ "blogListType": "CATEGORY", "categoryId": "..." }`, or ALL. BLOG_CATEGORY_LIST = `{ "blogCategoryListType": "STATIC", "blogCategoryIds": ["..."] }` or ALL. (Get the entity ids from search_products / list_*; you can also read an existing value with `get_section_values` to copy its exact shape.) LINK = a single link object `{ "id": "<unique-short-id>", "linkType": "PAGE"|"EXTERNAL"|"FILE", "label": "...", "openInNewTab"?: false, "subLinks": [] }` plus the target for its type — for PAGE add `"pageId"` AND `"pageType"` (both from `list_editor_pages`, e.g. pageType "INDEX"; for dynamic page types like PRODUCT/CATEGORY/BLOG also add the target `"itemId"`), for EXTERNAL add `"externalLink": "https://..."`. Examples: PAGE → `{ "id": "k3p9x", "linkType": "PAGE", "label": "Home", "pageId": "<page-id>", "pageType": "INDEX", "openInNewTab": false, "subLinks": [] }`; EXTERNAL → `{ "id": "m7q2z", "linkType": "EXTERNAL", "label": "Docs", "externalLink": "https://example.com", "openInNewTab": true, "subLinks": [] }`. To link to an ENTITY (category/brand/blog/blog-category) do NOT guess a slug — get the entity id from `list_categories`/`list_brands`/`list_blogs`/`list_blog_categories` and the page id from `get_page_by_type("<TYPE>")`, then build `{ "id": "<unique>", "linkType": "PAGE", "label": "...", "pageId": <pageId>, "pageType": "<TYPE>", "itemId": <entityId>, "subLinks": [] }`. LIST_OF_LINK = `{ "links": [ <link>, ... ] }` (each item is a link object as above). PRODUCT = `{ "productId": "...", "variantId"?: "..." }`. This SAME unwrapped shape applies whether the prop sits at section level OR nested inside a COMPONENT_LIST entry\'s `propValues` — there is no section-vs-nested difference. IMPORTANT: pass `value` as the parsed JSON object/array itself, NEVER as a JSON string (a stringified value is double-encoded and stored as a useless string). Values are validated server-side (deeply, including nested COMPONENT_LIST children): wrong shapes AND wrong semantics are REJECTED with an explanatory error instead of being silently stored. This includes: a `{ "value": [...] }` wrapper for a COMPONENT_LIST; a `{ "value": ... }`-wrapped IMAGE; `props` instead of `propValues`; a missing/duplicate entry `id`; a child referenced by the wrong key (a code component MUST use `codeComponentId`, a theme component `componentId`) or by an id that does not exist (child ids are opaque — take them from `get_section_template` / `list_imported_sections`, never invent them); and any `propValues` key that is not a real prop of that child component (the error lists the valid prop names). Auto-import: a referenced child code component that has been BUILT but not yet imported into the theme is imported automatically before the value is set (the response lists any such ids under `autoImported`); only children that are not built at all fail with a "no imported code component" error — build them first (`ikas-component build`/`dev`). For any prop type you are unsure about, inspect the existing value with `get_section_values` and match its exact shape. The change is applied with undo support.\n\n' +
|
|
3743
|
+
'COMPONENT_LIST / COMPONENT props: the value is NOT wrapped in `{ "value": ... }`. A COMPONENT_LIST value is `{ "components": [ <entry>, ... ] }`; a single COMPONENT value is one `<entry>`. Each entry = `{ "id": "<unique-id>", "codeComponentId": "<child-id>" | "componentId": "<child-id>", "propValues": { "<childPropName>": <wrapped-value>, ... } }`. Rules: (1) `id` is a unique short alphanumeric string identifying THIS entry — generate a fresh one per new entry and NEVER reuse an existing entry\'s id. (2) Use `codeComponentId` for code components, `componentId` for built-in theme components. (3) `propValues` is keyed by the CHILD component\'s prop NAMES, each using the same scalar wrappers as above (nesting is recursive — a child may itself hold a COMPONENT_LIST). (4) `update_section_prop` REPLACES the whole prop value — there is NO partial/deep merge. ALWAYS send the COMPLETE, fully-nested value for the prop: every existing entry (with its id), every nested `propValues`, and every nested COMPONENT_LIST at every depth. To change anything (even one deeply-nested scalar, or to add/remove/reorder a child), READ-MODIFY-WRITE: take the current `{ "components": [...] }` from `get_section_values`, edit it in place (preserving all other entries, ids, and nested structures), then send the ENTIRE updated object back. Sending only the changed part — a single entry, or a child without its siblings — wipes everything you omitted. (5) You can only add child component types the prop permits — call `get_component_props(parentComponentId)` to read the COMPONENT_LIST prop\'s `allowedComponentIds`, then `get_component_props(childId)` to learn that child\'s props (names, types, ENUM `options`/valid values) instead of guessing or reading ikas.config.json. The allowed set is wired at build/config time per the `get_section_template` setup recipe (`config update-prop`), not here.\n\n' +
|
|
3744
|
+
'Example — a full COMPONENT_LIST `value` with two children, where the second child itself nests another COMPONENT_LIST (note: scalar leaves are `{ "value": ... }`-wrapped, COMPONENT_LIST values are `{ "components": [...] }` and are NOT wrapped, every entry has a unique `id`, and this is the COMPLETE value you would send even to change just one field): ' +
|
|
3745
|
+
`{ "components": [ { "id": "a1b2c", "codeComponentId": "7ojrigep-Eml9n5sN3i", "propValues": { "heading": { "value": "Featured" }, "visible": { "value": true } } }, { "id": "d3e4f", "codeComponentId": "x2plk9zq-Qw8rt", "propValues": { "title": { "value": "Sub group" }, "cards": { "components": [ { "id": "g5h6i", "codeComponentId": "card01ab-Zz12", "propValues": { "label": { "value": "Card 1" } } }, { "id": "j7k8l", "codeComponentId": "card01ab-Zz12", "propValues": { "label": { "value": "Card 2" } } } ] } } } ] }`, {
|
|
3746
|
+
project_root: z
|
|
3747
|
+
.string()
|
|
3748
|
+
.describe("Absolute path to the code-component project."),
|
|
3749
|
+
page_id: z.string().describe("Target page id (from `list_editor_pages`)."),
|
|
3750
|
+
element_id: z
|
|
3751
|
+
.string()
|
|
3752
|
+
.describe("Placed-section elementId identifying THIS placement on the page (from `list_page_sections`)."),
|
|
3753
|
+
prop_id: z
|
|
3754
|
+
.string()
|
|
3755
|
+
.optional()
|
|
3756
|
+
.describe("Blueprint prop id to update (from `list_page_sections`). Provide this or `prop_name`."),
|
|
3757
|
+
prop_name: z
|
|
3758
|
+
.string()
|
|
3759
|
+
.optional()
|
|
3760
|
+
.describe("Blueprint prop name to update (alternative to `prop_id`)."),
|
|
3761
|
+
value: z
|
|
3762
|
+
.any()
|
|
3763
|
+
.describe('The prop value object to store, e.g. `{ "value": "Hello" }`. Match the shape of the existing value from `get_section_values` for non-scalar prop types.'),
|
|
3764
|
+
port: z
|
|
3765
|
+
.number()
|
|
3766
|
+
.optional()
|
|
3767
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3768
|
+
}, async ({ project_root, page_id, element_id, prop_id, prop_name, value, port }) => {
|
|
3769
|
+
const args = [
|
|
3770
|
+
"update-section-prop",
|
|
3771
|
+
"--page-id",
|
|
3772
|
+
page_id,
|
|
3773
|
+
"--element-id",
|
|
3774
|
+
element_id,
|
|
3775
|
+
...(prop_id ? ["--prop-id", prop_id] : []),
|
|
3776
|
+
...(prop_name ? ["--prop-name", prop_name] : []),
|
|
3777
|
+
"--value",
|
|
3778
|
+
// The CLI JSON.parses --value. If `value` is already a JSON string, pass
|
|
3779
|
+
// it through verbatim — re-stringifying it would double-encode it and the
|
|
3780
|
+
// editor would store a string instead of the object/array.
|
|
3781
|
+
typeof value === "string" ? value : JSON.stringify(value),
|
|
3782
|
+
...(port ? ["--port", String(port)] : []),
|
|
3783
|
+
];
|
|
3784
|
+
return callEditorAction(project_root, args);
|
|
3785
|
+
});
|
|
3786
|
+
// Tool: upload_image
|
|
3787
|
+
server.tool("upload_image", "Upload an image to the connected editor's project and get back its image `id`. Provide the image via `file_path` (a local path) OR `image_url`. Use the returned `id` as the `id` of an IMAGE prop value passed to `update_section_prop` (e.g. `{ \"id\": \"<returned-id>\", \"altText\": \"...\", \"isVideo\": false }`). This is the way to set an image prop — `update_section_prop` does not upload, it only references an existing image id. Supported types: png, jpg, jpeg, webp, gif; max 10MB. Requires the editor to be embedded in the ikas admin panel (the admin panel performs the actual upload; a standalone editor cannot upload and will error/time out).", {
|
|
3788
|
+
project_root: z
|
|
3789
|
+
.string()
|
|
3790
|
+
.describe("Absolute path to the code-component project."),
|
|
3791
|
+
file_path: z
|
|
3792
|
+
.string()
|
|
3793
|
+
.optional()
|
|
3794
|
+
.describe("Local image file path (.png, .jpg, .jpeg, .webp, .gif). Provide this or `image_url`."),
|
|
3795
|
+
image_url: z
|
|
3796
|
+
.string()
|
|
3797
|
+
.optional()
|
|
3798
|
+
.describe("Image URL to fetch and upload (alternative to `file_path`)."),
|
|
3799
|
+
alt_text: z.string().optional().describe("Alt text to store with the image."),
|
|
3800
|
+
port: z
|
|
3801
|
+
.number()
|
|
3802
|
+
.optional()
|
|
3803
|
+
.describe("Dev server WebSocket port (default 5201)."),
|
|
3804
|
+
}, async ({ project_root, file_path, image_url, alt_text, port }) => {
|
|
3805
|
+
const args = [
|
|
3806
|
+
"upload-image",
|
|
3807
|
+
...(file_path ? ["--file", file_path] : []),
|
|
3808
|
+
...(image_url ? ["--url", image_url] : []),
|
|
3809
|
+
...(alt_text ? ["--alt", alt_text] : []),
|
|
3810
|
+
...(port ? ["--port", String(port)] : []),
|
|
3811
|
+
];
|
|
3812
|
+
return callEditorAction(project_root, args);
|
|
3813
|
+
});
|
|
3814
|
+
// Tool: update_page_sections
|
|
3815
|
+
server.tool("update_page_sections", "Fill MANY placed sections of a page in a SINGLE call — the fastest way to populate a whole page (one round-trip for the entire page instead of one call per section/prop). Takes `sections`, each `{ element_id, updates: [{ prop_name|prop_id, value }] }`; values use the same per-type shapes as update_section_prop / get_editor_workflow. All-or-nothing across the whole page: every value is resolved and deeply validated (and built-but-unimported child code components auto-imported) before anything is written — one invalid value rejects the entire page update. Prefer this over many update_section_prop(s) calls.", {
|
|
3816
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3817
|
+
page_id: z.string().describe("Target page id (from list_editor_pages)."),
|
|
3818
|
+
sections: z
|
|
3819
|
+
.array(z.object({
|
|
3820
|
+
element_id: z.string().describe("Placed-section elementId (from list_page_sections)."),
|
|
3821
|
+
updates: z
|
|
3822
|
+
.array(z.object({
|
|
3823
|
+
prop_id: z.string().optional().describe("Blueprint prop id (provide this or prop_name)."),
|
|
3824
|
+
prop_name: z.string().optional().describe("Blueprint prop name (alternative to prop_id)."),
|
|
3825
|
+
value: z.any().describe("Prop value, same shape update_section_prop expects for that type."),
|
|
3826
|
+
}))
|
|
3827
|
+
.describe("Non-empty array of prop updates for this section."),
|
|
3828
|
+
}))
|
|
3829
|
+
.describe("Non-empty array of sections to fill, each with its elementId and prop updates."),
|
|
3830
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3831
|
+
}, async ({ project_root, page_id, sections, port }) => {
|
|
3832
|
+
const normalized = (sections || []).map(s => ({
|
|
3833
|
+
elementId: s.element_id,
|
|
3834
|
+
updates: (s.updates || []).map(u => ({
|
|
3835
|
+
...(u.prop_id ? { propId: u.prop_id } : {}),
|
|
3836
|
+
...(u.prop_name ? { propName: u.prop_name } : {}),
|
|
3837
|
+
value: u.value,
|
|
3838
|
+
})),
|
|
3839
|
+
}));
|
|
3840
|
+
const args = [
|
|
3841
|
+
"update-page-sections",
|
|
3842
|
+
"--page-id",
|
|
3843
|
+
page_id,
|
|
3844
|
+
"--sections",
|
|
3845
|
+
JSON.stringify(normalized),
|
|
3846
|
+
...(port ? ["--port", String(port)] : []),
|
|
3847
|
+
];
|
|
3848
|
+
return callEditorAction(project_root, args);
|
|
3849
|
+
});
|
|
3850
|
+
// Tool: upload_images
|
|
3851
|
+
server.tool("upload_images", "Upload MANY images in one call (batch upload_image) and get their ids back in order — the host uploads them all in a single round-trip. Pass `images`, each `{ file_path?, image_url?, alt_text? }`. Returns an array of { id, fileName, altText, isVideo } in the same order; use each id in an IMAGE prop value. Prefer this over multiple upload_image calls when a section/page needs several images. Supported: png/jpg/jpeg/webp/gif, max 10MB each. Requires the editor embedded in the ikas admin panel.", {
|
|
3852
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3853
|
+
images: z
|
|
3854
|
+
.array(z.object({
|
|
3855
|
+
file_path: z.string().optional().describe("Local image file path (provide this or image_url)."),
|
|
3856
|
+
image_url: z.string().optional().describe("Image URL to fetch (alternative to file_path)."),
|
|
3857
|
+
alt_text: z.string().optional().describe("Alt text for this image."),
|
|
3858
|
+
}))
|
|
3859
|
+
.describe("Non-empty array of images to upload."),
|
|
3860
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3861
|
+
}, async ({ project_root, images, port }) => {
|
|
3862
|
+
const manifest = (images || []).map(im => ({
|
|
3863
|
+
...(im.file_path ? { file: im.file_path } : {}),
|
|
3864
|
+
...(im.image_url ? { url: im.image_url } : {}),
|
|
3865
|
+
...(im.alt_text ? { alt: im.alt_text } : {}),
|
|
3866
|
+
}));
|
|
3867
|
+
const args = [
|
|
3868
|
+
"upload-images",
|
|
3869
|
+
"--manifest",
|
|
3870
|
+
JSON.stringify(manifest),
|
|
3871
|
+
...(port ? ["--port", String(port)] : []),
|
|
3872
|
+
];
|
|
3873
|
+
return callEditorAction(project_root, args);
|
|
3874
|
+
});
|
|
3875
|
+
// Tool: search_products
|
|
3876
|
+
server.tool("search_products", "Search the connected store's products to obtain a real productId (and first variantId) for a PRODUCT prop value. Returns products with productId, variantId, name, slug, variantCount, and `imageSrc` (the full-resolution CDN URL of the product's main image). To use that product image in an IMAGE prop, you CANNOT reuse a product image id directly (it is not a theme asset) — pass the `imageSrc` URL to `upload_image(image_url: <imageSrc>)` (or `upload_images`), then use the returned id in the IMAGE value. This gives real product imagery instead of external/placeholder URLs. Use the result in update_section_prop as `{ \"productId\": \"<productId>\", \"variantId\": \"<variantId>\" }`. Pass `query` for free-text search, or `product_ids` to resolve specific ids. Requires the editor embedded in the ikas admin panel (the admin panel runs the search; a standalone editor cannot).", {
|
|
3877
|
+
project_root: z
|
|
3878
|
+
.string()
|
|
3879
|
+
.describe("Absolute path to the code-component project."),
|
|
3880
|
+
query: z.string().optional().describe("Free-text product search (name, sku, barcode)."),
|
|
3881
|
+
product_ids: z
|
|
3882
|
+
.array(z.string())
|
|
3883
|
+
.optional()
|
|
3884
|
+
.describe("Specific product ids to resolve directly (alternative to `query`)."),
|
|
3885
|
+
per_page: z.number().optional().describe("Results per page."),
|
|
3886
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3887
|
+
}, async ({ project_root, query, product_ids, per_page, port }) => {
|
|
3888
|
+
const args = [
|
|
3889
|
+
"search-products",
|
|
3890
|
+
...(query ? ["--query", query] : []),
|
|
3891
|
+
...(product_ids && product_ids.length ? ["--ids", product_ids.join(",")] : []),
|
|
3892
|
+
...(typeof per_page === "number" ? ["--per-page", String(per_page)] : []),
|
|
3893
|
+
...(port ? ["--port", String(port)] : []),
|
|
3894
|
+
];
|
|
3895
|
+
return callEditorAction(project_root, args);
|
|
3896
|
+
});
|
|
3897
|
+
// Tool: list_categories
|
|
3898
|
+
server.tool("list_categories", "List the store's product categories and their ids, to fill a CATEGORY prop value `{ \"categoryId\": \"<id>\" }`. Returns categoryId, name, slug, parentId for each. Returns all categories (no query). To link to a category from a LINK prop, also call `get_page_by_type(\"CATEGORY\")` for the page id, then build `{ \"linkType\": \"PAGE\", \"pageId\": <pageId>, \"pageType\": \"CATEGORY\", \"itemId\": <categoryId>, \"id\": <unique>, \"label\": \"...\" }`. Requires the editor embedded in the ikas admin panel.", {
|
|
3899
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3900
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3901
|
+
}, async ({ project_root, port }) => {
|
|
3902
|
+
const args = ["list-entities", "--kind", "category", ...(port ? ["--port", String(port)] : [])];
|
|
3903
|
+
return callEditorAction(project_root, args);
|
|
3904
|
+
});
|
|
3905
|
+
// Tool: list_brands
|
|
3906
|
+
server.tool("list_brands", "List the store's product brands and their ids, to fill a BRAND prop value `{ \"brandId\": \"<id>\" }`. Returns brandId, name, slug for each. Returns all brands (no query). To link to a brand from a LINK prop, also call `get_page_by_type(\"BRAND\")` for the page id, then build `{ \"linkType\": \"PAGE\", \"pageId\": <pageId>, \"pageType\": \"BRAND\", \"itemId\": <brandId>, \"id\": <unique>, \"label\": \"...\" }`. Requires the editor embedded in the ikas admin panel.", {
|
|
3907
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3908
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3909
|
+
}, async ({ project_root, port }) => {
|
|
3910
|
+
const args = ["list-entities", "--kind", "brand", ...(port ? ["--port", String(port)] : [])];
|
|
3911
|
+
return callEditorAction(project_root, args);
|
|
3912
|
+
});
|
|
3913
|
+
// Tool: list_blogs
|
|
3914
|
+
server.tool("list_blogs", "List the store's blogs and their ids, to fill a BLOG prop value `{ \"blogId\": \"<id>\" }`. Returns blogId, name, slug for each. Accepts an optional `query` for free-text search. To link to a blog from a LINK prop, also call `get_page_by_type(\"BLOG\")` for the page id, then build `{ \"linkType\": \"PAGE\", \"pageId\": <pageId>, \"pageType\": \"BLOG\", \"itemId\": <blogId>, \"id\": <unique>, \"label\": \"...\" }`. Requires the editor embedded in the ikas admin panel.", {
|
|
3915
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3916
|
+
query: z.string().optional().describe("Free-text blog search."),
|
|
3917
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3918
|
+
}, async ({ project_root, query, port }) => {
|
|
3919
|
+
const args = [
|
|
3920
|
+
"list-entities",
|
|
3921
|
+
"--kind",
|
|
3922
|
+
"blog",
|
|
3923
|
+
...(query ? ["--query", query] : []),
|
|
3924
|
+
...(port ? ["--port", String(port)] : []),
|
|
3925
|
+
];
|
|
3926
|
+
return callEditorAction(project_root, args);
|
|
3927
|
+
});
|
|
3928
|
+
// Tool: list_blog_categories
|
|
3929
|
+
server.tool("list_blog_categories", "List the store's blog categories and their ids, to fill a BLOG_CATEGORY prop value `{ \"blogCategoryId\": \"<id>\" }`. Returns blogCategoryId, name, slug for each. Accepts an optional `query` for free-text search. To link to a blog category from a LINK prop, also call `get_page_by_type(\"BLOG_CATEGORY\")` for the page id, then build `{ \"linkType\": \"PAGE\", \"pageId\": <pageId>, \"pageType\": \"BLOG_CATEGORY\", \"itemId\": <blogCategoryId>, \"id\": <unique>, \"label\": \"...\" }`. Requires the editor embedded in the ikas admin panel.", {
|
|
3930
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3931
|
+
query: z.string().optional().describe("Free-text blog-category search."),
|
|
3932
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3933
|
+
}, async ({ project_root, query, port }) => {
|
|
3934
|
+
const args = [
|
|
3935
|
+
"list-entities",
|
|
3936
|
+
"--kind",
|
|
3937
|
+
"blog-category",
|
|
3938
|
+
...(query ? ["--query", query] : []),
|
|
3939
|
+
...(port ? ["--port", String(port)] : []),
|
|
3940
|
+
];
|
|
3941
|
+
return callEditorAction(project_root, args);
|
|
3942
|
+
});
|
|
3943
|
+
// Tool: get_page_by_type
|
|
3944
|
+
server.tool("get_page_by_type", "Resolve a theme page's id from its pageType (CATEGORY, PRODUCT, BRAND, BLOG, BLOG_CATEGORY, INDEX, …). Use this to get the `pageId` needed to build a PAGE link to an entity: pair it with the entity id from list_categories/list_brands/list_blogs/list_blog_categories — `{ linkType:\"PAGE\", pageId:<this pageId>, pageType:<type>, itemId:<entityId>, id:<unique>, label:... }`. Returns `pageId: null` (with a note) if no page of that type exists yet — in that case call `create_page(page_type)` to add it, then use the returned pageId (do not guess a slug/EXTERNAL URL).", {
|
|
3945
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3946
|
+
page_type: z
|
|
3947
|
+
.string()
|
|
3948
|
+
.describe("Page type to resolve, e.g. CATEGORY, PRODUCT, BRAND, BLOG, BLOG_CATEGORY, INDEX."),
|
|
3949
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3950
|
+
}, async ({ project_root, page_type, port }) => {
|
|
3951
|
+
const args = [
|
|
3952
|
+
"get-page-by-type",
|
|
3953
|
+
"--page-type",
|
|
3954
|
+
page_type,
|
|
3955
|
+
...(port ? ["--port", String(port)] : []),
|
|
3956
|
+
];
|
|
3957
|
+
return callEditorAction(project_root, args);
|
|
3958
|
+
});
|
|
3959
|
+
// Tool: create_page
|
|
3960
|
+
server.tool("create_page", "Create a theme page of a given pageType in the connected editor. Use this when get_page_by_type returns `pageId: null` for a dynamic page (CATEGORY/PRODUCT/BRAND/BLOG/BLOG_CATEGORY) you need to link to: create the page, then build a PAGE link `{ linkType:\"PAGE\", pageId:<this pageId>, pageType:<type>, itemId:<entityId>, id:<unique>, label:... }` — do NOT guess a slug/EXTERNAL URL. Non-CUSTOM page types are unique per theme: if one already exists it is returned unchanged (`alreadyExisted: true`). CUSTOM pages require `name` and a unique `slug`. Account sub-pages (ADDRESSES/ORDERS/ORDER_DETAIL/FAVORITE_PRODUCTS/RAFFLE_ACCOUNT) need an ACCOUNT page first. Returns `{ pageType, pageId, name, slug }`. Requires `ikas-component dev` running with the editor connected.", {
|
|
3961
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3962
|
+
page_type: z
|
|
3963
|
+
.string()
|
|
3964
|
+
.describe("Page type to create, e.g. CATEGORY, PRODUCT, BRAND, BLOG, BLOG_CATEGORY, INDEX, CUSTOM."),
|
|
3965
|
+
name: z.string().optional().describe("Page name. Required for CUSTOM pages; ignored otherwise."),
|
|
3966
|
+
slug: z.string().optional().describe("Page slug. Required (and unique) for CUSTOM pages; ignored otherwise."),
|
|
3967
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3968
|
+
}, async ({ project_root, page_type, name, slug, port }) => {
|
|
3969
|
+
const args = [
|
|
3970
|
+
"create-page",
|
|
3971
|
+
"--page-type",
|
|
3972
|
+
page_type,
|
|
3973
|
+
...(name ? ["--name", name] : []),
|
|
3974
|
+
...(slug ? ["--slug", slug] : []),
|
|
3975
|
+
...(port ? ["--port", String(port)] : []),
|
|
3976
|
+
];
|
|
3977
|
+
return callEditorAction(project_root, args);
|
|
3978
|
+
});
|
|
3979
|
+
// Tool: publish_theme
|
|
3980
|
+
server.tool("publish_theme", "Publish the current theme LIVE — the same action as the editor's Publish button (uploads the whole project to the storefront). This is REAL and customer-facing: the published site changes. SAFETY: it publishes nothing unless `confirm: true` is passed; if you omit it you get a dry-run with the `previewUrl` and a warning describing the impact. The MAIN/production theme additionally requires `confirm_production: true` (its URL is the live customer-facing domain). Use this when the user explicitly asks to publish/go live — do NOT publish on your own initiative. On success returns `{ published: true, previewUrl, isMainTheme }`; open `previewUrl` to review the result. Requires `ikas-component dev` running with the editor connected.", {
|
|
3981
|
+
project_root: z.string().describe("Absolute path to the code-component project."),
|
|
3982
|
+
confirm: z
|
|
3983
|
+
.boolean()
|
|
3984
|
+
.optional()
|
|
3985
|
+
.describe("Set true to actually publish. Omitted/false = dry-run (returns previewUrl + warning, publishes nothing)."),
|
|
3986
|
+
confirm_production: z
|
|
3987
|
+
.boolean()
|
|
3988
|
+
.optional()
|
|
3989
|
+
.describe("Required IN ADDITION to confirm when the target is the MAIN/production theme (live customer-facing site)."),
|
|
3990
|
+
port: z.number().optional().describe("Dev server WebSocket port (default 5201)."),
|
|
3991
|
+
}, async ({ project_root, confirm, confirm_production, port }) => {
|
|
3992
|
+
const args = [
|
|
3993
|
+
"publish-theme",
|
|
3994
|
+
...(confirm ? ["--confirm"] : []),
|
|
3995
|
+
...(confirm_production ? ["--confirm-production"] : []),
|
|
3996
|
+
...(port ? ["--port", String(port)] : []),
|
|
3997
|
+
];
|
|
3998
|
+
return callEditorAction(project_root, args);
|
|
3999
|
+
});
|
|
4000
|
+
// Tool: get_editor_workflow
|
|
4001
|
+
const EDITOR_WORKFLOW_GUIDE = [
|
|
4002
|
+
"# Editor workflow: placing sections and filling their content on a page",
|
|
4003
|
+
"",
|
|
4004
|
+
"Use this when the user wants to add a section to a page and/or fill in its content (heading, text, image, link, slides, etc.) in the live editor. These are LIVE-EDITOR actions and require `ikas-component dev` running with the editor connected; image upload additionally requires the editor to be embedded in the ikas admin panel (the admin panel performs the upload — a standalone editor cannot upload).",
|
|
4005
|
+
"",
|
|
4006
|
+
"## Two distinct jobs — do not confuse them",
|
|
4007
|
+
"- (A) DEFINE props / author component code — changing WHICH props a component has. Edits component source/config (config add-prop/add-component, index.tsx) and needs a rebuild. Do this ONLY when a needed prop does not exist yet, or the user explicitly asks to build/modify the component.",
|
|
4008
|
+
"- (B) SET prop VALUES / fill content — giving values to props that ALREADY exist on a placed section. Pure data entry via list_page_sections + update_section_prop (+ upload_image). No code, no rebuild.",
|
|
4009
|
+
"When the user says 'fill this section', 'set the title/text/image/link', 'populate', 'change the content' → that is JOB (B). Do NOT write a component or add a prop to fill a value the section already supports.",
|
|
4010
|
+
"",
|
|
4011
|
+
"## Step-by-step (JOB B — fill content)",
|
|
4012
|
+
"1. list_editor_pages → choose the target page_id.",
|
|
4013
|
+
"2. list_page_sections(page_id) → for each placed section: its per-placement elementId, blueprint props (id, name, type), and setPropNames (which props already have a value). It is LEAN — no prop VALUES, so it never truncates. To read a section's current values (e.g. to read-modify-write a COMPONENT_LIST), call get_section_values(page_id, element_id). (If the section is not on the page yet, see 'Placing a section' below.)",
|
|
4014
|
+
"3. To set props (fewest round-trips = fastest): update_page_sections(page_id, sections:[{element_id, updates:[{prop_name,value}]}]) fills the WHOLE page (or one section, or just one prop — it scales to all cases) in ONE call (best). update_section_prop sets a single prop, for quick one-offs. Pass each value as a parsed JSON object/array, NEVER a JSON string.",
|
|
4015
|
+
"4. For image props: upload_images(images:[{file_path|image_url, alt_text}]) uploads many in ONE call (preferred); upload_image for a single one. Use the returned id(s) in IMAGE values. Do uploads BEFORE the update call so you have the ids.",
|
|
4016
|
+
"Speed tip: each tool call is a round-trip — gather first (one list_page_sections), batch your uploads (upload_images) and your writes (update_page_sections), rather than calling per-prop/per-image.",
|
|
4017
|
+
"",
|
|
4018
|
+
"## Building a whole page fast (placing + filling)",
|
|
4019
|
+
"- add_sections_to_page(page_id, sections:[{component_id, index?, updates:[{prop_name,value}]}]) places MANY sections AND sets their props in ONE call, returning each new elementId. This is the fastest path — prefer it over add_section_to_page per section followed by separate fills. Built-but-unimported section/child components are auto-imported.",
|
|
4020
|
+
"- For a single section: list_imported_sections (confirm imported; else import_section, after building) → add_section_to_page(component_id, page_id, index?) → then list_page_sections to get its elementId.",
|
|
4021
|
+
"",
|
|
4022
|
+
"## Value shapes by prop type (what to pass as `value`)",
|
|
4023
|
+
"- Scalars are WRAPPED: TEXT/RICH_TEXT { \"value\": \"...\" }, BOOLEAN { \"value\": true }, NUMBER { \"value\": 12 }, COLOR { \"value\": \"#FF0000\" }, ENUM { \"value\": \"<key>\" }, DATE { \"value\": ... }.",
|
|
4024
|
+
"- SVG is value-wrapped: { \"value\": \"<svg markup>\" }. NUMBER_RANGE: { \"value\": <number>, \"unit\": \"px\"|null }.",
|
|
4025
|
+
"- Object props are NOT wrapped (no { \"value\": ... }):",
|
|
4026
|
+
" - IMAGE: { \"id\": \"<asset-id>\", \"altText\"?: \"...\", \"isVideo\"?: false } — get the id from upload_image. Same shape at section level AND nested in a component list. IMAGE_LIST: { \"images\": [ <image>, ... ] }.",
|
|
4027
|
+
" - VIDEO: { \"video\": { \"id\": \"<asset-id>\" }, \"thumbnailImage\"?: { \"id\": \"...\" }, \"autoplay\"?: false, \"controls\"?: true, \"loop\"?: false, \"muted\"?: false } — NOT a bare { \"id\": ... }. SVG_LIST: { \"svgs\": [ \"<svg>\", ... ] }.",
|
|
4028
|
+
" - LINK: { \"id\": \"<unique>\", \"linkType\": \"PAGE\"|\"EXTERNAL\"|\"FILE\", \"label\": \"...\", \"subLinks\": [] } plus target — for a static page: pageId + pageType (from list_editor_pages); for EXTERNAL: externalLink. To link to a CATEGORY/BRAND/BLOG/BLOG_CATEGORY entity, do NOT guess a slug — get the entity id from list_categories/list_brands/list_blogs/list_blog_categories and the page id from get_page_by_type('<TYPE>'), then build { id, linkType:'PAGE', label, pageId:<pageId>, pageType:'<TYPE>', itemId:<entityId>, subLinks:[] }. LIST_OF_LINK = { \"links\": [ <link>, ... ] }.",
|
|
4029
|
+
" - Entity props PRODUCT/CATEGORY/BRAND/BLOG/BLOG_CATEGORY/RAFFLE: { \"<entity>Id\": \"...\", \"usePageData\"?: false } — e.g. { \"productId\": \"...\", \"variantId\"?: \"...\" }, { \"categoryId\": \"...\" }. Get real ids (never invent them) from: search_products (PRODUCT), list_categories (CATEGORY), list_brands (BRAND), list_blogs (BLOG), list_blog_categories (BLOG_CATEGORY). (RAFFLE has no lookup tool yet — read an existing value or ask the user.)",
|
|
4030
|
+
" - List/collection props (PRODUCT_LIST/CATEGORY_LIST/BRAND_LIST/BLOG_LIST/…): complex typed objects (a <entity>ListType plus initialSort/initialLimit and static ids). Do NOT build from scratch — read the current value with get_section_values and edit it.",
|
|
4031
|
+
" - COMPONENT_LIST: { \"components\": [ { \"id\": \"<unique>\", \"codeComponentId\": \"<child-id>\", \"propValues\": { \"<childProp>\": <value>, ... } }, ... ] }. A single COMPONENT prop is one such entry. childProp values use these same per-type shapes, recursively.",
|
|
4032
|
+
"",
|
|
4033
|
+
"## COMPONENT_LIST rules (the part most often gotten wrong)",
|
|
4034
|
+
"- READ-MODIFY-WRITE: update_section_prop REPLACES the whole prop value. To add/edit/remove one child, take the CURRENT { components: [...] } from get_section_values, edit it, and resend the ENTIRE array (with all existing entries and their ids). Sending only your new entry wipes the rest.",
|
|
4035
|
+
"- Each entry needs a UNIQUE id (a short string you generate; it does not need to match anything). Do not reuse another entry's id.",
|
|
4036
|
+
"- Reference a code component with \"codeComponentId\" and a built-in theme component with \"componentId\" — not the other way around. Use \"propValues\" (not \"props\").",
|
|
4037
|
+
"- Child ids are opaque — take them from get_section_template / list_imported_sections; never invent them.",
|
|
4038
|
+
"- Auto-import: a referenced child that is BUILT but not yet imported is imported automatically (returned under autoImported). A child that is not built at all errors — build it first.",
|
|
4039
|
+
"",
|
|
4040
|
+
"## Reading prop schemas (avoid guessing)",
|
|
4041
|
+
"- get_component_props(componentId) → a component's props with types, required, default, ENUM `options` (the valid values to set), and COMPONENT_LIST `allowedComponentIds` (valid children). Works for any section OR child id. Use it BEFORE filling — to know prop names, enum values, and which children a slot allows — instead of guessing or reading ikas.config.json.",
|
|
4042
|
+
"- For a COMPONENT_LIST: get_component_props(parent) → its allowedComponentIds → get_component_props(child) → the child's props/enums. Then build the components array.",
|
|
4043
|
+
"- get_section_values(element_id) → one placed section's current values (read-modify-write of a COMPONENT_LIST, or to copy an existing value's exact shape).",
|
|
4044
|
+
"- Real entity ids/images: search_products returns productId + variantId + imageSrc (the product image URL). To use that image in an IMAGE prop, you can't reuse a product image id — upload it: upload_image(image_url: imageSrc) → use the returned id. list_categories/list_brands/list_blogs/list_blog_categories return the entity ids; to LINK to one, also call get_page_by_type('<TYPE>') for the page id and build a PAGE link { linkType:'PAGE', pageId, pageType, itemId:<entityId>, id, label }. IMPORTANT: if get_page_by_type returns pageId:null, that dynamic page does NOT exist in the theme yet — do NOT guess a slug/EXTERNAL URL. Call create_page('<TYPE>') to add it (non-CUSTOM types are unique and returned as-is if already present), then use the returned pageId to build the PAGE link. Always have a real pageId before building a PAGE link.",
|
|
4045
|
+
"",
|
|
4046
|
+
"## Validation",
|
|
4047
|
+
"Values are validated server-side (deeply, including nested children). Wrong shape or wrong semantics (double-encoded string, { value } wrapper on an object prop, props vs propValues, missing/duplicate id, wrong reference key, nonexistent component id, unknown prop name) are REJECTED with an explanatory error instead of being stored silently. Read the error and fix the value; if unsure of a shape, read it with get_section_values and match it.",
|
|
4048
|
+
].join("\n");
|
|
4049
|
+
server.tool("get_editor_workflow", "Read this FIRST when the user wants to place a section on a page or fill/edit a section's content (text, image, link, slides, component lists) in the live editor. Returns the complete step-by-step workflow for the live-editor tools (list_editor_pages, list_imported_sections, import_section, add_section_to_page, list_page_sections, update_section_prop, upload_image), the per-prop-type value shapes, the COMPONENT_LIST read-modify-write rules, and how validation/auto-import behave. Use it to avoid the common mistake of writing component code to set a value a section already supports.", {}, async () => {
|
|
4050
|
+
return { content: [{ type: "text", text: EDITOR_WORKFLOW_GUIDE }] };
|
|
4051
|
+
});
|
|
3018
4052
|
// --- Start server ---
|
|
3019
4053
|
async function main() {
|
|
3020
4054
|
const transport = new StdioServerTransport();
|