@pega/sdk 0.0.2 → 0.0.4

package/templates/react-sdk-reference/.github/prompts/generate-all-components.prompt.md

@@ -0,0 +1,411 @@
+---
+agent: agent
+description: Generate components across multiple types (field, template, widget, designSystemExtension) using any design system
+---
+
+## Step 0 — Resolve inputs
+
+Read the user's message carefully. Extract:
+
+- **Design system** — the UI library to use (e.g. `Ant Design`, `Chakra UI`, `Carbon`, `Radix UI`)
+- **Base components folder** — the root folder that contains (or will contain) the component type subfolders (e.g. `src/components/`)
+- **Component types in scope** — which types to generate (default: all four if not specified)
+
+Both **design system** and **base components folder** are required. If either is missing or ambiguous, you MUST stop and ask the user before proceeding. Do not infer any value from the project structure, `.instructions.md` files, existing folders, or any other source.
+
+⛔ **STOP** — If the user's message does not explicitly state BOTH the design system AND the base components folder, ask for the missing items now. Do not proceed to Step 1 until you have explicit answers from the user for all required inputs.
+
+Example questions (ask only the ones that are actually missing):
+
+1. Which design system should I use? (e.g. Ant Design, Chakra UI, Carbon, Radix UI)
+2. What is your base components folder? (e.g. `src/components/`) — subfolders `field/`, `template/`, `widget/`, and `designSystemExtension/` will be used under it.
+
+### Component type scope
+
+Extract which types the user wants from the message:
+
+| User says                                  | Types in scope                                    |
+| ------------------------------------------ | ------------------------------------------------- |
+| "generate all components"                  | field + template + widget + designSystemExtension |
+| "generate field and widget components"     | field + widget                                    |
+| "generate widget, template components"     | widget + template                                 |
+| "generate all components except templates" | field + widget + designSystemExtension            |
+| "replace everything"                       | field + template + widget + designSystemExtension |
+
+Default to **all four types** if the message does not restrict the scope.
+
+### Derived output paths
+
+Once the base folder is known, derive the output path for each type in scope:
+
+| Type                  | Derived path                    |
+| --------------------- | ------------------------------- |
+| field                 | `<base>/field/`                 |
+| template              | `<base>/template/`              |
+| widget                | `<base>/widget/`                |
+| designSystemExtension | `<base>/designSystemExtension/` |
+
+Once design system, base folder, and type scope are resolved, continue to Step 1.
+
+---
+
+## Step 1 — Read general skill files (once, for each type in scope)
+
+Read the general skill file for every type in scope. Do this upfront — do not re-read per component.
+
+| Type                  | Skill file to read                          |
+| --------------------- | ------------------------------------------- |
+| field                 | `.github/skills/field-components.md`        |
+| template              | `.github/skills/template-components.md`     |
+| widget                | `.github/skills/widget-components.md`       |
+| designSystemExtension | `.github/skills/design-system-extension.md` |
+
+Keep all loaded skill files active throughout the entire session.
+
+---
+
+## Step 2 — Install and discover the design system (once)
+
+### 2a — Check and install the DS package
+
+Run this command in your terminal:
+
+```bash
+cat package.json | grep "<design-system-package>"
+```
+
+If the design system package is **not** listed in `dependencies` or `devDependencies`, install it:
+
+```bash
+npm install <design-system-package>
+```
+
+Also install any peer dependencies documented in the package's README. Report what was installed.
+
+### 2b — Discover the DS API from installed files
+
+Run these commands to discover the actual API (do NOT rely on training knowledge):
+
+1. Read the README for correct import paths and usage patterns:
+
+   ```bash
+   cat node_modules/<designSystem>/README.md
+   ```
+
+2. List every exported component:
+
+   ```bash
+   grep "^export" node_modules/<designSystem>/dist/index.d.ts 2>/dev/null || grep -rl "^export" node_modules/<designSystem> --include="index.d.ts" | head -3 | xargs grep "^export"
+   ```
+
+3. For every component you plan to use across all types in scope, read its TypeScript prop interface:
+
+   ```bash
+   find node_modules/<designSystem> -name "ComponentName.d.ts" | head -3
+   grep -A 40 "interface.*Props" <path-from-above>
+   ```
+
+   Focus on primitives needed across **all types in scope**:
+   - **field**: form input controls (Input, Select, Checkbox, DatePicker, etc.)
+   - **template**: grid/layout primitives (Grid, Flex, Columns, SimpleGrid, etc.)
+   - **widget**: card/list/table/button/badge primitives
+   - **designSystemExtension**: alert/notification/avatar primitives
+
+4. Also check:
+   - Whether the DS has a **form layout wrapper** (label + input + helper text) — use it instead of manual margins
+   - Whether it has **size/density/variant conventions** — use built-in props rather than custom padding
+   - Whether it has a **companion icons package** — read its exports before using any icon name; never guess icon names
+   - Whether it has **CSS tokens** — use design system CSS custom properties for spacing; never hardcode `px` values
+
+Only use component names and prop names confirmed in these files.
+
+Build a unified **DS API reference map** covering all types in scope. Reuse it throughout — do not repeat discovery commands per component.
+
+---
+
+## Step 3 — Overwrite check (all types, all at once)
+
+For every type in scope, check whether each component's `<outputPath>/<ComponentName>/<ComponentName>.tsx` already exists.
+
+Collect all existing components across all types and report them in one consolidated list:
+
+> "The following N components already exist across [types]: [list grouped by type]. How should I proceed?
+>
+> - **Overwrite all** — replace all existing implementations
+> - **Skip existing** — only generate components that don't exist yet
+> - **Cancel** — stop without generating anything"
+
+Wait for the user's answer before proceeding. If none exist, continue immediately.
+
+---
+
+## Step 4 — Generate field components (skip if field not in scope)
+
+If `field` is in scope, generate each of the 27 field components in order:
+
+**For each field component:**
+
+### 4.1 — Read the component-specific skill file (MANDATORY — do not skip)
+
+Read the file `.github/skills/field-skills/<ComponentName>.md` using your file reading tool. This step is **required** for every component that has a skill file — do not rely solely on the general `field-components.md`.
+
+After reading, extract and keep active:
+
+- **Behavioral Contract** — state management, option loading, edge cases specific to this component
+- **Design System Mapping** table — the recommended DS component for the chosen design system
+- **UI control type** — use this to select the closest DS primitive if the chosen DS is not in the mapping table
+
+If no skill file exists at that path, use the general behavioral skeleton from `field-components.md` loaded in Step 1.
+
+⚠️ The general skill provides the skeleton. The component-specific skill provides the **exact event handling, option-loading logic, and edge cases**. Both are needed.
+
+### 4.2 — Generate the component files
+
+Create the directory `<base>/field/<ComponentName>/`.
+
+Create `<ComponentName>.tsx` using this structure from `field-components.md` (loaded in Step 1):
+
+1. Imports: React hooks + `handleEvent` from `../../helpers/event-utils` + `getComponentFromRegistry` from `@pega/sdk-react` + `PConnFieldProps` + DS input from Step 2
+2. Interface extending `PConnFieldProps` with any extra props from the component skill file
+3. Destructure: `getPConnect`, `label`, `required`, `disabled`, `value`, `validatemessage`, `status`, `readOnly`, `testId`, `helperText`, `displayMode`, `hideLabel`, `placeholder`
+4. Display mode guards: if `DISPLAY_ONLY` or `STACKED_LARGE_VAL` → return `FieldValueList`
+5. Return → DS form input from Step 2, with `onBlur` calling `handleEvent(actions, 'changeNblur', propName, inputValue)`
+
+Pass `data-test-id={testId}` on the underlying interactive element.
+
+Create `index.tsx`:
+
+```typescript
+export { default } from './<ComponentName>';
+```
+
+### 4.3 — Register the component
+
+Edit `src/components/component-map.ts`:
+
+1. Add an import at the top in the **Fields** section
+2. Add an entry in `getSampleComponentMap()` under the fields comment
+
+### 4.4 — Batch checkpoint
+
+After every **5 field components**, run:
+
+```bash
+npm run build
+```
+
+Fix any errors before continuing.
+
+### 4.5 — Report progress
+
+After each component: "`<ComponentName>` ✓ — using `<DS component name>`"
+
+---
+
+## Step 5 — Generate template components (skip if template not in scope)
+
+If `template` is in scope, generate each of the 32 template components in order:
+
+**For each template component:**
+
+### 5.1 — Read the component-specific skill file (MANDATORY — do not skip)
+
+Read the file `.github/skills/template-skills/<ComponentName>.md` using your file reading tool. This step is **required** for every component — do not rely solely on the general `template-components.md`.
+
+After reading, extract and keep active:
+
+- **Template category** — Layout (uses DS grid from Step 2) | Form (PConnect bridge + CSS) | Page (region extraction + PConnect bridge)
+- **Behavioral Contract** — sub-variants, region handling, slot rendering logic
+- **Design System Mapping** table — the recommended DS layout primitive (for Layout templates only)
+
+If no skill file exists at that path, use the general pattern from `template-components.md` loaded in Step 1.
+
+⚠️ The general skill provides the pattern skeletons. The component-specific skill provides the **exact region structure, sub-variant keys, and rendering logic**. Both are needed.
+
+### 5.2 — Generate the component files
+
+Create the directory `<base>/template/<ComponentName>/`.
+
+Create `<ComponentName>.tsx` using the structure matching the template category from `template-components.md` (loaded in Step 1):
+
+- **Layout**: `PropsWithChildren` + `templateCol` parsing (split on whitespace, strip units, compute ratios) + DS grid/flex from Step 2 rendering children in computed column ratios. On mobile: columns must stack to full width.
+- **Form**: `createElement(createPConnectComponent(), ...)` for each child from `getPConnect().getChildren()[0].getPConnect().getChildren()`. No DS primitives.
+- **Page**: `createElement(createPConnectComponent(), ...)` for each region from `getPConnect().getChildren()`. No DS primitives.
+
+Apply the Behavioral Contract from the component skill file.
+
+Create `index.tsx` if required by the skill file:
+
+```typescript
+export { default } from './<ComponentName>';
+```
+
+Create any CSS file required by the skill file.
+
+### 5.3 — Register the component
+
+Edit `src/components/component-map.ts`:
+
+1. Add an import at the top in the **Templates** section
+2. Add an entry in `getSampleComponentMap()` under the templates comment
+3. For sub-variants (e.g., TwoColumnPage, TwoColumnTab), register each key separately
+
+### 5.4 — Batch checkpoint
+
+After every **5 template components**, run:
+
+```bash
+npm run build
+```
+
+Fix any errors before continuing.
+
+### 5.5 — Report progress
+
+After each component: "`<ComponentName>` ✓ — `<Layout | Form | Page>` template"
+
+---
+
+## Step 6 — Generate widget components (skip if widget not in scope)
+
+If `widget` is in scope, generate each of the 9 widget components in order:
+
+**For each widget component:**
+
+### 6.1 — Read the component-specific skill file (MANDATORY — do not skip)
+
+Read the file `.github/skills/widget-skills/<ComponentName>.md` using your file reading tool. This step is **required** for every component that has a skill file — do not rely solely on the general `widget-components.md`.
+
+After reading, extract and keep active:
+
+- **Behavioral Contract** — the exact PCore API calls, state variables, event handlers, and edge cases specific to this widget
+- **Design System Mapping** table — the recommended DS primitive for this component's presentation layer
+- **Props interface** — any required/optional props beyond the base `PConnProps`
+
+If no skill file exists at that path (e.g., `SummaryList`), use the general data-fetching pattern from `widget-components.md` loaded in Step 1.
+
+⚠️ The general skill provides the skeleton. The component-specific skill provides the **exact data flow and behavioral logic**. Both are needed — generating from only the general skill will produce components that render but don't fetch or display data correctly.
+
+### 6.2 — Generate the component files
+
+Create the directory `<base>/widget/<ComponentName>/`.
+
+Create `<ComponentName>.tsx` using this structure from `widget-components.md` (loaded in Step 1):
+
+1. Imports (React hooks + DS components from Step 2 + `PConnProps` from `@pega/sdk-react`)
+2. Interface extending PConnProps with props from the component skill file's Props table
+3. Component function: destructure `getPConnect`, call `getPConnect()` to get `pConn`
+4. `useEffect` → data fetch using the exact PCore API call from the skill file's Behavioral Contract
+5. Return → DS Card/List/Table primitive from Step 2 API map, rendering the fetched data
+
+Fill in the `// [DS RENDER]` section with DS primitives confirmed in Step 2. The data-fetching logic comes from the skill file's Behavioral Contract — do NOT invent API calls.
+
+Create `index.tsx`:
+
+```typescript
+export { default } from './<ComponentName>';
+```
+
+Create any CSS or utility files required by the skill file.
+
+### 6.3 — Register the component
+
+Edit `src/components/component-map.ts`:
+
+1. Add an import at the top in the **Widgets** section
+2. Add an entry in `getSampleComponentMap()` under the widgets comment
+
+### 6.4 — Batch checkpoint
+
+After every **5 widget components**, run:
+
+```bash
+npm run build
+```
+
+Fix any errors before continuing.
+
+### 6.5 — Report progress
+
+After each component: "`<ComponentName>` ✓ — using `<DS card/list primitive>`"
+
+---
+
+## Step 7 — Generate design system extension components (skip if DSE not in scope)
+
+If `designSystemExtension` is in scope, generate each of the 11 DSE components in order:
+
+**For each DSE component:**
+
+### 7.1 — Read the component-specific skill file (MANDATORY — do not skip)
+
+Read the file `.github/skills/design-system-extension-skills/<ComponentName>.md` using your file reading tool. This step is **required** for every component that has a skill file — do not rely solely on the general `design-system-extension.md`.
+
+After reading, extract and keep active:
+
+- **Pattern classification** — B (Pure display) / A (PConnect display) / C (Complex display)
+- **Behavioral Contract** — prop handling, variant mapping, rendering logic, edge cases
+- **Design System Mapping** table — the recommended DS primitive (Pattern B components only)
+
+If no skill file exists at that path, use the general pattern from `design-system-extension.md` loaded in Step 1.
+
+⚠️ The general skill provides the pattern skeletons. The component-specific skill provides the **exact prop interface, variant logic, and edge cases**. Both are needed.
+
+### 7.2 — Generate the component files
+
+Create the directory `<base>/designSystemExtension/<ComponentName>/`.
+
+Create `<ComponentName>.tsx` using the structure matching the pattern from `design-system-extension.md` (loaded in Step 1):
+
+- **Pattern B** (Pure display — AlertBanner, Banner, Operator, WssQuickCreate): variant mapping (urgent→error, warning→warning, info→info, success→success) + DS Alert/Card/Avatar primitive from Step 2. No `getPConnect`.
+- **Pattern A** (PConnect display — CaseSummaryFields, DetailsFields, FieldValueList): CSS classes + optional DS typography, no DS component primitives. May use `getPConnect`.
+- **Pattern C** (Complex display — FieldGroup, FieldGroupList, Pulse, RichTextEditor): `createElement(createPConnectComponent(), ...)` for PConnect children, semantic HTML. No DS primitives.
+
+Apply the Behavioral Contract from the component skill file.
+
+Create `index.tsx` if required by the skill file:
+
+```typescript
+export { default } from './<ComponentName>';
+```
+
+Create any CSS file required by the skill file.
+
+### 7.3 — Register the component
+
+Edit `src/components/component-map.ts`:
+
+1. Add an import at the top in the **Design System Extension** section
+2. Add an entry in `getSampleComponentMap()` under the DSE comment
+
+### 7.4 — Batch checkpoint
+
+After every **5 DSE components**, run:
+
+```bash
+npm run build
+```
+
+Fix any errors before continuing.
+
+### 7.5 — Report progress
+
+After each component: "`<ComponentName>` ✓ — Pattern `<B/A/C>`"
+
+---
+
+## Step 8 — Verify the build
+
+Run:
+
+```bash
+npm run build
+```
+
+Fix any TypeScript or build errors before reporting completion.
+
+Report a final summary:
+
+- Total components generated, grouped by type
+- All entries added to `component-map.ts`
+- Any components skipped (if "skip existing" was chosen in Step 3)

