@pega/sdk 0.0.5 → 0.0.6
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/README.md +10 -3
- package/dist/index.js +764 -165
- package/package.json +1 -1
- package/templates/react-native-sdk-reference/.claude/settings.json +5 -0
- package/templates/react-native-sdk-reference/.prettierignore +17 -0
- package/templates/react-native-sdk-reference/.vscode/extensions.json +1 -0
- package/templates/react-native-sdk-reference/.vscode/settings.json +7 -0
- package/templates/react-native-sdk-reference/AGENTS.md +3 -0
- package/templates/react-native-sdk-reference/CLAUDE.md +1 -0
- package/templates/react-native-sdk-reference/README.md +56 -0
- package/templates/react-native-sdk-reference/app.json +40 -5
- package/templates/react-native-sdk-reference/assets/expo.icon/Assets/expo-symbol 2.svg +3 -0
- package/templates/react-native-sdk-reference/assets/expo.icon/Assets/grid.png +0 -0
- package/templates/react-native-sdk-reference/assets/expo.icon/icon.json +35 -0
- package/templates/react-native-sdk-reference/assets/icons/bell.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/clock.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/cross.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/donut.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/gear.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/globe.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/internet.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/music.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/right-arrow.png +0 -0
- package/templates/react-native-sdk-reference/assets/icons/speed.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/MediaCo.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/adaptive-icon.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/android-icon-background.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/android-icon-foreground.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/android-icon-monochrome.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/expo-badge-white.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/expo-badge.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/expo-logo.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/favicon.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/icon.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/logo-glow.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/partial-react-logo.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/react-logo.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/react-logo@2x.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/react-logo@3x.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/splash-icon.png +0 -0
- package/templates/react-native-sdk-reference/assets/images/tutorial-web.png +0 -0
- package/templates/react-native-sdk-reference/eslint.config.mjs +68 -0
- package/templates/react-native-sdk-reference/package.json +59 -14
- package/templates/react-native-sdk-reference/pega-constellationjs-0.26.3.tgz +0 -0
- package/templates/react-native-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
- package/templates/react-native-sdk-reference/pega-sdk-types-0.1.0.tgz +0 -0
- package/templates/react-native-sdk-reference/sdk-config.json +31 -9
- package/templates/react-native-sdk-reference/src/app/_layout.tsx +38 -0
- package/templates/react-native-sdk-reference/src/app/home/_layout.tsx +39 -0
- package/templates/react-native-sdk-reference/src/app/home/contact.tsx +11 -0
- package/templates/react-native-sdk-reference/src/app/home/index.tsx +36 -0
- package/templates/react-native-sdk-reference/src/app/home/shop.tsx +11 -0
- package/templates/react-native-sdk-reference/src/app/home/your-services.tsx +11 -0
- package/templates/react-native-sdk-reference/src/app/index.tsx +72 -0
- package/templates/react-native-sdk-reference/src/app/workarea.tsx +135 -0
- package/templates/react-native-sdk-reference/src/bridge/Context/StoreContext.ts +4 -0
- package/templates/react-native-sdk-reference/src/bridge/RootComponent.tsx +12 -0
- package/templates/react-native-sdk-reference/src/bridge/react_pconnect.jsx +334 -0
- package/templates/react-native-sdk-reference/src/components/common/DisplayField.tsx +29 -0
- package/templates/react-native-sdk-reference/src/components/common/FormFieldWrapper.tsx +5 -0
- package/templates/react-native-sdk-reference/src/components/common/HelperText.tsx +11 -0
- package/templates/react-native-sdk-reference/src/components/common/LabelText.tsx +22 -0
- package/templates/react-native-sdk-reference/src/components/common/inputTheme.ts +17 -0
- package/templates/react-native-sdk-reference/src/components/design-system/AutoComplete.tsx +126 -0
- package/templates/react-native-sdk-reference/src/components/design-system/FieldGroup.tsx +72 -0
- package/templates/react-native-sdk-reference/src/components/design-system/Radio.tsx +61 -0
- package/templates/react-native-sdk-reference/src/components/field/AutoComplete/AutoComplete.tsx +196 -0
- package/templates/react-native-sdk-reference/src/components/field/AutoComplete/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Checkbox/Checkbox.tsx +89 -0
- package/templates/react-native-sdk-reference/src/components/field/Checkbox/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Currency/Currency.tsx +84 -0
- package/templates/react-native-sdk-reference/src/components/field/Currency/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Date/Date.tsx +94 -0
- package/templates/react-native-sdk-reference/src/components/field/Date/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Dropdown/Dropdown.tsx +211 -0
- package/templates/react-native-sdk-reference/src/components/field/Dropdown/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Email/Email.tsx +81 -0
- package/templates/react-native-sdk-reference/src/components/field/Email/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Group/Group.tsx +47 -0
- package/templates/react-native-sdk-reference/src/components/field/Group/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Integer/Integer.tsx +84 -0
- package/templates/react-native-sdk-reference/src/components/field/Integer/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/Phone/Phone.tsx +85 -0
- package/templates/react-native-sdk-reference/src/components/field/Phone/index.ts +1 -0
- package/templates/react-native-sdk-reference/src/components/field/RadioButtons/RadioButtons.tsx +118 -0
- package/templates/react-native-sdk-reference/src/components/field/RadioButtons/index.ts +1 -0
- package/templates/react-native-sdk-reference/src/components/field/TextArea/TextArea.tsx +86 -0
- package/templates/react-native-sdk-reference/src/components/field/TextArea/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/TextInput/TextInput.tsx +84 -0
- package/templates/react-native-sdk-reference/src/components/field/TextInput/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/field/URL/URL.tsx +86 -0
- package/templates/react-native-sdk-reference/src/components/field/URL/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/helpers/data_page.ts +20 -0
- package/templates/react-native-sdk-reference/src/components/helpers/event-utils.ts +20 -0
- package/templates/react-native-sdk-reference/src/components/helpers/instructions-utils.ts +57 -0
- package/templates/react-native-sdk-reference/src/components/helpers/state-utils.tsx +46 -0
- package/templates/react-native-sdk-reference/src/components/helpers/template-utils.ts +75 -0
- package/templates/react-native-sdk-reference/src/components/helpers/utils.ts +339 -0
- package/templates/react-native-sdk-reference/src/components/infra/ActionButtons/ActionButtons.tsx +63 -0
- package/templates/react-native-sdk-reference/src/components/infra/ActionButtons/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Assignment/Assignment.tsx +348 -0
- package/templates/react-native-sdk-reference/src/components/infra/Assignment/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/AssignmentCard/AssignmentCard.tsx +56 -0
- package/templates/react-native-sdk-reference/src/components/infra/AssignmentCard/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/FlowContainer/FlowContainer.tsx +57 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/FlowContainer/helpers.ts +137 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/FlowContainer/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/RootContainer/RootContainer.tsx +52 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/RootContainer/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/SimpleView/helper.ts +128 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/SimpleView/index.tsx +59 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/ViewContainer/ViewContainer.tsx +31 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/ViewContainer/helper.ts +39 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/ViewContainer/index.ts +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Containers/helper.ts +9 -0
- package/templates/react-native-sdk-reference/src/components/infra/ErrorBoundary/ErrorBoundary.tsx +53 -0
- package/templates/react-native-sdk-reference/src/components/infra/ErrorBoundary/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/MultiStep/MultiStep.tsx +24 -0
- package/templates/react-native-sdk-reference/src/components/infra/MultiStep/index.ts +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Reference/Reference.tsx +68 -0
- package/templates/react-native-sdk-reference/src/components/infra/Reference/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/Reference/utils.ts +16 -0
- package/templates/react-native-sdk-reference/src/components/infra/Region/Region.tsx +10 -0
- package/templates/react-native-sdk-reference/src/components/infra/Region/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/infra/View/View.tsx +49 -0
- package/templates/react-native-sdk-reference/src/components/template/DefaultForm/DefaultForm.tsx +38 -0
- package/templates/react-native-sdk-reference/src/components/template/DefaultForm/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/template/DefaultForm/utils/index.ts +28 -0
- package/templates/react-native-sdk-reference/src/components/template/Details/Details.tsx +82 -0
- package/templates/react-native-sdk-reference/src/components/template/Details/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/components/template/OneColumn/OneColumn.tsx +29 -0
- package/templates/react-native-sdk-reference/src/components/template/OneColumn/index.tsx +1 -0
- package/templates/react-native-sdk-reference/src/context/LoaderContext.tsx +42 -0
- package/templates/react-native-sdk-reference/src/mediaco/AdvBanner.tsx +62 -0
- package/templates/react-native-sdk-reference/src/mediaco/Header.tsx +60 -0
- package/templates/react-native-sdk-reference/src/mediaco/HomeScreen.tsx +78 -0
- package/templates/react-native-sdk-reference/src/mediaco/QuickActions.tsx +68 -0
- package/templates/react-native-sdk-reference/src/mediaco/ResolutionScreen.tsx +48 -0
- package/templates/react-native-sdk-reference/src/mediaco/SafeArea.tsx +11 -0
- package/templates/react-native-sdk-reference/src/mediaco/TabBar.tsx +102 -0
- package/templates/react-native-sdk-reference/src/mediaco/YourServices.tsx +90 -0
- package/templates/react-native-sdk-reference/src/sdk-pega-component-map.ts +64 -0
- package/templates/react-native-sdk-reference/src/types/PConnProps.d.ts +41 -0
- package/templates/react-native-sdk-reference/src/utils/auth.ts +62 -0
- package/templates/react-native-sdk-reference/src/utils/init-pcore.ts +37 -0
- package/templates/react-native-sdk-reference/src/utils/pcore-polyfills.ts +66 -0
- package/templates/react-native-sdk-reference/tsconfig.json +9 -8
- package/templates/react-sdk-reference/.ai-common/agents/embedded-flow-expert.md +171 -0
- package/templates/react-sdk-reference/.ai-common/agents/implementation-expert.md +25 -26
- package/templates/react-sdk-reference/.ai-common/global/ai-agent-instructions-embedded.md +119 -0
- package/templates/react-sdk-reference/.ai-common/global/ai-agent-instructions.md +70 -121
- package/templates/react-sdk-reference/.ai-common/instructions/component-map.md +7 -19
- package/templates/react-sdk-reference/.ai-common/instructions/dse-component.md +10 -40
- package/templates/react-sdk-reference/.ai-common/instructions/embedded-component.md +134 -0
- package/templates/react-sdk-reference/.ai-common/instructions/field-component.md +15 -43
- package/templates/react-sdk-reference/.ai-common/instructions/template-component.md +11 -63
- package/templates/react-sdk-reference/.ai-common/instructions/widget-component.md +12 -57
- package/templates/react-sdk-reference/.ai-common/prompts/add-component.md +45 -71
- package/templates/react-sdk-reference/.ai-common/prompts/component-manifest.json +98 -0
- package/templates/react-sdk-reference/.ai-common/prompts/embedded-component-manifest.md +155 -0
- package/templates/react-sdk-reference/.ai-common/prompts/generate-all-components.md +67 -237
- package/templates/react-sdk-reference/.ai-common/prompts/generate-dse-components.md +26 -77
- package/templates/react-sdk-reference/.ai-common/prompts/generate-embedded-components.md +315 -0
- package/templates/react-sdk-reference/.ai-common/prompts/generate-field-components.md +31 -80
- package/templates/react-sdk-reference/.ai-common/prompts/generate-template-components.md +43 -99
- package/templates/react-sdk-reference/.ai-common/prompts/generate-widget-components.md +33 -83
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/AlertBanner.md +60 -74
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/Banner.md +64 -84
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/CaseSummaryFields.md +76 -109
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/DetailsFields.md +84 -101
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/FieldGroup.md +62 -87
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/FieldGroupList.md +56 -76
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/FieldValueList.md +61 -85
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/Operator.md +84 -107
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/Pulse.md +36 -44
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/RichTextEditor.md +125 -189
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension-skills/WssQuickCreate.md +34 -50
- package/templates/react-sdk-reference/.ai-common/skills/design-system-extension.md +57 -179
- package/templates/react-sdk-reference/.ai-common/skills/embedded-flow/analyze-customer-repo.md +130 -0
- package/templates/react-sdk-reference/.ai-common/skills/embedded-flow/authenticate.md +311 -0
- package/templates/react-sdk-reference/.ai-common/skills/embedded-flow/run-and-verify-integration.md +156 -0
- package/templates/react-sdk-reference/.ai-common/skills/embedded-flow/wire-integration.md +476 -0
- package/templates/react-sdk-reference/.ai-common/skills/field-components.md +120 -242
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/AutoComplete.md +71 -212
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/CancelAlert.md +47 -209
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Checkbox.md +90 -259
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Currency.md +75 -169
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Date.md +65 -160
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/DateTime.md +59 -157
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Decimal.md +55 -134
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Dropdown.md +61 -185
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Email.md +60 -138
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Group.md +40 -99
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Integer.md +44 -111
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Location.md +57 -165
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Multiselect.md +41 -122
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/ObjectReference.md +32 -130
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Percentage.md +48 -112
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Phone.md +43 -153
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/RadioButtons.md +76 -183
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/RichText.md +59 -176
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/ScalarList.md +30 -123
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/SelectableCard.md +47 -178
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/SemanticLink.md +31 -117
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/TextArea.md +51 -106
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/TextContent.md +22 -75
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/TextInput.md +54 -116
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/Time.md +46 -100
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/URL.md +44 -93
- package/templates/react-sdk-reference/.ai-common/skills/field-skills/UserReference.md +40 -167
- package/templates/react-sdk-reference/.ai-common/skills/infra-components.md +165 -0
- package/templates/react-sdk-reference/.ai-common/skills/infra-skills/ActionButtons.md +122 -0
- package/templates/react-sdk-reference/.ai-common/skills/infra-skills/MultiStep.md +178 -0
- package/templates/react-sdk-reference/.ai-common/skills/infra-skills/Stages.md +140 -0
- package/templates/react-sdk-reference/.ai-common/skills/template-components.md +74 -228
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/AdvancedSearch.md +66 -167
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/AppShell.md +57 -170
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/BannerPage.md +41 -76
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/CaseSummary.md +53 -109
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/CaseView.md +86 -289
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/CaseViewActionsMenu.md +60 -185
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/Confirmation.md +66 -115
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DataReference.md +33 -68
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DefaultForm.md +53 -133
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DefaultPage.md +39 -82
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/Details.md +38 -91
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DetailsSubTabs.md +47 -101
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DetailsThreeColumn.md +27 -34
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DetailsTwoColumn.md +25 -40
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/DynamicTabs.md +34 -104
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/FieldGroupTemplate.md +46 -147
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/HierarchicalForm.md +139 -100
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/InlineDashboard.md +43 -82
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/InlineDashboardPage.md +47 -80
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/ListPage.md +16 -29
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/ListView.md +43 -228
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/MultiReferenceReadOnly.md +20 -65
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/NarrowWide.md +49 -97
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/OneColumn.md +37 -71
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/PromotedFilters.md +58 -148
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/SelfServiceCaseView.md +82 -107
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/SimpleTable.md +21 -60
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/SingleReferenceReadOnly.md +43 -100
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/SubTabs.md +36 -76
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/TwoColumn.md +41 -90
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/WideNarrow.md +36 -43
- package/templates/react-sdk-reference/.ai-common/skills/template-skills/WssNavBar.md +25 -115
- package/templates/react-sdk-reference/.ai-common/skills/widget-components.md +38 -174
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/AppAnnouncement.md +30 -57
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/Attachment.md +55 -101
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/CaseHistory.md +38 -121
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/FileUtility.md +37 -98
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/Followers.md +18 -33
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/QuickCreate.md +26 -91
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/SummaryItem.md +28 -120
- package/templates/react-sdk-reference/.ai-common/skills/widget-skills/ToDo.md +41 -272
- package/templates/react-sdk-reference/package.json +1 -1
- package/templates/react-sdk-reference/pega-auth-0.2.44.tgz +0 -0
- package/templates/react-sdk-reference/pega-sdk-react-0.1.0.tgz +0 -0
- package/templates/react-sdk-reference/src/components/helpers/formatters/index.ts +13 -3
- package/templates/react-native-sdk-reference/.github/AGENTS.md +0 -23
- package/templates/react-native-sdk-reference/.github/copilot-instructions.md +0 -40
- package/templates/react-native-sdk-reference/.github/skills/pega-sdk-component.md +0 -48
- package/templates/react-native-sdk-reference/App.tsx +0 -49
- package/templates/react-native-sdk-reference/expo-env.d.ts +0 -3
- package/templates/react-sdk-reference/pega-auth-0.2.42.tgz +0 -0
|
@@ -10,30 +10,31 @@ Case view template. Renders the full case workspace: summary sidebar, stages, to
|
|
|
10
10
|
>
|
|
11
11
|
> This is the most complex Page template (~260 lines in the reference). It MUST NOT be collapsed into a single-line return. The following are MANDATORY in the generated output:
|
|
12
12
|
>
|
|
13
|
-
> 1. `getChildRegionByName()`
|
|
14
|
-
> 2. `
|
|
15
|
-
> 3. `
|
|
16
|
-
> 4. `
|
|
17
|
-
> 5.
|
|
18
|
-
> 6.
|
|
19
|
-
> 7. `displayOnlyFA` check from
|
|
20
|
-
> 8. `activeVertTab` state for tracking which tab is selected
|
|
21
|
-
> 9. `vertTabInfo` + `deferLoadInfo`
|
|
13
|
+
> 1. `getChildRegionByName` from `PCore.getSDKUtils().getSDKCaseUtils()` — extract regions by metadata name, NOT by array index, NOT by a custom helper calling `child.getPConnect()`
|
|
14
|
+
> 2. Resolve `VerticalTabs` from the project's component registry — for tab navigation in the sidebar
|
|
15
|
+
> 3. Resolve `DeferLoad` from the project's component registry — for lazy-loading tab content
|
|
16
|
+
> 4. Resolve `CaseViewActionsMenu` from the project's component registry — for case actions
|
|
17
|
+
> 5. Lifecycle effect for `VerticalTabClick` event listener (add + remove on teardown)
|
|
18
|
+
> 6. Lifecycle effect for `hasNewAttachments` → publish `CASE_ATTACHMENTS_UPDATED`
|
|
19
|
+
> 7. `displayOnlyFA` check from the application store context — renders only todo region in focused action mode
|
|
20
|
+
> 8. `activeVertTab` local state for tracking which tab is selected
|
|
21
|
+
> 9. `vertTabInfo` + `deferLoadInfo` obtained from `extractTabsInfo(theTabsRegion)` SDK utility — **`vertTabInfo` MUST be `{ name: string; id: number }[]`, NOT a renderable element**
|
|
22
22
|
> 10. 3-column grid layout: sidebar (3) + main content (6) + utilities (3)
|
|
23
23
|
>
|
|
24
24
|
> **Minimum Implementation Checklist:**
|
|
25
25
|
>
|
|
26
|
-
> - [ ] `getChildRegionByName
|
|
26
|
+
> - [ ] `getChildRegionByName` and `extractTabsInfo` obtained from `PCore.getSDKUtils().getSDKCaseUtils()`
|
|
27
27
|
> - [ ] All 5 named regions extracted: summary, stages, todo, utilities, tabs
|
|
28
|
-
> - [ ]
|
|
28
|
+
> - [ ] Regions rendered DIRECTLY in the template — NOT passed through the PConnect bridge component
|
|
29
|
+
> - [ ] **Case header card** rendered at top of sidebar with: title (`header` input), subheader (case ID), action buttons from `availableActions`, CaseViewActionsMenu
|
|
29
30
|
> - [ ] Action buttons rendered **dynamically from `caseInfo.availableActions`** — labels localized via `PCore.getLocaleUtils().getLocaleValue()`
|
|
30
31
|
> - [ ] VerticalTabs component rendered with tab config array
|
|
31
32
|
> - [ ] DeferLoad component rendered with `name={deferLoadInfo[activeTab].config.name}` — **NOT the display label**
|
|
32
33
|
> - [ ] **`vertTabInfo` and `deferLoadInfo` are SEPARATE arrays** — never merged into one
|
|
33
34
|
> - [ ] CaseViewActionsMenu rendered **inside the case header card** (NOT standalone)
|
|
34
35
|
> - [ ] displayOnlyFA check returning only todo region
|
|
35
|
-
> - [ ]
|
|
36
|
-
> - [ ]
|
|
36
|
+
> - [ ] Lifecycle effect for VerticalTabClick event
|
|
37
|
+
> - [ ] Lifecycle effect for hasNewAttachments pub/sub
|
|
37
38
|
> - [ ] **Stages region in CENTER column** (main), NOT in sidebar
|
|
38
39
|
|
|
39
40
|
---
|
|
@@ -42,208 +43,73 @@ Case view template. Renders the full case workspace: summary sidebar, stages, to
|
|
|
42
43
|
|
|
43
44
|
The primary case workspace template. Extracts named regions from PConnect children by metadata type and name, arranges them in a 3-column responsive grid (3/6/3), handles deferred tab loading, and supports a `displayOnlyFA` mode that shows only the to-do region. Edit actions are triggered via the utilities column.
|
|
44
45
|
|
|
45
|
-
> **Note:** `ObjectPage` is a direct re-export of `CaseView` —
|
|
46
|
+
> **Note:** `ObjectPage` is a direct re-export of `CaseView` — the ObjectPage module simply re-exports CaseView's default export. Do not create a separate `ObjectPage` component; register both keys pointing to the same implementation.
|
|
46
47
|
|
|
47
48
|
## Pega Metadata
|
|
48
49
|
|
|
49
50
|
- **Registration key:** `CaseView` and `ObjectPage` (both point to the same component)
|
|
50
51
|
- **Category:** Page template — case workspace
|
|
51
|
-
- **Extends:**
|
|
52
|
-
|
|
53
|
-
##
|
|
54
|
-
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
| `children`
|
|
58
|
-
| `displayOnlyFA`
|
|
59
|
-
| `getPConnect`
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
interface
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
} = props;
|
|
90
|
-
const { lastUpdateCaseTime = getPConnect().getValue('caseInfo.lastUpdateTime') } = props;
|
|
91
|
-
const currentCaseID = props.caseInfo.ID;
|
|
92
|
-
const { displayOnlyFA } = useContext<any>(StoreContext);
|
|
93
|
-
const thePConn = getPConnect();
|
|
94
|
-
|
|
95
|
-
// 3. Extract named regions from children by metadata type+name
|
|
96
|
-
// IMPORTANT: children may be a single element or array — normalize first
|
|
97
|
-
const childArr = Array.isArray(children) ? children : [children].filter(Boolean);
|
|
98
|
-
function getChildRegionByName(inName: string): any {
|
|
99
|
-
for (const child of childArr as ReactElement[]) {
|
|
100
|
-
const meta = (child as any)?.props?.getPConnect?.()?.getRawMetadata?.();
|
|
101
|
-
if (meta?.type?.toLowerCase() === 'region' && meta?.name?.toLowerCase() === inName)
|
|
102
|
-
return child;
|
|
103
|
-
}
|
|
104
|
-
return null;
|
|
105
|
-
}
|
|
106
|
-
const theSummaryRegion = getChildRegionByName('summary');
|
|
107
|
-
const theStagesRegion = getChildRegionByName('stages');
|
|
108
|
-
const theTodoRegion = getChildRegionByName('todo');
|
|
109
|
-
const theUtilitiesRegion = getChildRegionByName('utilities');
|
|
110
|
-
const theTabsRegion = getChildRegionByName('tabs');
|
|
111
|
-
|
|
112
|
-
// 4. Build tab info + deferred load info from tabs region children
|
|
113
|
-
// ⚠️ CRITICAL: vertTabInfo MUST be an array of { name, id } objects.
|
|
114
|
-
// DO NOT pass the React element (theTabsRegion) directly to <VerticalTabs tabconfig={...}>.
|
|
115
|
-
// VerticalTabs calls tabconfig.map() — passing a React element causes:
|
|
116
|
-
// "TypeError: tabconfig.map is not a function"
|
|
117
|
-
//
|
|
118
|
-
// ⚠️ CRITICAL: vertTabInfo and deferLoadInfo MUST be TWO SEPARATE arrays.
|
|
119
|
-
// - vertTabInfo stores { name: LABEL, id } — the DISPLAY LABEL for VerticalTabs UI
|
|
120
|
-
// - deferLoadInfo stores { config } — the FULL CONFIG object including config.name
|
|
121
|
-
// - DeferLoad's `name` prop MUST use deferLoadInfo[activeTab].config.name
|
|
122
|
-
// (the VIEW RULE NAME, e.g., "pyDetailsTabContent")
|
|
123
|
-
// - DO NOT pass the display label (e.g., "Details") to DeferLoad — it causes:
|
|
124
|
-
// "View not found for the given parameter ID" (404 on /views/Details/refresh)
|
|
125
|
-
// - config.label = "Details" (display) ≠ config.name = "pyDetailsTabContent" (view rule)
|
|
126
|
-
// DO NOT collapse these into a single array. They serve different purposes.
|
|
127
|
-
const vertTabInfo: { name: string; id: number }[] = [];
|
|
128
|
-
const deferLoadInfo: any[] = [];
|
|
129
|
-
const tabChildren = theTabsRegion?.props?.getPConnect?.().getChildren?.() ?? [];
|
|
130
|
-
tabChildren.forEach((tabComp, index) => {
|
|
131
|
-
const config = tabComp.getPConnect?.().getConfigProps?.() ?? tabComp.getPConnect?.().getRawMetadata?.()?.config ?? {};
|
|
132
|
-
let label = config.label || '';
|
|
133
|
-
if (!label && config.inheritedProps) config.inheritedProps.forEach(ip => { if (ip.prop === 'label') label = ip.value; });
|
|
134
|
-
if (config.visibility === undefined || config.visibility === true) {
|
|
135
|
-
vertTabInfo.push({ name: label || `Tab ${index + 1}`, id: index });
|
|
136
|
-
deferLoadInfo.push({ type: 'DeferLoad', config });
|
|
137
|
-
}
|
|
138
|
-
});
|
|
139
|
-
|
|
140
|
-
const [activeVertTab, setActiveVertTab] = useState(0);
|
|
141
|
-
// editAction is data-driven — comes from the availableActions array in the network response.
|
|
142
|
-
// The ID 'pyUpdateCaseDetails' is a common Pega convention but may differ per case type.
|
|
143
|
-
// If this action exists, render a shortcut button in the header; label is localized.
|
|
144
|
-
const editAction = availableActions.find(a => a.ID === 'pyUpdateCaseDetails');
|
|
145
|
-
|
|
146
|
-
// 5. useEffect: VerticalTabClick event listener (DOM event, not PubSub)
|
|
147
|
-
useEffect(() => {
|
|
148
|
-
const handler = (event) => { const idx = parseInt(event?.detail?.additionalData?.itemClicked ?? event, 10); if (!isNaN(idx)) setActiveVertTab(idx); };
|
|
149
|
-
document.addEventListener('VerticalTabClick', handler);
|
|
150
|
-
return () => document.removeEventListener('VerticalTabClick', handler);
|
|
151
|
-
}, []);
|
|
152
|
-
// 6. useEffect: publish CASE_ATTACHMENTS_UPDATED on hasNewAttachments
|
|
153
|
-
useEffect(() => { if (hasNewAttachments) PCore.getPubSubUtils().publish((PCore.getEvents().getCaseEvent()).CASE_ATTACHMENTS_UPDATED_FROM_CASEVIEW, true); }, [hasNewAttachments]);
|
|
154
|
-
|
|
155
|
-
// 7. Edit action click handler
|
|
156
|
-
function _editClick() {
|
|
157
|
-
const actionsAPI = thePConn.getActionsApi();
|
|
158
|
-
actionsAPI.openLocalAction(editAction.ID, {
|
|
159
|
-
...editAction, containerName: 'modal', type: 'express',
|
|
160
|
-
});
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
// 8. Render
|
|
164
|
-
// ⚠️ CRITICAL — USE THE PROJECT'S DESIGN SYSTEM for buttons and header card.
|
|
165
|
-
// Check `package.json` for the installed DS and use its button component (ghost/text variant).
|
|
166
|
-
// NEVER use plain HTML <button> — always use the DS button.
|
|
167
|
-
// Localize labels: PCore.getLocaleUtils().getLocaleValue('Edit', 'CaseView')
|
|
168
|
-
//
|
|
169
|
-
// Examples of known design systems (check package.json for actual installed DS):
|
|
170
|
-
// | DS | Action Button | Header Background |
|
|
171
|
-
// |---|---|---|
|
|
172
|
-
// | @carbon/react | <Button kind="ghost" size="sm"> | use $blue-10 token or #e3f2fd |
|
|
173
|
-
// | @mui/material | <Button variant="text"> | theme.palette.info.light |
|
|
174
|
-
// | antd | <Button type="link"> | token blue-1 |
|
|
175
|
-
// | CSS-only | <button> with styled class | #e3f2fd |
|
|
176
|
-
if (displayOnlyFA) {
|
|
177
|
-
return <div>{theTodoRegion}</div>;
|
|
178
|
-
}
|
|
179
|
-
const localizedVal = PCore.getLocaleUtils().getLocaleValue;
|
|
180
|
-
return (
|
|
181
|
-
<div className='psdk-case-view'>
|
|
182
|
-
<aside>
|
|
183
|
-
<div hidden id='current-caseID'>{currentCaseID}</div>
|
|
184
|
-
{/* Case header card — themed background, DS buttons, localized labels */}
|
|
185
|
-
<div className='psdk-case-view-header'>
|
|
186
|
-
<div className='psdk-case-view-header-content'>
|
|
187
|
-
<h2 className='psdk-case-view-header-title'>{header}</h2>
|
|
188
|
-
{subheader && <span className='psdk-case-view-header-id'>{subheader}</span>}
|
|
189
|
-
</div>
|
|
190
|
-
<div className='psdk-case-view-header-actions'>
|
|
191
|
-
{/* Action buttons are DATA-DRIVEN from availableActions (network response).
|
|
192
|
-
The edit shortcut uses a known Pega action ID but could be any action.
|
|
193
|
-
Labels MUST be localized — never hardcode button text. */}
|
|
194
|
-
{editAction && (
|
|
195
|
-
<DSButton variant='ghost' onClick={_editClick}>{localizedVal('Edit', 'CaseView')}</DSButton>
|
|
196
|
-
)}
|
|
197
|
-
{/* CaseViewActionsMenu renders ALL available actions + processes as dropdown items */}
|
|
198
|
-
{CaseViewActionsMenu && (
|
|
199
|
-
<CaseViewActionsMenu
|
|
200
|
-
getPConnect={getPConnect}
|
|
201
|
-
availableActions={availableActions}
|
|
202
|
-
availableProcesses={availableProcesses}
|
|
203
|
-
caseTypeID={caseTypeID}
|
|
204
|
-
caseTypeName={caseTypeName}
|
|
205
|
-
/>
|
|
206
|
-
)}
|
|
207
|
-
</div>
|
|
208
|
-
</div>
|
|
209
|
-
{theSummaryRegion}
|
|
210
|
-
{vertTabInfo.length > 1 && <VerticalTabs tabconfig={vertTabInfo} />}
|
|
211
|
-
</aside>
|
|
212
|
-
<main>
|
|
213
|
-
{/* ⚠️ STAGES MUST be in the CENTER column, above ToDo — NOT in the sidebar */}
|
|
214
|
-
{theStagesRegion}
|
|
215
|
-
{theTodoRegion}
|
|
216
|
-
{deferLoadInfo.length > 0 && deferLoadInfo[activeVertTab] && <DeferLoad getPConnect={getPConnect}
|
|
217
|
-
name={deferLoadInfo[activeVertTab].config.name} isTab
|
|
218
|
-
lastUpdateCaseTime={lastUpdateCaseTime} />}
|
|
219
|
-
</main>
|
|
220
|
-
<aside>{theUtilitiesRegion}</aside>
|
|
221
|
-
</div>
|
|
222
|
-
);
|
|
223
|
-
}
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
> **Note:** `ObjectPage` is a re-export: `export { default } from '../CaseView'`. Register both keys to the same component.
|
|
52
|
+
- **Extends:** the project's base component interface
|
|
53
|
+
|
|
54
|
+
## Inputs
|
|
55
|
+
|
|
56
|
+
| Input | Type | Required | Description |
|
|
57
|
+
| -------------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------- |
|
|
58
|
+
| `children` | renderable content | Yes | Named region children (summary, stages, todo, utilities, tabs) |
|
|
59
|
+
| `displayOnlyFA` | `boolean` | No | If true, renders only the to-do region (focused action mode) |
|
|
60
|
+
| `getPConnect` | `function` | Yes | PConnect getter |
|
|
61
|
+
| `icon` | `string` | No | Icon identifier for case type |
|
|
62
|
+
| `subheader` | `string` | No | Case ID displayed below the header |
|
|
63
|
+
| `header` | `string` | Yes | Case name/title |
|
|
64
|
+
| `showIconInHeader` | `boolean` | No | Whether to show the case type icon in the header card |
|
|
65
|
+
| `caseInfo` | `object` | Yes | Case metadata (availableActions, availableProcesses, hasNewAttachments, caseTypeID, caseTypeName, caseTypeIcon, ID) |
|
|
66
|
+
| `lastUpdateCaseTime` | `any` | No | Last case update timestamp; defaults to `getPConnect().getValue('caseInfo.lastUpdateTime')` |
|
|
67
|
+
|
|
68
|
+
## Implementation Structure
|
|
69
|
+
|
|
70
|
+
**Module Setup:** Obtain the project's base component interface for typing. Obtain the project's component registry for resolving child components at runtime. Obtain the application store context for reading `displayOnlyFA`. Obtain a static-content URL utility for resolving icon paths.
|
|
71
|
+
|
|
72
|
+
**Main Component Logic** — steps in order:
|
|
73
|
+
|
|
74
|
+
1. Retrieve `CaseViewActionsMenu`, `VerticalTabs`, and `DeferLoad` from the project's component registry.
|
|
75
|
+
2. Receive inputs: extract `getPConnect`, `icon` (default `''`), `header`, `subheader`, `children` (default `[]`), and the nested `caseInfo` fields `availableActions` (default `[]`), `availableProcesses` (default `[]`), `hasNewAttachments`, `caseTypeID` (default `''`), `caseTypeName` (default `''`), and `caseTypeIcon`. Default `lastUpdateCaseTime` to `getPConnect().getValue('caseInfo.lastUpdateTime')` when not supplied. Read `currentCaseID` from `caseInfo.ID`; read `displayOnlyFA` from the application store context; call `getPConnect()` once into `thePConn`.
|
|
76
|
+
3. **Extract named regions using SDK utilities:** Obtain `getChildRegionByName`, `extractTabsInfo`, and `openCaseEditAction` from `PCore.getSDKUtils().getSDKCaseUtils()`. Normalize `children` into an array (`childArr`). Use `getChildRegionByName(childArr, 'summary')` etc. to extract `theSummaryRegion`, `theStagesRegion`, `theTodoRegion`, `theUtilitiesRegion`, and `theTabsRegion`. **Do NOT implement a custom `getChildRegionByName` helper** — the SDK utility handles the internal child format correctly (children passed to page templates are rendered elements that do not expose `.getPConnect()` as a direct method).
|
|
77
|
+
4. **Build tab info using SDK utility:** Call `extractTabsInfo(theTabsRegion)` to get `{ vertTabInfo, deferLoadInfo }`. Destructure with defaults: `const { vertTabInfo = [], deferLoadInfo = [] } = extractTabsInfo(theTabsRegion) ?? {}`. `vertTabInfo` is a plain array of `{ name: string; id: number }` objects (display labels for `VerticalTabs`). `deferLoadInfo` is a separate array of `{ type: 'DeferLoad', config }` objects (the full config for each tab). `DeferLoad`'s `name` input must always come from `deferLoadInfo[activeTab].config.name` (e.g., `"pyDetailsTabContent"`) — never the display label. **Do NOT manually iterate tab children to build these arrays** — the SDK utility handles the extraction correctly.
|
|
78
|
+
5. Declare local state `activeVertTab` (number, default `0`). Determine `editAction` by finding the entry in `availableActions` whose `ID === 'pyUpdateCaseDetails'` — this action is data-driven from the network response; the ID is a common Pega convention but may differ per case type, and its label must always be localized rather than hardcoded.
|
|
79
|
+
6. **`VerticalTabClick` listener:** in a lifecycle effect that runs once on initialization, add a `document` listener for the custom `VerticalTabClick` DOM event (not PubSub) that parses `event?.detail?.additionalData?.itemClicked` (or the event itself) as an integer and updates `activeVertTab` when valid; remove the listener on teardown. Track a mounted flag to avoid updating local state after teardown.
|
|
80
|
+
7. **Attachment updates:** in a lifecycle effect keyed on `hasNewAttachments`, when it's true, publish `PCore.getPubSubUtils().publish(PCore.getEvents().getCaseEvent().CASE_ATTACHMENTS_UPDATED_FROM_CASEVIEW, true)`.
|
|
81
|
+
8. Define `_editClick()`: call `openCaseEditAction(thePConn, editAction)` — this SDK utility handles the local action invocation correctly.
|
|
82
|
+
9. **Render:** when `displayOnlyFA` is true, render only a wrapping container holding `theTodoRegion` directly (NOT through the PConnect bridge component) and stop there. Otherwise, bind `localizedVal = PCore.getLocaleUtils().getLocaleValue` and render a `psdk-case-view` container with three sections. **Regions returned by `getChildRegionByName` are rendered directly in the template** — do NOT pass them through the PConnect bridge component because they are already renderable elements:
|
|
83
|
+
- **Sidebar (column width 3/12):** a hidden element holding `currentCaseID`; a case header card (`psdk-case-view-header`) with a themed background, containing the title (`header`) and subheader/case-ID (`subheader`, when present) in a `psdk-case-view-header-content` block, followed by a `psdk-case-view-header-actions` block holding: an Edit button (rendered with the project's installed design system button component, NOT a plain button element, labeled via `localizedVal('Edit', 'CaseView')`, shown only when `editAction` exists, wired to `_editClick`); and the `CaseViewActionsMenu` (passed `getPConnect`, `availableActions`, `availableProcesses`, `caseTypeID`, `caseTypeName`) rendered inside this header card, not standalone. After the header card, render `theSummaryRegion`, then `VerticalTabs` (with `tabconfig` set to `vertTabInfo`) when there's more than one tab.
|
|
84
|
+
- **Main (column width 6/12):** `theStagesRegion` MUST appear here in the center column (never in the sidebar), followed by `theTodoRegion`, followed by `DeferLoad` (passed `getPConnect`, `name` set to `deferLoadInfo[activeVertTab].config.name`, `isTab`, `lastUpdateCaseTime`) when `deferLoadInfo` has an entry for the active tab.
|
|
85
|
+
- **Utilities (column width 3/12):** `theUtilitiesRegion`.
|
|
86
|
+
|
|
87
|
+
For the Edit button and header card styling, use the project's installed design system: e.g. a ghost/small button for a Carbon-based system, a text-variant button for a Material-based system, a link-type button for an Ant-based system, or a styled plain button when CSS-only; the header background should use a matching light accent token or color for each.
|
|
88
|
+
|
|
89
|
+
> **Note:** `ObjectPage` is a re-export: its module simply re-exports CaseView's default export. Register both keys to the same component.
|
|
227
90
|
|
|
228
91
|
## Behavioral Contract
|
|
229
92
|
|
|
230
93
|
### Region Extraction
|
|
231
94
|
|
|
232
|
-
Use `
|
|
95
|
+
> ⚠️ **CRITICAL:** Use `PCore.getSDKUtils().getSDKCaseUtils().getChildRegionByName(childArr, name)` to extract regions. Do NOT implement a custom helper that calls `child.getPConnect()` — children passed to page templates are rendered elements and do not expose `getPConnect` as a direct method. The SDK utility handles the internal format correctly.
|
|
96
|
+
|
|
97
|
+
Extract the following named regions:
|
|
233
98
|
|
|
234
|
-
- **Summary region:** `
|
|
235
|
-
- **Stages region:** `
|
|
236
|
-
- **ToDo region:** `
|
|
237
|
-
- **Utilities region:** `
|
|
238
|
-
- **Tabs region:** `
|
|
99
|
+
- **Summary region:** `getChildRegionByName(childArr, 'summary')`
|
|
100
|
+
- **Stages region:** `getChildRegionByName(childArr, 'stages')`
|
|
101
|
+
- **ToDo region:** `getChildRegionByName(childArr, 'todo')`
|
|
102
|
+
- **Utilities region:** `getChildRegionByName(childArr, 'utilities')`
|
|
103
|
+
- **Tabs region:** `getChildRegionByName(childArr, 'tabs')`
|
|
239
104
|
|
|
240
|
-
Render each region
|
|
105
|
+
Render each extracted region directly in the template — they are already renderable elements.
|
|
241
106
|
|
|
242
107
|
### Tabs Region — Deferred Load
|
|
243
108
|
|
|
244
|
-
-
|
|
245
|
-
-
|
|
246
|
-
-
|
|
109
|
+
- Call `extractTabsInfo(theTabsRegion)` from `PCore.getSDKUtils().getSDKCaseUtils()` to build `vertTabInfo` (vertical tab definitions) and `deferLoadInfo` (deferred loading metadata).
|
|
110
|
+
- Do NOT manually iterate tab children — the SDK utility handles this correctly.
|
|
111
|
+
- Pass `vertTabInfo` to `VerticalTabs` component as its `tabconfig` prop.
|
|
112
|
+
- Pass `deferLoadInfo[activeVertTab].config.name` to `DeferLoad` as its `name` prop.
|
|
247
113
|
|
|
248
114
|
### displayOnlyFA Mode
|
|
249
115
|
|
|
@@ -271,20 +137,13 @@ If `displayOnlyFA === true`:
|
|
|
271
137
|
> The sidebar contains: case header card → summary → vertical tabs.
|
|
272
138
|
> The center contains: stages → todo → deferred tab content.
|
|
273
139
|
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
| Column | xs | Contents |
|
|
284
|
-
| ------ | --- | ----------------------------------------------------------- |
|
|
285
|
-
| Left | 3 | Case header card, Summary, VerticalTabs |
|
|
286
|
-
| Center | 6 | **Stages**, ToDo/assignment, DeferLoad (active tab content) |
|
|
287
|
-
| Right | 3 | Utilities region (attachments, etc.) |
|
|
140
|
+
Three columns share the row: a 3/12-width sidebar column holding the case header card (title + ID), the Edit and Actions buttons, the summary region, and the vertical tabs; a 6/12-width main column holding the stages region, the to-do/assignment region, and the deferred tab content; and a 3/12-width utilities column holding the utilities region (attachments, etc.).
|
|
141
|
+
|
|
142
|
+
| Column | Width | Contents |
|
|
143
|
+
| ------ | ----- | ----------------------------------------------------------- |
|
|
144
|
+
| Left | 3/12 | Case header card, Summary, VerticalTabs |
|
|
145
|
+
| Center | 6/12 | **Stages**, ToDo/assignment, DeferLoad (active tab content) |
|
|
146
|
+
| Right | 3/12 | Utilities region (attachments, etc.) |
|
|
288
147
|
|
|
289
148
|
**CSS-only implementation notes:**
|
|
290
149
|
|
|
@@ -293,62 +152,7 @@ If `displayOnlyFA === true`:
|
|
|
293
152
|
- Center column: `overflow: hidden`.
|
|
294
153
|
- Responsive: on mobile (`max-width: 672px`), stack to single column.
|
|
295
154
|
|
|
296
|
-
**Case header card CSS (MUST be included in `
|
|
297
|
-
|
|
298
|
-
```css
|
|
299
|
-
.psdk-case-view {
|
|
300
|
-
display: grid;
|
|
301
|
-
grid-template-columns: minmax(0, 3fr) minmax(0, 6fr) minmax(0, 3fr);
|
|
302
|
-
gap: 1rem;
|
|
303
|
-
width: 100%;
|
|
304
|
-
}
|
|
305
|
-
.psdk-case-view aside,
|
|
306
|
-
.psdk-case-view main {
|
|
307
|
-
min-width: 0;
|
|
308
|
-
}
|
|
309
|
-
@media (max-width: 672px) {
|
|
310
|
-
.psdk-case-view {
|
|
311
|
-
grid-template-columns: 1fr;
|
|
312
|
-
}
|
|
313
|
-
}
|
|
314
|
-
.psdk-case-view-header {
|
|
315
|
-
background-color: #e3f2fd;
|
|
316
|
-
border-radius: 4px;
|
|
317
|
-
padding: 1rem;
|
|
318
|
-
margin-bottom: 1rem;
|
|
319
|
-
}
|
|
320
|
-
.psdk-case-view-header-content {
|
|
321
|
-
margin-bottom: 0.5rem;
|
|
322
|
-
}
|
|
323
|
-
.psdk-case-view-header-title {
|
|
324
|
-
margin: 0;
|
|
325
|
-
font-size: 1.25rem;
|
|
326
|
-
font-weight: 500;
|
|
327
|
-
color: #1565c0;
|
|
328
|
-
}
|
|
329
|
-
.psdk-case-view-header-id {
|
|
330
|
-
font-size: 0.875rem;
|
|
331
|
-
color: #555;
|
|
332
|
-
}
|
|
333
|
-
.psdk-case-view-header-actions {
|
|
334
|
-
display: flex;
|
|
335
|
-
gap: 0.5rem;
|
|
336
|
-
align-items: center;
|
|
337
|
-
}
|
|
338
|
-
.psdk-case-view-edit-btn {
|
|
339
|
-
background: none;
|
|
340
|
-
border: none;
|
|
341
|
-
color: #1976d2;
|
|
342
|
-
font-size: 0.875rem;
|
|
343
|
-
font-weight: 500;
|
|
344
|
-
cursor: pointer;
|
|
345
|
-
text-transform: uppercase;
|
|
346
|
-
padding: 0.25rem 0.5rem;
|
|
347
|
-
}
|
|
348
|
-
.psdk-case-view-edit-btn:hover {
|
|
349
|
-
background-color: rgba(25, 118, 210, 0.04);
|
|
350
|
-
}
|
|
351
|
-
```
|
|
155
|
+
**Case header card CSS (MUST be included in companion styles):** the `.psdk-case-view` container is a CSS grid with columns `minmax(0, 3fr) minmax(0, 6fr) minmax(0, 3fr)`, a `1rem` gap, and full width; its direct children get `min-width: 0`; at `max-width: 672px` it collapses to a single column. The `.psdk-case-view-header` card has a light blue background (`#e3f2fd`), `4px` border radius, `1rem` padding, and `1rem` bottom margin; `.psdk-case-view-header-content` has `0.5rem` bottom margin; `.psdk-case-view-header-title` has no margin, `1.25rem` font size, medium weight, and a blue accent color (`#1565c0`); `.psdk-case-view-header-id` is smaller (`0.875rem`) and gray (`#555`); `.psdk-case-view-header-actions` is a flex row with `0.5rem` gap and centered items; `.psdk-case-view-edit-btn` is an unstyled, borderless, uppercase text button in blue (`#1976d2`, `0.875rem`, medium weight) with a subtle hover background (`rgba(25, 118, 210, 0.04)`).
|
|
352
156
|
|
|
353
157
|
## Edge Cases & Special Logic
|
|
354
158
|
|
|
@@ -359,40 +163,33 @@ If `displayOnlyFA === true`:
|
|
|
359
163
|
|
|
360
164
|
## Dependencies
|
|
361
165
|
|
|
362
|
-
- `DeferLoad` component from
|
|
166
|
+
- `DeferLoad` component — resolved from the project's component registry; handles deferred tab content loading
|
|
363
167
|
- `PCore.getPubSubUtils()` — pub/sub for attachment updates
|
|
364
|
-
-
|
|
365
|
-
- `CASE_ATTACHMENTS_UPDATED` constant from
|
|
168
|
+
- The project's PConnect bridge utility — for rendering region children
|
|
169
|
+
- `CASE_ATTACHMENTS_UPDATED` constant from PCore events API
|
|
366
170
|
|
|
367
171
|
## Sub-Variants
|
|
368
172
|
|
|
369
173
|
### ObjectPage
|
|
370
174
|
|
|
371
|
-
`ObjectPage` is registered as
|
|
372
|
-
|
|
373
|
-
```tsx
|
|
374
|
-
// packages/sdk-react/src/components/template/ObjectPage/index.tsx
|
|
375
|
-
export { default } from '../CaseView';
|
|
376
|
-
```
|
|
175
|
+
`ObjectPage` is registered as a direct re-export module whose default export simply re-exports `CaseView`'s default export.
|
|
377
176
|
|
|
378
177
|
- No separate implementation needed.
|
|
379
|
-
- In
|
|
178
|
+
- In the project's component map, register `ObjectPage` key pointing to the same component as `CaseView`.
|
|
380
179
|
|
|
381
180
|
## Design System Mapping
|
|
382
181
|
|
|
383
182
|
**UI control type:** Full case workspace layout — 3-column grid with sidebar, main content, and utilities.
|
|
384
183
|
|
|
385
|
-
|
|
184
|
+
When implementing in a specific design system, map the following:
|
|
386
185
|
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
| Chakra UI | `<Grid templateColumns='1fr 2fr 1fr'>` | `<Box>` | Custom lazy tabs |
|
|
393
|
-
| Shadcn/ui | Tailwind `grid grid-cols-[1fr_2fr_1fr]` | `<aside>` | Custom |
|
|
186
|
+
- **Grid layout:** Use the design system's grid component with a 3/6/3 column ratio. For CSS-only, use CSS Grid with `grid-template-columns: minmax(0, 3fr) minmax(0, 6fr) minmax(0, 3fr)`.
|
|
187
|
+
- **Sidebar container:** Use the design system's card or panel component to wrap the case header, summary, and vertical tabs.
|
|
188
|
+
- **Deferred tabs:** Use the design system's tab component for the vertical tab list, paired with the DeferLoad component for lazy content rendering. The VerticalTabs component handles its own rendering — just pass `tabconfig` as the array of `{ name, id }` objects.
|
|
189
|
+
- **Case header card:** A card with a light accent background, containing the case title, case ID, and action buttons.
|
|
190
|
+
- **Action buttons:** Use the design system's button component (text/ghost variant for Edit, menu component for CaseViewActionsMenu).
|
|
394
191
|
|
|
395
|
-
|
|
192
|
+
Regardless of design system:
|
|
396
193
|
|
|
397
194
|
- `displayOnlyFA` must completely bypass the grid — render only ToDo region
|
|
398
195
|
- Region extraction by metadata name is required — do not assume positional ordering
|