@se-studio/contentful-cms 1.0.3 → 1.0.5

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.
Files changed (33) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +2 -0
  3. package/dist/bin/cms-capture-screenshots.d.ts +4 -0
  4. package/dist/bin/cms-capture-screenshots.d.ts.map +1 -0
  5. package/dist/bin/cms-capture-screenshots.js +183 -0
  6. package/dist/bin/cms-capture-screenshots.js.map +1 -0
  7. package/dist/bin/cms-generate-collection-guidelines.d.ts +4 -0
  8. package/dist/bin/cms-generate-collection-guidelines.d.ts.map +1 -0
  9. package/dist/bin/cms-generate-collection-guidelines.js +209 -0
  10. package/dist/bin/cms-generate-collection-guidelines.js.map +1 -0
  11. package/dist/bin/cms-generate-field-list.d.ts +4 -0
  12. package/dist/bin/cms-generate-field-list.d.ts.map +1 -0
  13. package/dist/bin/cms-generate-field-list.js +114 -0
  14. package/dist/bin/cms-generate-field-list.js.map +1 -0
  15. package/dist/bin/cms-merge-guidelines.d.ts +4 -0
  16. package/dist/bin/cms-merge-guidelines.d.ts.map +1 -0
  17. package/dist/bin/cms-merge-guidelines.js +147 -0
  18. package/dist/bin/cms-merge-guidelines.js.map +1 -0
  19. package/dist/bin/cms-update-colour-hints.d.ts +4 -0
  20. package/dist/bin/cms-update-colour-hints.d.ts.map +1 -0
  21. package/dist/bin/cms-update-colour-hints.js +111 -0
  22. package/dist/bin/cms-update-colour-hints.js.map +1 -0
  23. package/dist/config/load.js +1 -1
  24. package/dist/config/load.js.map +1 -1
  25. package/package.json +7 -2
  26. package/skills/cms-guidelines/README.md +140 -0
  27. package/skills/cms-guidelines/colour-hint-prompt.md +77 -0
  28. package/skills/cms-guidelines/evaluation-prompt.md +84 -0
  29. package/skills/cms-guidelines/generate-component-guidelines.md +126 -0
  30. package/skills/cms-guidelines/generation-prompt.md +202 -0
  31. package/skills/cms-guidelines/validation-prompt.md +170 -0
  32. package/skills/cms-guidelines/variant-loop.md +184 -0
  33. package/skills/cms-guidelines/variant-proposal-prompt.md +127 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @se-studio/contentful-cms Changelog
2
2
 
3
+ ## 1.0.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Bulk version bump: patch for all packages
8
+
9
+ ## 1.0.4
10
+
11
+ ### Patch Changes
12
+
13
+ - Bulk version bump: patch for all packages
14
+
3
15
  ## 1.0.3
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -231,6 +231,8 @@ Capture a PNG of a component, collection, external component, person, or page. *
231
231
 
232
232
  Use `--out before.png` / `--out after.png` with `agent-browser diff screenshot` for visual diffing. See the **screenshots** skill for details.
233
233
 
234
+ **Batch screenshots:** The `cms-capture-screenshots` script (same package) captures multiple variants to `<app-dir>/docs/cms-guidelines/screenshots/`. Run it from the **monorepo root** so the output path is correct: `node packages/contentful-cms/dist/bin/cms-capture-screenshots.js --variants /tmp/type-variants.json --app-dir apps/example-se2026`.
235
+
234
236
  ### export-converted
235
237
 
