@contentful/experience-design-system-generation 2.26.1

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+export { AGENT_NAMES, DEFAULT_AGENT_NAME, isAgentName } from './agent-names.js';
+export type { AgentName } from './agent-names.js';
+export { buildArgs, checkAgentAuth, describeAgentFailure, extractSentinelOutput, parseSelectToolCallLines, parseTokenToolCallLines, parseToolCallLines, resolveAgentModel, resolveBinary, runAgent, } from './agent-runner.js';
+export type { AgentAuthStatus, AgentDebugEvent, AgentRunResult, ClassifyComponentCall, ClassifyPropCall, ClassifySlotCall, ExcludePropCall, ParsedSelectToolCalls, ParsedTokenToolCalls, ParsedToolCalls, RejectComponentCall, SelectComponentCall, SelectToolCall, SetGroupCall, SetTokenCall, ToolCall, TokenToolCall, } from './agent-runner.js';
+export { createLocalCliAgentInvoker } from './agent-invoker.js';
+export type { AgentInvoker, CreateLocalCliAgentInvokerOptions, InvokeAgentOptions } from './agent-invoker.js';
+export { buildPrompt, formatCustomPromptBanner, resolveSkillPath } from './prompt-builder.js';
+export type { Mode, PromptOptions, Skill } from './prompt-builder.js';
+export { formatGenerateProgressLine } from './progress.js';

package/dist/src/index.js

@@ -0,0 +1,10 @@
+// Agent identity
+export { AGENT_NAMES, DEFAULT_AGENT_NAME, isAgentName } from './agent-names.js';
+// Agent invocation (low-level)
+export { buildArgs, checkAgentAuth, describeAgentFailure, extractSentinelOutput, parseSelectToolCallLines, parseTokenToolCallLines, parseToolCallLines, resolveAgentModel, resolveBinary, runAgent, } from './agent-runner.js';
+// Agent invocation (interface)
+export { createLocalCliAgentInvoker } from './agent-invoker.js';
+// Prompt building
+export { buildPrompt, formatCustomPromptBanner, resolveSkillPath } from './prompt-builder.js';
+// Progress reporting
+export { formatGenerateProgressLine } from './progress.js';

package/dist/src/progress.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Formats a structured generation-progress line for the wizard parser.
+ *
+ * Emitted at terminal completion of each component (success, cache hit,
+ * pinned hit, or final failure). `done` represents the count of completed
+ * components, which is monotonically non-decreasing — unlike the legacy
+ * `[index+1/total]` line, which reports input position.
+ */
+export declare function formatGenerateProgressLine(done: number, total: number, name: string): string;

package/dist/src/progress.js

@@ -0,0 +1,11 @@
+/**
+ * Formats a structured generation-progress line for the wizard parser.
+ *
+ * Emitted at terminal completion of each component (success, cache hit,
+ * pinned hit, or final failure). `done` represents the count of completed
+ * components, which is monotonically non-decreasing — unlike the legacy
+ * `[index+1/total]` line, which reports input position.
+ */
+export function formatGenerateProgressLine(done, total, name) {
+    return `progress=generate:${done}/${total}:${name}`;
+}

package/dist/src/prompt-builder.d.ts

@@ -0,0 +1,32 @@
+/** `components` — classify component props; `tokens` — classify design tokens; `select` — decide whether a component belongs in Contentful Experience Orchestration */
+export type Skill = 'components' | 'tokens' | 'select';
+export type Mode = 'autonomous';
+/**
+ * Render the warning banner shown when a custom skill prompt is active.
+ * Always cites the bundled invariants that the override bypasses so the
+ * operator cannot miss it.
+ */
+export declare function formatCustomPromptBanner(skill: 'components' | 'select', path: string): string;
+export interface PromptOptions {
+    skill: Skill;
+    mode: Mode;
+    rawComponentsInline?: string;
+    rawTokensInline?: string;
+    /** Original filename for raw tokens — used to set the correct code fence language. */
+    rawTokensFilename?: string;
+    tokensInline?: string;
+    tokenMapInline?: string;
+    outDir: string;
+    /** For components skill only: the single component's name (used in error messages). */
+    componentName?: string;
+    /**
+     * Feature 8: custom prompt path override. When set, this absolute or relative
+     * `.md` path is read in place of the bundled skill file. The bundled-prompt
+     * invariants (utility-wrapper rejection, description content rules, etc.) do
+     * NOT apply under an override — callers are responsible for showing the
+     * appropriate warning banner.
+     */
+    skillPathOverride?: string;
+}
+export declare function buildPrompt(options: PromptOptions): Promise<string>;
+export declare function resolveSkillPath(skill: Skill): string;

