@pega/dx-component-builder-sdk 0.25.5 → 0.25.7

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-form/pega-dxil-my-form.component.ts

@@ -1,14 +1,26 @@
 import { Component, OnInit, Input, forwardRef } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { FormGroup } from '@angular/forms';
+import { AngularPConnectData, AngularPConnectService } from '@pega/angular-sdk-components';
 import { ReferenceComponent } from '@pega/angular-sdk-components';
 import { ComponentMapperComponent } from '@pega/angular-sdk-components';
 import { TemplateUtils } from '@pega/angular-sdk-components';
+import { FormTemplateBase } from '@pega/angular-sdk-components';
+
+function areViewsChanged(oldViews: any[], newViews: any[]): boolean {
+  if (oldViews?.length !== newViews?.length) {
+    return true;
+  }
+
+  return !oldViews?.every((oldView, index) => {
+    const newView = newViews[index];
+    return oldView.getPConnect().viewName === newView.getPConnect().viewName;
+  });
+}
 
 interface PegaDxilMyFormProps {
   // If any, enter additional props that only exist on this component
   NumCols: string;
-  template: string;
   instructions: string;
 }
 
@@ -19,37 +31,38 @@ interface PegaDxilMyFormProps {
   standalone: true,
   imports: [CommonModule, forwardRef(() => ComponentMapperComponent)]
 })