236
238
  Export a session ref's entry as **converted (`IBase*`) JSON** via the app's convert API. Use the output with `screenshot --json-file` for custom variants without a session.
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ export {};
4
+ //# sourceMappingURL=cms-capture-screenshots.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-capture-screenshots.d.ts","sourceRoot":"","sources":["../../src/bin/cms-capture-screenshots.ts"],"names":[],"mappings":";AACA,uFAAuF"}
@@ -0,0 +1,183 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ /**
4
+ * cms-capture-screenshots
5
+ *
6
+ * Captures showcase screenshots for one or more CMS types using cms-edit.
7
+ * Screenshots are saved to <app-dir>/docs/cms-guidelines/screenshots/<type>-<label>.png.
8
+ * The path is resolved from process.cwd(), so run from the monorepo root when using --app-dir
9
+ * (e.g. node packages/contentful-cms/dist/bin/cms-capture-screenshots.js --variants ... --app-dir apps/example-se2026).
10
+ *
11
+ * Usage:
12
+ * cms-capture-screenshots --type Hero [--app-dir <path>]
13
+ * cms-capture-screenshots --variants variants.json [--app-dir <path>]
14
+ *
15
+ * Where variants.json follows the output contract from the variant-proposal-prompt:
16
+ * {
17
+ * "typeName": "Hero",
18
+ * "variants": [
19
+ * { "label": "default", "description": "...", "showcaseParams": {} },
20
+ * { "label": "navy", "description": "...", "showcaseParams": { "backgroundColour": "Navy" } }
21
+ * ]
22
+ * }
23
+ *
24
+ * If --type is passed without --variants, uses a default set of variants for that type.
25
+ *
26
+ * Prerequisites:
27
+ * - agent-browser installed: npm install -g agent-browser && agent-browser install
28
+ * - App running on its dev port (e.g. pnpm --filter example-brightline dev)
29
+ * - cms-edit available on PATH (installed with this package)
30
+ */
31
+ import { spawnSync } from 'node:child_process';
32
+ import { mkdirSync, readFileSync } from 'node:fs';
33
+ import { join, resolve } from 'node:path';
34
+ // Default variants for well-known types (used when --type is passed without --variants)
35
+ const DEFAULT_VARIANTS = {
36
+ Hero: {
37
+ typeName: 'Hero',
38
+ mode: 'component',
39
+ variants: [
40
+ {
41
+ label: 'default',
42
+ description: 'All fields populated, no colour override.',
43
+ showcaseParams: {},
44
+ },
45
+ {
46
+ label: 'no-visual',
47
+ description: 'visual field removed; copy spans full width.',
48
+ showcaseParams: { showVisual: 'false' },
49
+ },
50
+ {
51
+ label: 'navy',
52
+ description: 'Navy background + Off White text.',
53
+ showcaseParams: { backgroundColour: 'Navy', textColour: 'Off White' },
54
+ },
55
+ {
56
+ label: 'minimal',
57
+ description: 'Heading only, no eyebrow/subtitle/body/links/visual.',
58
+ showcaseParams: { showVisual: 'false', showLinks: 'false' },
59
+ },
60
+ ],
61
+ },
62
+ 'Hero Flipped': {
63
+ typeName: 'Hero Flipped',
64
+ mode: 'component',
65
+ variants: [
66
+ {
67
+ label: 'default',
68
+ description: 'Default flipped layout — visual on left, copy on right.',
69
+ showcaseParams: {},
70
+ },
71
+ ],
72
+ },
73
+ };
74
+ function parseCli() {
75
+ const args = process.argv.slice(2);
76
+ const result = {
77
+ variantsFile: null,
78
+ type: null,
79
+ appDir: process.cwd(),
80
+ };
81
+ for (let i = 0; i < args.length; i++) {
82
+ if (args[i] === '--variants' && args[i + 1]) {
83
+ result.variantsFile = args[++i];
84
+ }
85
+ else if (args[i] === '--type' && args[i + 1]) {
86
+ result.type = args[++i];
87
+ }
88
+ else if (args[i] === '--app-dir' && args[i + 1]) {
89
+ result.appDir = args[++i];
90
+ }
91
+ }
92
+ return result;
93
+ }
94
+ function typeNameToSlug(typeName) {
95
+ return typeName.toLowerCase().replace(/\s+/g, '-');
96
+ }
97
+ function buildCmsEditArgs(typeName, mode, params) {
98
+ const modeFlag = mode === 'collection' ? '--collection' : '--component';
99
+ const paramFlags = Object.entries(params).flatMap(([k, v]) => ['--param', `${k}=${v}`]);
100
+ return [modeFlag, typeName, ...paramFlags];
101
+ }
102
+ function captureScreenshot(typeName, mode, variant, outPath, appDir) {
103
+ const args = buildCmsEditArgs(typeName, mode, variant.showcaseParams);
104
+ // Validate URL generation first (shell: false so type names with spaces are one argument)
105
+ const urlResult = spawnSync('cms-edit', ['screenshot', ...args, '--url-only'], {
106
+ cwd: appDir,
107
+ encoding: 'utf8',
108
+ shell: false,
109
+ });
110
+ if (urlResult.status !== 0) {
111
+ console.error(` ✗ URL generation failed for ${typeName} / ${variant.label}`);
112
+ console.error(` ${urlResult.stderr}`);
113
+ return false;
114
+ }
115
+ const url = urlResult.stdout.trim();
116
+ console.log(` URL: ${url}`);
117
+ const result = spawnSync('cms-edit', ['screenshot', ...args, '--out', outPath, '--wait', '1000'], {
118
+ cwd: appDir,
119
+ encoding: 'utf8',
120
+ timeout: 60000,
121
+ shell: false,
122
+ });
123
+ if (result.status !== 0) {
124
+ const stderr = result.stderr ?? '';
125
+ if (stderr.includes('agent-browser') ||
126
+ stderr.includes('not found') ||
127
+ stderr.includes('ENOENT')) {
128
+ console.warn(` ⚠ agent-browser not available. Screenshot URL only:`);
129
+ console.warn(` ${url}`);
130
+ console.warn(` Install with: npm install -g agent-browser && agent-browser install`);
131
+ }
132
+ else {
133
+ console.error(` ✗ Screenshot failed: ${stderr}`);
134
+ }
135
+ return false;
136
+ }
137
+ console.log(` ✓ Saved: ${outPath}`);
138
+ return true;
139
+ }
140
+ function main() {
141
+ const { variantsFile, type, appDir } = parseCli();
142
+ // Resolve relative to process.cwd() so path is absolute when passed to cms-edit (which runs with cwd: appDir)
143
+ const screenshotsDir = resolve(process.cwd(), appDir, 'docs/cms-guidelines/screenshots');
144
+ mkdirSync(screenshotsDir, { recursive: true });
145
+ let jobs = [];
146
+ if (variantsFile) {
147
+ const data = JSON.parse(readFileSync(variantsFile, 'utf8'));
148
+ const payload = Array.isArray(data) ? data : [data];
149
+ jobs = payload.map((entry) => ({
150
+ typeName: entry.typeName,
151
+ mode: entry.mode ?? 'component',
152
+ variants: entry.variants,
153
+ }));
154
+ }
155
+ else if (type) {
156
+ const defaults = DEFAULT_VARIANTS[type];
157
+ if (!defaults) {
158
+ console.error(`No default variants for type "${type}". Use --variants <file> instead.`);
159
+ process.exit(1);
160
+ }
161
+ jobs = [defaults];
162
+ }
163
+ else {
164
+ console.log('Usage:');
165
+ console.log(' cms-capture-screenshots --type Hero');
166
+ console.log(' cms-capture-screenshots --variants variants.json');
167
+ console.log(' cms-capture-screenshots --type Hero --app-dir /path/to/app');
168
+ process.exit(0);
169
+ }
170
+ for (const job of jobs) {
171
+ const slug = typeNameToSlug(job.typeName);
172
+ console.log(`\nCapturing screenshots for: ${job.typeName} (${job.variants.length} variants)`);
173
+ for (const variant of job.variants) {
174
+ const outFile = `${slug}-${variant.label}.png`;
175
+ const outPath = join(screenshotsDir, outFile);
176
+ console.log(`\n Variant: ${variant.label} — ${variant.description}`);
177
+ captureScreenshot(job.typeName, job.mode, variant, outPath, appDir);
178
+ }
179
+ }
180
+ console.log('\nDone.');
181
+ }
182
+ main();
183
+ //# sourceMappingURL=cms-capture-screenshots.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-capture-screenshots.js","sourceRoot":"","sources":["../../src/bin/cms-capture-screenshots.ts"],"names":[],"mappings":";AACA,uFAAuF;AAEvF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAgB1C,wFAAwF;AACxF,MAAM,gBAAgB,GAA+B;IACnD,IAAI,EAAE;QACJ,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,WAAW;QACjB,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,2CAA2C;gBACxD,cAAc,EAAE,EAAE;aACnB;YACD;gBACE,KAAK,EAAE,WAAW;gBAClB,WAAW,EAAE,8CAA8C;gBAC3D,cAAc,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE;aACxC;YACD;gBACE,KAAK,EAAE,MAAM;gBACb,WAAW,EAAE,mCAAmC;gBAChD,cAAc,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE;aACtE;YACD;gBACE,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,sDAAsD;gBACnE,cAAc,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE;aAC5D;SACF;KACF;IACD,cAAc,EAAE;QACd,QAAQ,EAAE,cAAc;QACxB,IAAI,EAAE,WAAW;QACjB,QAAQ,EAAE;YACR;gBACE,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,yDAAyD;gBACtE,cAAc,EAAE,EAAE;aACnB;SACF;KACF;CACF,CAAC;AAEF,SAAS,QAAQ;IACf,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,MAAM,GAAyE;QACnF,YAAY,EAAE,IAAI;QAClB,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;KACtB,CAAC;IACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,YAAY,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC5C,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,EAAE,CAAC,CAAW,CAAC;QAC5C,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAC/C,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAW,CAAC;QACpC,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,WAAW,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAClD,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAW,CAAC;QACtC,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,QAAgB;IACtC,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,gBAAgB,CAAC,QAAgB,EAAE,IAAY,EAAE,MAAsB;IAC9E,MAAM,QAAQ,GAAG,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC;IACxE,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACxF,OAAO,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,iBAAiB,CACxB,QAAgB,EAChB,IAAY,EACZ,OAAgB,EAChB,OAAe,EACf,MAAc;IAEd,MAAM,IAAI,GAAG,gBAAgB,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAEtE,0FAA0F;IAC1F,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC,YAAY,EAAE,GAAG,IAAI,EAAE,YAAY,CAAC,EAAE;QAC7E,GAAG,EAAE,MAAM;QACX,QAAQ,EAAE,MAAM;QAChB,KAAK,EAAE,KAAK;KACb,CAAC,CAAC;IAEH,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,iCAAiC,QAAQ,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC9E,OAAO,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QACzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACpC,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC,CAAC;IAE7B,MAAM,MAAM,GAAG,SAAS,CACtB,UAAU,EACV,CAAC,YAAY,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,EAC3D;QACE,GAAG,EAAE,MAAM;QACX,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,KAAK;KACb,CACF,CAAC;IAEF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;QACnC,IACE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC;YAC5B,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EACzB,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;YACtE,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,uEAAuE,CAAC,CAAC;QACxF,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC;IACrC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,IAAI;IACX,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IAClD,8GAA8G;IAC9G,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,iCAAiC,CAAC,CAAC;IAEzF,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/C,IAAI,IAAI,GAAiB,EAAE,CAAC;IAE5B,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAA8B,CAAC;QACzF,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC7B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,WAAW;YAC/B,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAC,CAAC;IACN,CAAC;SAAM,IAAI,IAAI,EAAE,CAAC;QAChB,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,CAAC,KAAK,CAAC,iCAAiC,IAAI,mCAAmC,CAAC,CAAC;YACxF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpB,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;QAClE,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC,CAAC;QAC5E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,gCAAgC,GAAG,CAAC,QAAQ,KAAK,GAAG,CAAC,QAAQ,CAAC,MAAM,YAAY,CAAC,CAAC;QAE9F,KAAK,MAAM,OAAO,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YACnC,MAAM,OAAO,GAAG,GAAG,IAAI,IAAI,OAAO,CAAC,KAAK,MAAM,CAAC;YAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;YAC9C,OAAO,CAAC,GAAG,CAAC,gBAAgB,OAAO,CAAC,KAAK,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YACtE,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AACzB,CAAC;AAED,IAAI,EAAE,CAAC"}
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ export {};
4
+ //# sourceMappingURL=cms-generate-collection-guidelines.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-generate-collection-guidelines.d.ts","sourceRoot":"","sources":["../../src/bin/cms-generate-collection-guidelines.ts"],"names":[],"mappings":";AACA,uFAAuF"}
@@ -0,0 +1,209 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ /**
4
+ * cms-generate-collection-guidelines
5
+ *
6
+ * Generates guideline markdown fragments for all collections and external components
7
+ * in a project by reading from the live discovery API. This script is project-independent:
8
+ * it needs only a discovery URL and an app directory.
9
+ *
10
+ * Usage:
11
+ * cms-generate-collection-guidelines --discovery-url <url> --app-dir <path>
12
+ *
13
+ * Example:
14
+ * cms-generate-collection-guidelines \
15
+ * --discovery-url http://localhost:3010/api/cms/discovery/ \
16
+ * --app-dir apps/example-brightline
17
+ *
18
+ * What it does:
19
+ * 1. Fetches discovery JSON from the URL.
20
+ * 2. For each collections[] entry:
21
+ * - Computes slug (name lowercased, spaces → hyphens, parentheses stripped)
22
+ * - Writes docs/cms-guidelines/collections/<slug>.md
23
+ * - Writes colour hint (section or none) to generated/cms-discovery/colour-hints.json
24
+ * 3. For each externals[] entry:
25
+ * - Computes slug
26
+ * - Writes docs/cms-guidelines/externals/<slug>.md
27
+ * - Writes colour hint (none)
28
+ *
29
+ * Existing files are overwritten; run this to regenerate after adding types or changing fields.
30
+ *
31
+ * Prerequisites:
32
+ * - App must be running so the discovery URL is reachable.
33
+ * - generated/cms-discovery/ directory must exist (created by cms-generate-field-list).
34
+ */
35
+ import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
36
+ import { dirname, join } from 'node:path';
37
+ // ---------------------------------------------------------------------------
38
+ // CLI argument parsing
39
+ // ---------------------------------------------------------------------------
40
+ function parseCli() {
41
+ const args = process.argv.slice(2);
42
+ let discoveryUrl = '';
43
+ let appDir = process.cwd();
44
+ for (let i = 0; i < args.length; i++) {
45
+ if (args[i] === '--discovery-url' && args[i + 1]) {
46
+ discoveryUrl = args[++i];
47
+ }
48
+ else if (args[i] === '--app-dir' && args[i + 1]) {
49
+ appDir = args[++i];
50
+ }
51
+ else if (args[i] === '--help' || args[i] === '-h') {
52
+ printHelp();
53
+ process.exit(0);
54
+ }
55
+ }
56
+ if (!discoveryUrl) {
57
+ console.error('Error: --discovery-url is required.');
58
+ printHelp();
59
+ process.exit(1);
60
+ }
61
+ return { discoveryUrl, appDir };
62
+ }
63
+ function printHelp() {
64
+ console.log('Usage:');
65
+ console.log(' cms-generate-collection-guidelines --discovery-url <url> [--app-dir <path>]');
66
+ console.log('');
67
+ console.log('Options:');
68
+ console.log(' --discovery-url <url> Discovery API URL (e.g. http://localhost:3010/api/cms/discovery/)');
69
+ console.log(' --app-dir <path> App directory (default: cwd)');
70
+ console.log('');
71
+ console.log('Example:');
72
+ console.log(' cms-generate-collection-guidelines \\');
73
+ console.log(' --discovery-url http://localhost:3010/api/cms/discovery/ \\');
74
+ console.log(' --app-dir apps/example-brightline');
75
+ }
76
+ // ---------------------------------------------------------------------------
77
+ // Slug computation
78
+ // ---------------------------------------------------------------------------
79
+ function toSlug(name) {
80
+ return name.toLowerCase().replace(/\s+/g, '-').replace(/[()]/g, '');
81
+ }
82
+ // ---------------------------------------------------------------------------
83
+ // Markdown generation
84
+ // ---------------------------------------------------------------------------
85
+ const SECTION_EXCLUDE = new Set(['contents', 'collectionType', 'cmsLabel', 'id', 'index']);
86
+ const CARD_EXCLUDE = new Set(['parentId', 'componentType', 'id']);
87
+ function generateCollectionMarkdown(entry) {
88
+ const sectionFields = entry.usedFields.filter((f) => !SECTION_EXCLUDE.has(f));
89
+ const cardFields = (entry.cardUsedFields ?? []).filter((f) => !CARD_EXCLUDE.has(f));
90
+ const hasCard = cardFields.length > 0;
91
+ const hasColour = entry.usedFields.some((f) => f === 'backgroundColour' || f === 'textColour') ||
92
+ entry.cardUsedFields?.some((f) => f === 'backgroundColour' || f === 'textColour');
93
+ let md = `# ${entry.name}\n\n`;
94
+ md += 'Collection section with optional section heading and a set of items (cards or list).\n\n';
95
+ md += '## Section fields\n\n';
96
+ md += '| Field | Effect |\n|---|---|\n';
97
+ for (const f of sectionFields) {
98
+ md += `| \`${f}\` | Section-level. |\n`;
99
+ }
100
+ if (hasCard) {
101
+ md += '\n## Card / item fields\n\n';
102
+ for (const f of cardFields) {
103
+ md += `- \`${f}\`\n`;
104
+ }
105
+ }
106
+ if (hasColour) {
107
+ md +=
108
+ '\n## Colours\n\nSection and/or cards may use `backgroundColour` and `textColour` from the palette.\n';
109
+ }
110
+ return md;
111
+ }
112
+ function generateExternalMarkdown(entry) {
113
+ return `# ${entry.name}\n\nExternal component: embeds or integrates third-party content (e.g. form, iframe, RSS). Configure in CMS; layout and styling are project-specific.\n`;
114
+ }
115
+ // ---------------------------------------------------------------------------
116
+ // Colour hints
117
+ // ---------------------------------------------------------------------------
118
+ function loadColourHints(hintsPath) {
119
+ if (!existsSync(hintsPath)) {
120
+ return {};
121
+ }
122
+ try {
123
+ return JSON.parse(readFileSync(hintsPath, 'utf8'));
124
+ }
125
+ catch {
126
+ return {};
127
+ }
128
+ }
129
+ function saveColourHints(hintsPath, hints) {
130
+ mkdirSync(dirname(hintsPath), { recursive: true });
131
+ const sorted = Object.fromEntries(Object.entries(hints).sort(([a], [b]) => a.localeCompare(b)));
132
+ writeFileSync(hintsPath, JSON.stringify(sorted, null, 2) + '\n');
133
+ }
134
+ // ---------------------------------------------------------------------------
135
+ // Main
136
+ // ---------------------------------------------------------------------------
137
+ async function main() {
138
+ const { discoveryUrl, appDir } = parseCli();
139
+ console.log(`Fetching discovery from: ${discoveryUrl}`);
140
+ console.log(`App directory: ${appDir}`);
141
+ // Fetch discovery
142
+ let discovery;
143
+ try {
144
+ const res = await fetch(discoveryUrl);
145
+ if (!res.ok) {
146
+ console.error(`Discovery fetch failed: HTTP ${res.status} ${res.statusText}`);
147
+ console.error(`URL: ${discoveryUrl}`);
148
+ process.exit(1);
149
+ }
150
+ discovery = (await res.json());
151
+ }
152
+ catch (err) {
153
+ console.error(`Failed to fetch discovery URL: ${discoveryUrl}`);
154
+ console.error(String(err));
155
+ console.error('\nIs the app running? Start it with:');
156
+ console.error(' pnpm --filter <appName> dev');
157
+ process.exit(1);
158
+ }
159
+ const collectionsDir = join(appDir, 'docs/cms-guidelines/collections');
160
+ const externalsDir = join(appDir, 'docs/cms-guidelines/externals');
161
+ const hintsPath = join(appDir, 'generated/cms-discovery/colour-hints.json');
162
+ mkdirSync(collectionsDir, { recursive: true });
163
+ mkdirSync(externalsDir, { recursive: true });
164
+ mkdirSync(dirname(hintsPath), { recursive: true });
165
+ const hints = loadColourHints(hintsPath);
166
+ // Collections
167
+ console.log(`\nGenerating ${discovery.collections.length} collection guidelines...`);
168
+ for (const entry of discovery.collections) {
169
+ const slug = toSlug(entry.name);
170
+ const outPath = join(collectionsDir, `${slug}.md`);
171
+ const md = generateCollectionMarkdown(entry);
172
+ writeFileSync(outPath, md, 'utf8');
173
+ // Colour hint: section if backgroundColour or textColour in used/card fields; else none
174
+ const hasColourFields = entry.usedFields.some((f) => f === 'backgroundColour' || f === 'textColour') ||
175
+ entry.cardUsedFields?.some((f) => f === 'backgroundColour' || f === 'textColour');
176
+ hints[entry.name] = {
177
+ colourApplication: hasColourFields ? 'section' : 'none',
178
+ notes: hasColourFields
179
+ ? 'Section and/or cards use backgroundColour/textColour from palette.'
180
+ : 'No colour fields in used fields or card fields.',
181
+ };
182
+ console.log(` ✓ ${entry.name} → collections/${slug}.md`);
183
+ }
184
+ // Externals
185
+ console.log(`\nGenerating ${discovery.externals.length} external component guidelines...`);
186
+ for (const entry of discovery.externals) {
187
+ const slug = toSlug(entry.name);
188
+ const outPath = join(externalsDir, `${slug}.md`);
189
+ const md = generateExternalMarkdown(entry);
190
+ writeFileSync(outPath, md, 'utf8');
191
+ hints[entry.name] = {
192
+ colourApplication: 'none',
193
+ notes: 'External embed; no colour fields.',
194
+ };
195
+ console.log(` ✓ ${entry.name} → externals/${slug}.md`);
196
+ }
197
+ // Save colour hints
198
+ saveColourHints(hintsPath, hints);
199
+ console.log(`\nColour hints written to ${hintsPath}`);
200
+ console.log(`\nDone. ${discovery.collections.length} collections and ${discovery.externals.length} externals generated.`);
201
+ console.log('\nNext step: run merge to update COMPONENT_GUIDELINES_FOR_LLM.md:');
202
+ console.log(' cms-merge-guidelines --app-dir <appDir>');
203
+ console.log(' (or: pnpm run cms-guidelines:merge from the app directory)');
204
+ }
205
+ main().catch((err) => {
206
+ console.error(err);
207
+ process.exit(1);
208
+ });
209
+ //# sourceMappingURL=cms-generate-collection-guidelines.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-generate-collection-guidelines.js","sourceRoot":"","sources":["../../src/bin/cms-generate-collection-guidelines.ts"],"names":[],"mappings":";AACA,uFAAuF;AAEvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAkC1C,8EAA8E;AAC9E,uBAAuB;AACvB,8EAA8E;AAE9E,SAAS,QAAQ;IACf,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,IAAI,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,iBAAiB,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YACjD,YAAY,GAAG,IAAI,CAAC,EAAE,CAAC,CAAW,CAAC;QACrC,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,WAAW,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;YAClD,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAW,CAAC;QAC/B,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YACpD,SAAS,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACrD,SAAS,EAAE,CAAC;QACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC;AAClC,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACtB,OAAO,CAAC,GAAG,CAAC,+EAA+E,CAAC,CAAC;IAC7F,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxB,OAAO,CAAC,GAAG,CACT,6FAA6F,CAC9F,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAC;IACtE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACxB,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;IACvD,OAAO,CAAC,GAAG,CAAC,iEAAiE,CAAC,CAAC;IAC/E,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;AACvD,CAAC;AAED,8EAA8E;AAC9E,mBAAmB;AACnB,8EAA8E;AAE9E,SAAS,MAAM,CAAC,IAAY;IAC1B,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AACtE,CAAC;AAED,8EAA8E;AAC9E,sBAAsB;AACtB,8EAA8E;AAE9E,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,gBAAgB,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;AAC3F,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;AAElE,SAAS,0BAA0B,CAAC,KAAsB;IACxD,MAAM,aAAa,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACpF,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;IACtC,MAAM,SAAS,GACb,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,kBAAkB,IAAI,CAAC,KAAK,YAAY,CAAC;QAC5E,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,kBAAkB,IAAI,CAAC,KAAK,YAAY,CAAC,CAAC;IAEpF,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC,IAAI,MAAM,CAAC;IAC/B,EAAE,IAAI,0FAA0F,CAAC;IAEjG,EAAE,IAAI,uBAAuB,CAAC;IAC9B,EAAE,IAAI,iCAAiC,CAAC;IACxC,KAAK,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;QAC9B,EAAE,IAAI,OAAO,CAAC,yBAAyB,CAAC;IAC1C,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,EAAE,IAAI,6BAA6B,CAAC;QACpC,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YAC3B,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC;QACvB,CAAC;IACH,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,EAAE;YACA,sGAAsG,CAAC;IAC3G,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAoB;IACpD,OAAO,KAAK,KAAK,CAAC,IAAI,yJAAyJ,CAAC;AAClL,CAAC;AAED,8EAA8E;AAC9E,eAAe;AACf,8EAA8E;AAE9E,SAAS,eAAe,CAAC,SAAiB;IACxC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAoB,CAAC;IACxE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,SAAiB,EAAE,KAAsB;IAChE,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChG,aAAa,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AACnE,CAAC;AAED,8EAA8E;AAC9E,OAAO;AACP,8EAA8E;AAE9E,KAAK,UAAU,IAAI;IACjB,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IAE5C,OAAO,CAAC,GAAG,CAAC,4BAA4B,YAAY,EAAE,CAAC,CAAC;IACxD,OAAO,CAAC,GAAG,CAAC,kBAAkB,MAAM,EAAE,CAAC,CAAC;IAExC,kBAAkB;IAClB,IAAI,SAA4B,CAAC;IACjC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,gCAAgC,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;YAC9E,OAAO,CAAC,KAAK,CAAC,QAAQ,YAAY,EAAE,CAAC,CAAC;YACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,SAAS,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAsB,CAAC;IACtD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,kCAAkC,YAAY,EAAE,CAAC,CAAC;QAChE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;QACtD,OAAO,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAC/C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC;IACvE,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,+BAA+B,CAAC,CAAC;IACnE,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,EAAE,2CAA2C,CAAC,CAAC;IAE5E,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,SAAS,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,KAAK,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;IAEzC,cAAc;IACd,OAAO,CAAC,GAAG,CAAC,gBAAgB,SAAS,CAAC,WAAW,CAAC,MAAM,2BAA2B,CAAC,CAAC;IACrF,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,IAAI,KAAK,CAAC,CAAC;QACnD,MAAM,EAAE,GAAG,0BAA0B,CAAC,KAAK,CAAC,CAAC;QAC7C,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QAEnC,wFAAwF;QACxF,MAAM,eAAe,GACnB,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,kBAAkB,IAAI,CAAC,KAAK,YAAY,CAAC;YAC5E,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,kBAAkB,IAAI,CAAC,KAAK,YAAY,CAAC,CAAC;QACpF,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;YAClB,iBAAiB,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;YACvD,KAAK,EAAE,eAAe;gBACpB,CAAC,CAAC,oEAAoE;gBACtE,CAAC,CAAC,iDAAiD;SACtD,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,IAAI,kBAAkB,IAAI,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,YAAY;IACZ,OAAO,CAAC,GAAG,CAAC,gBAAgB,SAAS,CAAC,SAAS,CAAC,MAAM,mCAAmC,CAAC,CAAC;IAC3F,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,IAAI,KAAK,CAAC,CAAC;QACjD,MAAM,EAAE,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC3C,aAAa,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QAEnC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;YAClB,iBAAiB,EAAE,MAAM;YACzB,KAAK,EAAE,mCAAmC;SAC3C,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,IAAI,gBAAgB,IAAI,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED,oBAAoB;IACpB,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAClC,OAAO,CAAC,GAAG,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC;IAEtD,OAAO,CAAC,GAAG,CACT,WAAW,SAAS,CAAC,WAAW,CAAC,MAAM,oBAAoB,SAAS,CAAC,SAAS,CAAC,MAAM,uBAAuB,CAC7G,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,mEAAmE,CAAC,CAAC;IACjF,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;IACzD,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC,CAAC;AAC9E,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACnB,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ export {};
4
+ //# sourceMappingURL=cms-generate-field-list.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-generate-field-list.d.ts","sourceRoot":"","sources":["../../src/bin/cms-generate-field-list.ts"],"names":[],"mappings":";AACA,uFAAuF"}
@@ -0,0 +1,114 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ /**
4
+ * cms-generate-field-list
5
+ *
6
+ * Parses the generated Contentful TypeScript type files in an app to produce
7
+ * generated/cms-discovery/field-list.json.
8
+ *
9
+ * This file contains field metadata for component, collection, and external
10
+ * component content types: field id, label, type, whether required, summary,
11
+ * and valid enum values if applicable.
12
+ *
13
+ * Usage:
14
+ * cms-generate-field-list [--app-dir <path>]
15
+ *
16
+ * Prerequisites:
17
+ * Run `pnpm codegen` (or `pnpm generate:types`) first to ensure
18
+ * src/generated/types/ is up to date.
19
+ *
20
+ * Output:
21
+ * <app-dir>/generated/cms-discovery/field-list.json
22
+ */
23
+ import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
24
+ import { dirname, join } from 'node:path';
25
+ // Parse --app-dir flag (default: cwd)
26
+ function parseAppDir() {
27
+ const args = process.argv.slice(2);
28
+ const idx = args.indexOf('--app-dir');
29
+ return idx !== -1 && args[idx + 1] ? args[idx + 1] : process.cwd();
30
+ }
31
+ const appRoot = parseAppDir();
32
+ // Content types to parse: [ fileName, contentTypeId ]
33
+ const CONTENT_TYPES = [
34
+ ['TypeComponent.ts', 'component'],
35
+ ['TypeCollection.ts', 'collection'],
36
+ ['TypeExternalComponent.ts', 'externalComponent'],
37
+ ];
38
+ const TYPES_DIR = join(appRoot, 'src/generated/types');
39
+ const OUTPUT_PATH = join(appRoot, 'generated/cms-discovery/field-list.json');
40
+ /**
41
+ * Derive a simplified field type name and enum values from an EntryFieldTypes expression.
42
+ */
43
+ function parseFieldType(typeExpr) {
44
+ const entryFieldMatch = typeExpr.match(/EntryFieldTypes\.(\w+)/);
45
+ if (!entryFieldMatch) {
46
+ return { type: 'Unknown' };
47
+ }
48
+ const typeName = entryFieldMatch[1];
49
+ if (typeName === 'Symbol') {
50
+ const enumMatch = typeExpr.match(/EntryFieldTypes\.Symbol<(.+?)>/);
51
+ if (enumMatch) {
52
+ const enumStr = enumMatch[1];
53
+ const enumValues = enumStr.split('|').map((v) => v.trim().replace(/^"(.+)"$/, '$1'));
54
+ return { type: 'Symbol', enumValues };
55
+ }
56
+ }
57
+ return { type: typeName };
58
+ }
59
+ /**
60
+ * Parse a TypeXxx.ts file and extract field metadata from the TypeXxxFields interface.
61
+ */
62
+ function parseTypeFile(fileName) {
63
+ const filePath = join(TYPES_DIR, fileName);
64
+ let source;
65
+ try {
66
+ source = readFileSync(filePath, 'utf8');
67
+ }
68
+ catch {
69
+ console.error(`Could not read ${filePath}`);
70
+ return [];
71
+ }
72
+ const interfaceMatch = source.match(/export interface Type\w+Fields \{([\s\S]+?)^}/m);
73
+ if (!interfaceMatch) {
74
+ console.error(`Could not find TypeXxxFields interface in ${fileName}`);
75
+ return [];
76
+ }
77
+ const body = interfaceMatch[1];
78
+ const fields = [];
79
+ const fieldBlockRegex = /\/\*\*([\s\S]*?)\*\/\s*\n\s+(\w+)(\??):\s*([\s\S]+?);/g;
80
+ let match = fieldBlockRegex.exec(body);
81
+ while (match !== null) {
82
+ const [, jsdoc, fieldId, optionalMark, typeExpr] = match;
83
+ const nameMatch = jsdoc.match(/@name (.+)/);
84
+ const label = nameMatch ? nameMatch[1].trim() : fieldId;
85
+ const summaryMatch = jsdoc.match(/@summary (.+)/);
86
+ const summary = summaryMatch ? summaryMatch[1].trim() : undefined;
87
+ const required = optionalMark !== '?';
88
+ const { type, enumValues } = parseFieldType(typeExpr.replace(/\s+/g, ' '));
89
+ const field = { id: fieldId, label, required, type };
90
+ if (summary) {
91
+ field.summary = summary;
92
+ }
93
+ if (enumValues) {
94
+ field.enumValues = enumValues;
95
+ }
96
+ fields.push(field);
97
+ match = fieldBlockRegex.exec(body);
98
+ }
99
+ return fields;
100
+ }
101
+ function main() {
102
+ console.log(`Generating field list for: ${appRoot}`);
103
+ const output = {};
104
+ for (const [fileName, contentTypeId] of CONTENT_TYPES) {
105
+ const fields = parseTypeFile(fileName);
106
+ output[contentTypeId] = { fields };
107
+ console.log(` ${contentTypeId}: ${fields.length} fields`);
108
+ }
109
+ mkdirSync(dirname(OUTPUT_PATH), { recursive: true });
110
+ writeFileSync(OUTPUT_PATH, JSON.stringify(output, null, 2));
111
+ console.log(`\nWrote ${OUTPUT_PATH}`);
112
+ }
113
+ main();
114
+ //# sourceMappingURL=cms-generate-field-list.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-generate-field-list.js","sourceRoot":"","sources":["../../src/bin/cms-generate-field-list.ts"],"names":[],"mappings":";AACA,uFAAuF;AAEvF;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE1C,sCAAsC;AACtC,SAAS,WAAW;IAClB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACtC,OAAO,GAAG,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,GAAG,GAAG,CAAC,CAAY,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;AACjF,CAAC;AAED,MAAM,OAAO,GAAG,WAAW,EAAE,CAAC;AAE9B,sDAAsD;AACtD,MAAM,aAAa,GAAuB;IACxC,CAAC,kBAAkB,EAAE,WAAW,CAAC;IACjC,CAAC,mBAAmB,EAAE,YAAY,CAAC;IACnC,CAAC,0BAA0B,EAAE,mBAAmB,CAAC;CAClD,CAAC;AAEF,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;AACvD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,EAAE,yCAAyC,CAAC,CAAC;AAI7E;;GAEG;AACH,SAAS,cAAc,CAAC,QAAgB;IACtC,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACjE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAW,CAAC;IAE9C,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC1B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACnE,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,SAAS,CAAC,CAAC,CAAW,CAAC;YACvC,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;YACrF,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACxC,CAAC;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC5B,CAAC;AAWD;;GAEG;AACH,SAAS,aAAa,CAAC,QAAgB;IACrC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC3C,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,KAAK,CAAC,kBAAkB,QAAQ,EAAE,CAAC,CAAC;QAC5C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACtF,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,6CAA6C,QAAQ,EAAE,CAAC,CAAC;QACvE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,CAAW,CAAC;IACzC,MAAM,MAAM,GAAiB,EAAE,CAAC;IAEhC,MAAM,eAAe,GAAG,wDAAwD,CAAC;IAEjF,IAAI,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,OAAO,KAAK,KAAK,IAAI,EAAE,CAAC;QACtB,MAAM,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,GAAG,KAMlD,CAAC;QAEF,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAE,SAAS,CAAC,CAAC,CAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QAEpE,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAE,YAAY,CAAC,CAAC,CAAY,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAE9E,MAAM,QAAQ,GAAG,YAAY,KAAK,GAAG,CAAC;QAEtC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC;QAE3E,MAAM,KAAK,GAAe,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACjE,IAAI,OAAO,EAAE,CAAC;YACZ,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC1B,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAChC,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnB,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,IAAI;IACX,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,EAAE,CAAC,CAAC;IACrD,MAAM,MAAM,GAA6C,EAAE,CAAC;IAE5D,KAAK,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,aAAa,EAAE,CAAC;QACtD,MAAM,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,KAAK,aAAa,KAAK,MAAM,CAAC,MAAM,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5D,OAAO,CAAC,GAAG,CAAC,WAAW,WAAW,EAAE,CAAC,CAAC;AACxC,CAAC;AAED,IAAI,EAAE,CAAC"}
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env node
2
+ /** biome-ignore-all lint/suspicious/noConsole: Console output is intentional in CLI */
3
+ export {};
4
+ //# sourceMappingURL=cms-merge-guidelines.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-merge-guidelines.d.ts","sourceRoot":"","sources":["../../src/bin/cms-merge-guidelines.ts"],"names":[],"mappings":";AAEA,uFAAuF"}