package/dist/src/prompt-builder.js

@@ -0,0 +1,204 @@
+import { existsSync } from 'node:fs';
+import { readFile } from 'node:fs/promises';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * Render the warning banner shown when a custom skill prompt is active.
+ * Always cites the bundled invariants that the override bypasses so the
+ * operator cannot miss it.
+ */
+export function formatCustomPromptBanner(skill, path) {
+    return (`WARNING: Custom prompt active for ${skill}: ${path}\n` +
+        `  Bundled invariants (utility-wrapper rejection, description content rules) do NOT apply.\n` +
+        `  You are responsible for the prompt's correctness.\n`);
+}
+const SKILL_FILES = {
+    components: 'generate-components.md',
+    tokens: 'generate-tokens.md',
+    select: 'select-components.md',
+};
+export async function buildPrompt(options) {
+    const skillContent = await readSkillFile(options.skill, options.skillPathOverride);
+    const preamble = buildPreamble(options);
+    return `${preamble}\n\nSkill instructions follow:\n---\n${skillContent}`;
+}
+export function resolveSkillPath(skill) {
+    if (!(skill in SKILL_FILES))
+        throw new Error(`Invalid skill: ${skill}`);
+    // Walk up until we find the skills/ directory (works from both src/ and dist/src/ contexts)
+    const thisDir = dirname(fileURLToPath(import.meta.url));
+    let dir = thisDir;
+    for (;;) {
+        const candidate = join(dir, 'skills');
+        if (existsSync(candidate))
+            return join(candidate, SKILL_FILES[skill]);
+        const parent = resolve(dir, '..');
+        if (parent === dir) {
+            throw new Error(`skill file missing from CLI installation (could not locate skills/ directory from: ${thisDir})`);
+        }
+        dir = parent;
+    }
+}
+async function readSkillFile(skill, override) {
+    if (override) {
+        const skillPath = resolve(override);
+        try {
+            return await readFile(skillPath, 'utf8');
+        }
+        catch {
+            throw new Error(`custom prompt file not found (skill: ${skill}, path: ${skillPath})`);
+        }
+    }
+    const skillPath = resolveSkillPath(skill);
+    try {
+        return await readFile(skillPath, 'utf8');
+    }
+    catch {
+        throw new Error(`skill file missing from CLI installation — try reinstalling the CLI (looked for: ${skillPath})`);
+    }
+}
+function inferFenceLang(filename) {
+    if (!filename)
+        return 'json';
+    const ext = filename.split('.').pop()?.toLowerCase() ?? '';
+    const map = {
+        js: 'js',
+        mjs: 'js',
+        cjs: 'js',
+        ts: 'ts',
+        mts: 'ts',
+        cts: 'ts',
+        scss: 'scss',
+        sass: 'scss',
+        css: 'css',
+        json: 'json',
+        json5: 'json',
+    };
+    return map[ext] ?? 'text';
+}
+function buildPreamble(options) {
+    const { skill, rawComponentsInline, rawTokensInline, rawTokensFilename, tokensInline, tokenMapInline } = options;
+    const sections = [];
+    if (rawComponentsInline) {
+        sections.push(`Raw component data (JSON):\n\`\`\`json\n${rawComponentsInline}\n\`\`\``);
+    }
+    if (rawTokensInline) {
+        const lang = inferFenceLang(rawTokensFilename);
+        const label = rawTokensFilename ? `Raw token source (${rawTokensFilename})` : 'Raw token source';
+        sections.push(`${label}:\n\`\`\`${lang}\n${rawTokensInline}\n\`\`\``);
+    }
+    if (tokensInline) {
+        sections.push(`DTCG token data (for token kind lookups):\n\`\`\`json\n${tokensInline}\n\`\`\``);
+    }
+    if (tokenMapInline) {
+        sections.push(`Token-name sidecar (raw name → DTCG path):\n\`\`\`json\n${tokenMapInline}\n\`\`\``);
+    }
+    const inputBlock = sections.length > 0 ? `\n\n${sections.join('\n\n')}` : '';
+    if (skill === 'components') {
+        return buildComponentsAutonomousPreamble(inputBlock);
+    }
+    if (skill === 'select') {
+        return buildSelectAutonomousPreamble(inputBlock);
+    }
+    return buildTokensAutonomousPreamble(inputBlock);
+}
+function buildComponentsAutonomousPreamble(inputBlock) {
+    return `You are running as part of the experience-design-system-cli generate pipeline in AUTONOMOUS mode. The developer is not present to answer questions.
+
+Context: You are classifying a React component for **Contentful Experience Orchestration**. The result is a Component Type — a schema that tells Contentful what a marketer can configure. Properties fall into three categories:
+- **design**: controls how the component looks (variant, size, color, layout toggles)
+- **content**: the data a content editor fills in (text, images, URLs, rich text)
+- **state**: runtime behavioral flags (disabled, loading, expanded, identifiers)
+
+For props with complex TypeScript types (named types, enums): reason from the prop name and type name to classify them. Do not automatically exclude a prop just because its type is a named reference — infer the likely values and classify it as enum if it controls appearance.
+
+Your task: classify every prop and slot in the component below. Apply all judgment calls yourself — do not pause to ask for confirmation. Include a "description" field on each tool call to document your reasoning so the developer can review it afterward.
+
+All input data is provided inline below — do not read any additional files.${inputBlock}
+
+## Output protocol
+
+Do NOT write any files or emit any JSON blobs. Instead, emit one JSON object per line to stdout for each classification decision. The CLI reads your stdout line by line and writes each decision directly to the pipeline database.
+
+The four tool calls you may emit are:
+
+\`\`\`
+{"tool":"classify_component","description":"<optional component-level description>","rationale":{"description":"<why this component is classified the way it is>","props":"<why these props were chosen>","slots":"<why these slots were chosen>"}}
+
+{"tool":"classify_prop","prop":"<propName>","cdf_type":"<type>","cdf_category":"<category>","required":<bool>,"description":"<short customer-facing description>","reason":"<full internal rationale; not customer-facing>","values":["a","b"],"token_kind":"color","default":"<value>"}
+
+{"tool":"exclude_prop","prop":"<propName>","reason":"<why excluded>"}
+
+{"tool":"classify_slot","slot":"<slotName>","required":<bool>,"allowed_components":["ComponentName"],"description":"<reason>","rationale":"<why this slot was kept in the catalog>"}
+\`\`\`
+
+Rules:
+- Emit exactly one JSON object per line. No multi-line JSON. No markdown fences around the lines.
+- Every prop in the input must have exactly one call: either classify_prop or exclude_prop.
+- Every slot in the input must have exactly one classify_slot call.
+- Valid cdf_type values: string, richtext, media, enum, token, boolean
+- Valid cdf_category values: content, design, state
+- For enum type, always include "values" (non-empty string array).
+- For token type, always include "token_kind" (DTCG \$type, e.g. "color").
+- href and URL props → cdf_type "string", cdf_category "content". Do NOT use cdf_type "link" — it is not valid.
+- Framework internals (ref, event handlers, test IDs) → exclude_prop.
+- CSS design props (className, style, styles, positional/geometric props: top, bottom, left, right, rotation, offset, etc.) → classify_prop, cdf_type: "string", cdf_category: "design".
+- On classify_component, "rationale" fields are operator-facing (read-only) but may surface in customer-facing exports. The "rationale.description" field is subject to the description content rules in the skill prompt (no internal initiative names). "rationale.props" and "rationale.slots" describe your reasoning about scope; "classify_slot.rationale" explains why each slot was kept.
+- On classify_prop, "reason" is REQUIRED and is the LLM's internal rationale — shown to the developer reviewing the import, never to end-users. "description" is the customer-facing copy and is subject to the description content rules in the skill prompt. Keep them distinct: "description" is short and customer-facing; "reason" explains your reasoning in detail.
+- You may emit prose lines (not starting with {) anywhere — they are ignored by the parser and serve as your reasoning log.`;
+}
+function buildSelectAutonomousPreamble(inputBlock) {
+    return `You are running as part of the experience-design-system-cli import pipeline in AUTONOMOUS mode. The developer is not present to answer questions.
+
+Your task: review the components provided below and decide whether each belongs in Contentful Experience Orchestration as a Component Type. The input is a JSON array — you may receive 1–N components in a single message. Emit one tool call per input component, named after the component. Apply all judgment calls yourself — do not pause to ask for confirmation. Include a brief "reason" to document your reasoning for each decision.
+
+Key rule: accept any component that renders visible UI — atoms, molecules, and organisms are all valid Component Types in Contentful Experience Orchestration. Reject only components that produce zero visual output: React hooks, pure context providers, A/B testing or variant-routing wrappers, analytics trackers, and security utilities. Do NOT reject a component because it has few props, is low-level, or has some A/B testing or personalization-related props mixed in — those props are handled in the generate step.
+
+All input data is provided inline below — do not read any additional files.${inputBlock}
+
+## Output protocol
+
+Do NOT write any files or emit any JSON blobs. Instead, emit JSON tool calls one per line to stdout. The CLI reads your stdout line by line.
+
+The two tool calls — emit exactly one per input component:
+
+\`\`\`
+{"tool":"select_component","name":"<ComponentName>","reason":"<brief reason>"}
+
+{"tool":"reject_component","name":"<ComponentName>","reason":"<brief reason>"}
+\`\`\`
+
+Rules:
+- Emit exactly one JSON object per line. No multi-line JSON. No markdown fences.
+- Emit exactly one tool call per input component. The "name" field must match a component name from the input array exactly. Tool calls may appear in any order.
+- You may emit prose lines (not starting with {) to reason before each tool call — they are ignored by the parser.`;
+}
+function buildTokensAutonomousPreamble(inputBlock) {
+    return `You are running as part of the experience-design-system-cli generate pipeline in AUTONOMOUS mode. The developer is not present to answer questions.
+
+Your task: classify every raw token from the input below into a DTCG token tree. Apply all judgment calls yourself — do not pause to ask for confirmation. Include a "description" field on each set_token call to document your reasoning.
+
+All input data is provided inline below — do not read any additional files.${inputBlock}
+
+## Output protocol
+
+Do NOT write any files or emit any JSON blobs. Instead, emit one JSON object per line to stdout for each token or group. The CLI reads your stdout line by line and writes each entry directly to the pipeline database.
+
+The two tool calls you may emit are:
+
+\`\`\`
+{"tool":"set_group","path":"<dot.notation.path>","description":"<optional group description>"}
+
+{"tool":"set_token","path":"<dot.notation.path>","type":"<DTCG type>","value":<value>,"description":"<reason>"}
+\`\`\`
+
+Rules:
+- Emit exactly one JSON object per line. No multi-line JSON. No markdown fences.
+- Emit a set_group call for every intermediate group node in the tree.
+- Emit a set_token call for every leaf token.
+- "path" is dot-notation, e.g. "colors.brand.primary" — no leading dots or slashes.
+- "type" must be one of the 13 valid DTCG types: color, dimension, fontFamily, fontWeight, duration, cubicBezier, number, strokeStyle, border, transition, shadow, gradient, typography.
+- "value" must be valid JSON (string, number, array, or object depending on the type). Do NOT wrap it in quotes if it is a complex type.
+- Emit set_group calls before the set_token calls that fall under them.
+- You may emit prose lines (not starting with {) anywhere — they are ignored by the parser and serve as your reasoning log.`;
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@contentful/experience-design-system-generation",
+  "version": "2.26.1",
+  "description": "Agent-invocation and skill-prompt engine for the Contentful Experience Design System SDK",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "node": "./dist/src/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://npm.pkg.github.com/"
+  },
+  "files": [
+    "dist/",
+    "skills/"
+  ],
+  "dependencies": {
+    "@contentful/experience-design-system-types": "2.26.1"
+  },
+  "devDependencies": {
+    "@tsconfig/node24": "^24.0.4",
+    "@types/node": "^24.0.3",
+    "eslint": "^9.39.5",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "typescript-eslint": "^8.67.0",
+    "vitest": "^4.0.16"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/contentful/experience-design-system-sdk-public.git",
+    "directory": "packages/experience-design-system-generation"
+  },
+  "homepage": "https://github.com/contentful/experience-design-system-sdk-public#readme",
+  "bugs": {
+    "url": "https://github.com/contentful/experience-design-system-sdk-public/issues"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "nx build experience-design-system-generation",
+    "typecheck": "nx typecheck experience-design-system-generation",
+    "clean": "nx clean experience-design-system-generation",
+    "test": "nx test experience-design-system-generation",
+    "lint": "nx lint experience-design-system-generation",
+    "lint:fix": "nx lint:fix experience-design-system-generation"
+  }
+}