-export class PegaDxilMyFormComponent implements OnInit {
-  @Input() pConn$: typeof PConnect;
+export class PegaDxilMyFormComponent extends FormTemplateBase implements OnInit {
+  @Input() override pConn$: typeof PConnect;
   @Input() formGroup$: FormGroup;
 
+  // Used with AngularPConnect
+  override angularPConnectData: AngularPConnectData = {};
+
   arChildren$: any[];
   divClass$: string;
-  template: any;
-  showLabel: any;
-  label: any;
   instructions: string;
 
-  NO_HEADER_TEMPLATES = [
-    'SubTabs',
-    'SimpleTable',
-    'Details',
-    'DetailsTwoColumn',
-    'DetailsThreeColumn',
-    'NarrowWideDetails',
-    'WideNarrowDetails',
-    'Confirmation'
-  ];
-
-  constructor(private templateUtils: TemplateUtils) {}
+  constructor(
+    private angularPConnect: AngularPConnectService,
+    private templateUtils: TemplateUtils
+  ) {
+    super();
+  }
 
   ngOnInit(): void {
+    // First thing in initialization is registering and subscribing to the AngularPConnect service
+    this.angularPConnectData = this.angularPConnect.registerAndSubscribeComponent(this, this.onStateChange);
+
+    this.updateSelf();
+  }
+
+  onStateChange() {
+    this.updateSelf();
+  }
+
+  updateSelf() {
     const configProps = this.pConn$.getConfigProps() as PegaDxilMyFormProps;
-    this.template = configProps?.template;
-    const propToUse: any = { ...this.pConn$.getInheritedProps() };
-    this.showLabel = propToUse?.showLabel;
-    this.label = propToUse?.label;
-    const kids = this.pConn$.getChildren() as any[];
+    const kids = this.pConn$.getChildren();
     this.instructions = this.templateUtils.getInstructions(this.pConn$, configProps?.instructions);
 
     const numCols = configProps.NumCols ? configProps.NumCols : '1';
@@ -71,6 +84,10 @@ export class PegaDxilMyFormComponent implements OnInit {
     // repoint children before getting templateArray
     // Children may contain 'reference' component, so we need to
     //  normalize them
-    this.arChildren$ = ReferenceComponent.normalizePConnArray(kids[0].getPConnect().getChildren());
+    const children = ReferenceComponent.normalizePConnArray(kids[0].getPConnect().getChildren());
+
+    if (areViewsChanged(this.arChildren$, children)) {
+      this.arChildren$ = children;
+    }
   }
 }

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-page/demo.stories.tsx

@@ -7,39 +7,40 @@ const meta: Meta<PegaDxilMyPageComponent> = {
   title: 'PegaDxilMyPage',
   component: PegaDxilMyPageComponent,
   excludeStories: /.*Data$/,
-  render: (args: PegaDxilMyPageComponent) => ({
+  render: (args) => ({
     props: {
       ...args,
       pConn$: {
-      getChildren: () => {
-        return [
-          {
-            getPConnect: () => {
-              return {
-                getComponentName: () => {
-                  return 'Region';
-                },
-                getChildren: () => {
-                  return children;
-                }
-              };
+        getChildren: () => {
+          return [
+            {
+              getPConnect: () => {
+                return {
+                  getComponentName: () => {
+                    return 'Region';
+                  },
+                  getChildren: () => {
+                    return children;
+                  }
+                };
+              }
             }
-          }
-        ];
-      },
-      getConfigProps: () => {
-        return {
-          title: 'Annoucements',
-          operator: ''
-        };
-      },
-      resolveConfigProps: () => {
-        return {
-          title: 'Annoucements',
-          operator: ''
-        };
-      }
-    } as any
+          ];
+        },
+        getConfigProps: () => {
+          return {
+            title: 'Announcements',
+            operator: ''
+          };
+        },
+        resolveConfigProps: () => {
+          return {
+            title: 'Announcements',
+            operator: ''
+          };
+        },
+        getContextName: () => ''
+      } as any
     }
   })
 };

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-page/pega-dxil-my-page.component.spec.ts

@@ -8,9 +8,8 @@ describe('PegaDxilMyPageComponent', () => {
 
   beforeEach(waitForAsync(() => {
     TestBed.configureTestingModule({
-      declarations: [ PegaDxilMyPageComponent ]
-    })
-    .compileComponents();
+      declarations: [PegaDxilMyPageComponent]
+    }).compileComponents();
   }));
 
   beforeEach(() => {

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-page/pega-dxil-my-page.component.ts

@@ -34,7 +34,7 @@ export class PegaDxilMyPageComponent implements OnInit, OnDestroy {
     this.angularPConnectData = this.angularPConnect.registerAndSubscribeComponent(this, this.onStateChange);
 
     this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as PegaDxilMyPageProps;
-    this.arChildren$ = this.pConn$.getChildren() as any[];
+    this.arChildren$ = this.pConn$.getChildren();
 
     this.title$ = this.configProps$.title;
     const operator = this.configProps$.operator;

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-two-column-details/demo.stories.tsx

@@ -8,35 +8,36 @@ const meta: Meta<PegaDxilMyTwoColumnDetailsComponent> = {
   title: 'PegaDxilMyTwoColumnDetails',
   component: PegaDxilMyTwoColumnDetailsComponent,
   excludeStories: /.*Data$/,
-  render: (args: PegaDxilMyTwoColumnDetailsComponent) => ({
+  render: (args) => ({
     props: {
       ...args,
       pConn$: {
-      resolveConfigProps: (props) => props,
-      getRawMetadata: () => {
-        return pyReviewRaw.config;
-      },
-      getChildren: () => {
-        return pyReviewRaw.children;
-      },
-      isEditable: () => true,
-      setAction: () => {},
-      getActions: () => {
-        return {
-          onChange: () => {},
-          onBlur: () => {}
-        };
-      },
-      populateAdditionalProps: () => {
-        /* nothing */
-      },
-      getConfigProps: () => {
-        /* nothing */
-      },
-      setInheritedProp: () => {
-        /* nothing */
-      }
-    } as any
+        resolveConfigProps: props => props,
+        getRawMetadata: () => {
+          return pyReviewRaw.config;
+        },
+        getChildren: () => {
+          return pyReviewRaw.children;
+        },
+        isEditable: () => true,
+        setAction: () => {},
+        getActions: () => {
+          return {
+            onChange: () => {},
+            onBlur: () => {}
+          };
+        },
+        populateAdditionalProps: () => {
+          /* nothing */
+        },
+        getConfigProps: () => {
+          /* nothing */
+        },
+        setInheritedProp: () => {
+          /* nothing */
+        },
+        getContextName: () => ''
+      } as any
     }
   })
 };

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-two-column-details/mock.ts

@@ -1,60 +1,60 @@
 /* eslint-disable no-useless-return */
 export const pyReviewRaw = {
-  name: "pyReview",
-  type: "View",
+  name: 'pyReview',
+  type: 'View',
   config: {
-    template: "Details",
-    ruleClass: "MyCo-MyCompon-Work-MyComponents",
+    template: 'Details',
+    ruleClass: 'MyCo-MyCompon-Work-MyComponents',
     showLabel: true,
-    label: "@L Details",
-    localeReference: "@LR MYCO-MYCOMPON-WORK-MYCOMPONENTS!VIEW!PYREVIEW",
+    label: '@L Details',
+    localeReference: '@LR MYCO-MYCOMPON-WORK-MYCOMPONENTS!VIEW!PYREVIEW',
     showHighlightedData: true,
     highlightedData: [
       {
-        type: "TextInput",
+        type: 'TextInput',
         config: {
-          value: "@P .pyStatusWork",
-          label: "@L Work Status",
-          displayMode: "STACKED_LARGE_VAL",
-          displayAsStatus: true,
-        },
+          value: '@P .pyStatusWork',
+          label: '@L Work Status',
+          displayMode: 'STACKED_LARGE_VAL',
+          displayAsStatus: true
+        }
       },
       {
-        type: "TextInput",
+        type: 'TextInput',
         config: {
-          value: "@P .pyID",
-          label: "@L Case ID",
-          displayMode: "STACKED_LARGE_VAL",
-        },
+          value: '@P .pyID',
+          label: '@L Case ID',
+          displayMode: 'STACKED_LARGE_VAL'
+        }
       },
       {
-        type: "DateTime",
+        type: 'DateTime',
         config: {
-          value: "@P .pxCreateDateTime",
-          label: "@L Create date/time",
-          displayMode: "STACKED_LARGE_VAL",
-        },
+          value: '@P .pxCreateDateTime',
+          label: '@L Create date/time',
+          displayMode: 'STACKED_LARGE_VAL'
+        }
       },
       {
-        type: "UserReference",
+        type: 'UserReference',
         config: {
-          label: "@L Create Operator",
-          value: "@USER .pxCreateOperator",
-          placeholder: "Select...",
-          displayMode: "STACKED_LARGE_VAL",
-        },
-      },
+          label: '@L Create Operator',
+          value: '@USER .pxCreateOperator',
+          placeholder: 'Select...',
+          displayMode: 'STACKED_LARGE_VAL'
+        }
+      }
     ],
     inheritedProps: [
       {
-        prop: "label",
-        value: "@L Details",
+        prop: 'label',
+        value: '@L Details'
       },
       {
-        prop: "showLabel",
-        value: true,
-      },
-    ],
+        prop: 'showLabel',
+        value: true
+      }
+    ]
   },
   children: [
     {
@@ -62,41 +62,40 @@ export const pyReviewRaw = {
         return {
           resolveConfigProps: () => {
             return {
-              name: "A",
-              type: "Region",
+              name: 'A',
+              type: 'Region',
               children: [
                 {
-                  config: {value: 'John', label: 'First Name'},
-                  type: "TextInput"
+                  config: { value: 'John', label: 'First Name' },
+                  type: 'TextInput'
                 },
                 {
-                  config: {value: 'Doe', label: 'Last Name'},
-                  type: "TextInput"
+                  config: { value: 'Doe', label: 'Last Name' },
+                  type: 'TextInput'
                 },
                 {
-                  config: {value: '+16397975093', label: 'Phone'},
-                  type: "Phone"
+                  config: { value: '+16397975093', label: 'Phone' },
+                  type: 'Phone'
                 },
                 {
-                  config: {value: '100 Mbps', label: 'Internet Plan'},
-                  type: "TextInput"
+                  config: { value: '100 Mbps', label: 'Internet Plan' },
+                  type: 'TextInput'
                 },
                 {
-                  config: {value: 'Texas', label: 'State'},
-                  type: "TextInput"
+                  config: { value: 'Texas', label: 'State' },
+                  type: 'TextInput'
                 },
                 {
-                  config: {value: '', label: 'City'},
-                  type: "TextInput"
+                  config: { value: '', label: 'City' },
+                  type: 'TextInput'
                 }
               ]
-            }
-
+            };
           },
           getRawMetadata: () => {
             return {};
           }
-        }
+        };
       }
     },
     {
@@ -104,38 +103,37 @@ export const pyReviewRaw = {
         return {
           resolveConfigProps: () => {
             return {
-              name: "B",
-              type: "Region",
+              name: 'B',
+              type: 'Region',
               children: [
                 {
-                  config: {value: '', label: 'Middle Name'},
-                  type: "TextInput"
+                  config: { value: '', label: 'Middle Name' },
+                  type: 'TextInput'
                 },
                 {
-                  config: {value: 'john@doe.com', label: 'Email'},
-                  type: "Email"
+                  config: { value: 'john@doe.com', label: 'Email' },
+                  type: 'Email'
                 },
                 {
-                  config: {value: '$90.99', label: 'Price'},
-                  type: "TextInput"
+                  config: { value: '$90.99', label: 'Price' },
+                  type: 'TextInput'
                 },
                 {
-                  config: {value: false, label: 'Internet Package'},
-                  type: "Checkbox"
+                  config: { value: false, label: 'Internet Package' },
+                  type: 'Checkbox'
                 },
                 {
-                  config: {value: '2023-12-29', label: 'Service date'},
-                  type: "Date"
+                  config: { value: '2023-12-29', label: 'Service date' },
+                  type: 'Date'
                 }
               ]
-            }
-
+            };
           },
           getRawMetadata: () => {
             return {};
           }
-        }
+        };
       }
     }