package/templates/react-sdk-reference/.github/prompts/generate-dse-components.prompt.md

@@ -0,0 +1,205 @@
+---
+agent: agent
+description: Generate all (or a subset of) design system extension components using any design system
+---
+
+## Step 0 — Resolve inputs
+
+Read the user's message carefully. Extract:
+
+- **Design system** — the UI library to use (e.g. `Ant Design`, `Chakra UI`, `Carbon`, `Radix UI`)
+- **Output base path** — the folder where DSE components should be generated (e.g. `src/components/designSystemExtension/`)
+- **Component list** — which components to generate (default: all 11 listed below)
+
+Both **design system** and **output base path** are required. If either is missing or ambiguous, you MUST stop and ask the user before proceeding. Do not infer any value from the project structure, `.instructions.md` files, existing folders, or any other source.
+
+⛔ **STOP** — If the user's message does not explicitly state BOTH the design system AND the output path, ask for the missing items now. Do not proceed to Step 1 until you have explicit answers from the user for all required inputs.
+
+Example questions (ask only the ones that are actually missing):
+
+1. Which design system should I use? (e.g. Ant Design, Chakra UI, Carbon, Radix UI)
+2. Where should the DSE components be generated? (e.g. `src/components/designSystemExtension/`)
+
+If the user specified a subset (e.g., "just AlertBanner and FieldValueList"), restrict the list accordingly.
+
+Once both are known, continue to Step 1.
+
+### Full component list (default — 11 DSE components)
+
+| Component         | Pattern              | DS needed?    |
+| ----------------- | -------------------- | ------------- |
+| AlertBanner       | B — Pure display     | Yes           |
+| Banner            | B — Pure display     | Yes           |
+| CaseSummaryFields | A — PConnect display | Minimal       |
+| DetailsFields     | A — PConnect display | Minimal       |
+| FieldGroup        | C — Complex display  | No            |
+| FieldGroupList    | C — Complex display  | No            |
+| FieldValueList    | A — PConnect display | No (CSS only) |
+| Operator          | B — Pure display     | Yes           |
+| Pulse             | C — Complex display  | No            |
+| RichTextEditor    | C — Complex display  | No            |
+| WssQuickCreate    | B — Pure display     | Yes           |
+
+---
+
+## Step 1 — Read `design-system-extension.md` (once, for the entire session)
+
+Read the full contents of `.github/skills/design-system-extension.md`.
+
+This gives you:
+
+- All three implementation patterns (Pure display, Field value display, Complex display with PConnect)
+- The `// [DS RENDER]` placeholder approach for Pattern B components
+- The Design System Adaptation section — pattern categorisation, variant mapping table, DS discovery guidance
+- Styling patterns — when to use CSS files vs DS style props
+- Registration conventions
+
+Keep this context active throughout the entire generation session. Do not re-read it per component.
+
+---
+
+## Step 2 — Install and discover the design system (once)
+
+### 2a — Check and install the DS package
+
+Run this command in your terminal:
+
+```bash
+cat package.json | grep "<design-system-package>"
+```
+
+If the design system package is **not** listed in `dependencies` or `devDependencies`, install it:
+
+```bash
+npm install <design-system-package>
+```
+
+Also install any peer dependencies documented in the package's README. Report what was installed.
+
+### 2b — Discover the DS display primitives from installed files
+
+> Pattern A/C components (FieldValueList, FieldGroup, Pulse, etc.) use PConnect bridge or plain CSS — they do not use the DS API. Only Pattern B components consume DS primitives.
+
+Run these commands to discover the actual API (do NOT rely on training knowledge):
+
+1. Read the README for correct import paths and usage patterns:
+
+   ```bash
+   cat node_modules/<designSystem>/README.md
+   ```
+
+2. List every exported component — focus on display primitives (Alert, Card, Avatar, Badge, Tag, Notification):
+
+   ```bash
+   grep "^export" node_modules/<designSystem>/dist/index.d.ts 2>/dev/null || grep -rl "^export" node_modules/<designSystem> --include="index.d.ts" | head -3 | xargs grep "^export"
+   ```
+
+3. For every display primitive you plan to use, read its prop interface:
+
+   ```bash
+   find node_modules/<designSystem> -name "Alert.d.ts" -o -name "Card.d.ts" -o -name "Avatar.d.ts" | head -5
+   grep -A 40 "interface.*Props" <path-from-above>
+   ```
+
+4. Check for **variant/type/severity prop names** — each DS uses different names for alert severity (e.g., `type`, `status`, `severity`, `variant`).
+
+Only use component names and prop names confirmed in these files.
+
+Build a **DS display primitive reference map** from this discovery. Reuse it for every Pattern B component — do not repeat these commands per component.
+
+---
+
+## Step 3 — Overwrite check (all at once)
+
+For each component in the list, check whether `<outputPath>/<ComponentName>/<ComponentName>.tsx` already exists.
+
+If **any** exist, report them all at once and ask:
+
+> "The following N components already exist: [list]. How should I proceed?
+>
+> - **Overwrite all** — replace all existing implementations
+> - **Skip existing** — only generate components that don't exist yet
+> - **Cancel** — stop without generating anything"
+
+Wait for the user's answer before proceeding. If none exist, continue immediately.
+
+---
+
+## Step 4 — Generate each component (loop)
+
+For each component in the resolved list (in the order listed in Step 0):
+
+### 4a — Read the component-specific skill file (MANDATORY — do not skip)
+
+Read the file `.github/skills/design-system-extension-skills/<ComponentName>.md` using your file reading tool. This step is **required** for every component that has a skill file — do not rely solely on the general `design-system-extension.md`.
+
+After reading, extract and keep active:
+
+- **Pattern classification** — B (Pure display) / A (PConnect display) / C (Complex display)
+- **Behavioral Contract** — prop handling, variant mapping, rendering logic, edge cases
+- **Design System Mapping** table — the recommended DS primitive (Pattern B components only)
+
+If no skill file exists at that path, use the general pattern from `design-system-extension.md` loaded in Step 1.
+
+⚠️ The general skill file (`design-system-extension.md`) provides the pattern skeletons. The component-specific skill file provides the **exact prop interface, variant logic, and edge cases**. Both are needed — generating from only the general skill will produce components that render empty or with incorrect variant handling.
+
+### 4b — Generate the component files
+
+Create the directory `<outputPath>/<ComponentName>/`.
+
+Create `<ComponentName>.tsx` using the structure matching the pattern from `design-system-extension.md` (loaded in Step 1):
+
+- **Pattern B** (Pure display — AlertBanner, Banner, Operator, WssQuickCreate): variant mapping (urgent→error, warning→warning, info→info, success→success) + DS Alert/Card/Avatar primitive from Step 2. No `getPConnect`.
+- **Pattern A** (PConnect display — CaseSummaryFields, DetailsFields, FieldValueList): CSS classes + optional DS typography, no DS component primitives. May use `getPConnect`.
+- **Pattern C** (Complex display — FieldGroup, FieldGroupList, Pulse, RichTextEditor): `createElement(createPConnectComponent(), ...)` for PConnect children, semantic HTML. No DS primitives.
+
+Apply the Behavioral Contract from the component skill file (exact props, variant logic, edge cases).
+
+Create `index.tsx` if required by the skill file:
+
+```typescript
+export { default } from './<ComponentName>';
+```
+
+Create any CSS file required by the skill file.
+
+### 4c — Register the component
+
+Edit `src/components/component-map.ts`:
+
+1. Add an import at the top of the file in the **Design System Extension** section:
+   ```typescript
+   import <ComponentName> from './designSystemExtension/<ComponentName>';
+   ```
+2. Add an entry in the return object of `getSampleComponentMap()` under the DSE comment:
+   ```typescript
+   <ComponentName>,
+   ```
+
+Do not reorder or restructure any existing entries.
+
+### 4d — Batch checkpoint
+
+After every **5 components**, run:
+
+```bash
+npm run build
+```
+
+Fix any TypeScript or build errors before continuing to the next component. This prevents error accumulation.
+
+### 4e — Report progress
+
+After each component: "`<ComponentName>` ✓ — Pattern `<B/A/C>`<`, using <DS primitive>` if Pattern B>"
+
+---
+
+## Step 5 — Verify the build
+
+Run:
+
+```bash
+npm run build
+```
+
+If build errors occur, fix them before reporting completion. Report a summary: list of all files created and all entries added to `component-map.ts`.