-  ],
-}
+  ]
+};

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-two-column-details/pega-dxil-my-two-column-details.component.spec.ts

@@ -8,9 +8,8 @@ describe('PegaDxilMyTwoColumnDetailsComponent', () => {
 
   beforeEach(waitForAsync(() => {
     TestBed.configureTestingModule({
-      declarations: [ PegaDxilMyTwoColumnDetailsComponent ]
-    })
-    .compileComponents();
+      declarations: [PegaDxilMyTwoColumnDetailsComponent]
+    }).compileComponents();
   }));
 
   beforeEach(() => {

package/tests/assets/sdk-a/components/createAll/custom-sdk/template/pega-dxil-my-two-column-details/pega-dxil-my-two-column-details.component.ts

@@ -1,6 +1,5 @@
-import { Component, OnInit, Input, forwardRef, OnDestroy } from '@angular/core';
-import { FormGroup } from '@angular/forms';
-import { AngularPConnectData, AngularPConnectService, ComponentMapperComponent } from '@pega/angular-sdk-components';
+import { Component, forwardRef } from '@angular/core';
+import { ComponentMapperComponent, DetailsTemplateBase } from '@pega/angular-sdk-components';
 
 @Component({
   selector: 'app-pega-dxil-my-two-column-details',
@@ -9,11 +8,8 @@ import { AngularPConnectData, AngularPConnectService, ComponentMapperComponent }
   standalone: true,
   imports: [forwardRef(() => ComponentMapperComponent)]
 })
-export class PegaDxilMyTwoColumnDetailsComponent implements OnInit, OnDestroy {
-  constructor(private angularPConnect: AngularPConnectService) {}
-
-  @Input() pConn$: typeof PConnect;
-  @Input() formGroup$: FormGroup;
+export class PegaDxilMyTwoColumnDetailsComponent extends DetailsTemplateBase {
+  override pConn$: typeof PConnect;
 
   showHighlightedData: boolean;
   highlightedDataArr: any;
@@ -24,45 +20,13 @@ export class PegaDxilMyTwoColumnDetailsComponent implements OnInit, OnDestroy {
 
   propsToUse: any = {};
 
-  // Used with AngularPConnect
-  angularPConnectData: AngularPConnectData = {};
-
-  ngOnInit(): void {
-    // First thing in initialization is registering and subscribing to the AngularPConnect service
-    this.angularPConnectData = this.angularPConnect.registerAndSubscribeComponent(this, this.onStateChange);
-
-    // this.updateSelf();
-    this.checkAndUpdate();
-  }
-
-  ngOnDestroy() {
-    if (this.angularPConnectData.unsubscribeFn) {
-      this.angularPConnectData.unsubscribeFn();
-    }
-  }
-
-  onStateChange() {
-    this.checkAndUpdate();
-  }
-
-  checkAndUpdate() {
-    // Should always check the bridge to see if the component should
-    // update itself (re-render)
-    const bUpdateSelf = this.angularPConnect.shouldComponentUpdate(this);
-
-    // ONLY call updateSelf when the component should update
-    if (bUpdateSelf) {
-      this.updateSelf();
-    }
-  }
-
-  updateSelf() {
-    const rawMetaData: any = this.pConn$.resolveConfigProps((this.pConn$.getRawMetadata() as any).config);
+  override updateSelf() {
+    const rawMetaData: any = this.pConn$.resolveConfigProps(this.pConn$.getRawMetadata()?.config);
     this.showHighlightedData = rawMetaData?.showHighlightedData;
 
     if (this.showHighlightedData) {
       const highlightedData = rawMetaData?.highlightedData;
-      this.highlightedDataArr = highlightedData.map(field => {
+      this.highlightedDataArr = highlightedData?.map(field => {
         field.config.displayMode = 'STACKED_LARGE_VAL';
 
         if (field.config.value === '@P .pyStatusWork') {
@@ -74,7 +38,7 @@ export class PegaDxilMyTwoColumnDetailsComponent implements OnInit, OnDestroy {
       });
     }
 
-    this.pConn$.setInheritedProp('displayMode', 'LABELS_LEFT');
+    this.pConn$.setInheritedProp('displayMode', 'DISPLAY_ONLY');
     this.pConn$.setInheritedProp('readOnly', true);
 
     const kids = this.pConn$.getChildren() as any[];