@pega/dx-component-builder-sdk 0.8.2 → 0.23.2

package/tests/assets/components/SDK-React/createAll/override-sdk/template/DataReference/DataReference.tsx

@@ -1,23 +1,23 @@
 import React, { useMemo, useState, useEffect } from 'react';
 import SingleReferenceReadonly from '@pega/react-sdk-components/lib/components/template/SingleReferenceReadOnly';
 import MultiReferenceReadonly from '@pega/react-sdk-components/lib/components/template/MultiReferenceReadOnly';
-// import type { PConnProps } from '../../../types/PConnProps';
+import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
-// Can't use PConn props until proper props for getPConnect().getChildren()[0].getPConnect;
-// interface DataReferenceProps extends PConnProps {
-//   // If any, enter additional props that only exist on this component
-//   children: Array<any>,
-//   label: string,
-//   showLabel: any,
-//   displayMode: string,
-//   allowAndPersistChangesInReviewMode: boolean,
-//   referenceType: string,
-//   selectionMode: string,
-//   displayAs: string,
-//   ruleClass: string,
-//   parameters: Array<string>, // need to fix
-//   hideLabel: boolean
-// }
+// ReferenceProps can't be used until getComponentConfig() is NOT private
+interface DataReferenceProps extends PConnProps {
+  // If any, enter additional props that only exist on this component
+  children: Array<any>,
+  label: string,
+  showLabel: any,
+  displayMode: string,
+  allowAndPersistChangesInReviewMode: boolean,
+  referenceType: string,
+  selectionMode: string,
+  displayAs: string,
+  ruleClass: string,
+  parameters: Array<string>, // need to fix
+  hideLabel: boolean
+}
 
 
 const SELECTION_MODE = { SINGLE: 'single', MULTI: 'multi' };
@@ -26,7 +26,7 @@ const SELECTION_MODE = { SINGLE: 'single', MULTI: 'multi' };
 declare const PCore: any;
 
 
-export default function DataReference(props /* : DataReferenceProps */) {
+export default function DataReference(props: DataReferenceProps) {
   const {
     children,
     getPConnect,
@@ -49,9 +49,9 @@ export default function DataReference(props /* : DataReferenceProps */) {
     propsToUse.label = '';
   }
   const rawViewMetadata = pConn.getRawMetadata();
-  const viewName = rawViewMetadata.name;
-  const [firstChildMeta] = rawViewMetadata.children;
-  const refList = rawViewMetadata.config.referenceList;
+  const viewName = rawViewMetadata["name"];
+  const [firstChildMeta] = rawViewMetadata["children"];
+  const refList = rawViewMetadata["config"].referenceList;
   const canBeChangedInReviewMode = allowAndPersistChangesInReviewMode && (displayAs === 'autocomplete' || displayAs === 'dropdown');
   let propName;
   const isDisplayModeEnabled = ['LABELS_LEFT', 'STACKED_LARGE_VAL'].includes(displayMode);
@@ -61,7 +61,7 @@ export default function DataReference(props /* : DataReferenceProps */) {
   useEffect(() => {
     if (
       firstChildMeta?.type === "Dropdown" &&
-      rawViewMetadata.config?.parameters
+      rawViewMetadata["config"]?.parameters
     ) {
       const { value, key, text } = firstChildMeta.config.datasource.fields;
       PCore.getDataApiUtils()
@@ -101,14 +101,14 @@ export default function DataReference(props /* : DataReferenceProps */) {
       delete firstChildMeta.config.readOnly;
     }
     if (firstChildMeta?.type === 'Dropdown') {
-      firstChildMeta.config.datasource.source = rawViewMetadata.config?.parameters
+      firstChildMeta.config.datasource.source = rawViewMetadata["config"]?.parameters
         ? dropDownDataSource
         : '@DATASOURCE '.concat(refList).concat('.pxResults');
     } else if (firstChildMeta?.type === 'AutoComplete') {
       firstChildMeta.config.datasource = refList;
 
       /* Insert the parameters to the component only if present */
-      if (rawViewMetadata.config?.parameters) {
+      if (rawViewMetadata["config"]?.parameters) {
         firstChildMeta.config.parameters = parameters;
       }
     }
@@ -187,8 +187,10 @@ export default function DataReference(props /* : DataReferenceProps */) {
   const recreatedFirstChild = useMemo(() => {
     const { type, config } = firstChildMeta;
     if (firstChildMeta?.type !== 'Region') {
-      pConn.clearErrorMessages({
-        property: propName
+      pConn.clearErrorMessages({  // Need to add empty string for category and context to match typdef
+        property: propName,
+        category: '',
+        context: ''
       });
       if (!canBeChangedInReviewMode && isDisplayModeEnabled && selectionMode === SELECTION_MODE.SINGLE) {
         return (
@@ -203,7 +205,7 @@ export default function DataReference(props /* : DataReferenceProps */) {
             referenceType={referenceType}
             hideLabel={hideLabel}
             dataRelationshipContext={
-              rawViewMetadata.config.contextClass && rawViewMetadata.config.name ? rawViewMetadata.config.name : null
+              rawViewMetadata["config"].contextClass && rawViewMetadata["config"].name ? rawViewMetadata["config"].name : null
             }
           />
         );
@@ -223,7 +225,7 @@ export default function DataReference(props /* : DataReferenceProps */) {
       // In the case of a datasource with parameters you cannot load the dropdown before the parameters
       if (
         type === 'Dropdown' &&
-        rawViewMetadata.config?.parameters &&
+        rawViewMetadata["config"]?.parameters &&
         dropDownDataSource === null
       ) {
         return null;
@@ -238,19 +240,19 @@ export default function DataReference(props /* : DataReferenceProps */) {
           disabled: propsToUse.disabled,
           label: propsToUse.label,
           viewName: getPConnect().getCurrentView(),
-          parameters: rawViewMetadata.config.parameters,
+          parameters: rawViewMetadata["config"].parameters,
           readOnly: false,
-          localeReference: rawViewMetadata.config.localeReference,
+          localeReference: rawViewMetadata["config"].localeReference,
           ...(selectionMode === SELECTION_MODE.SINGLE ? { referenceType } : ''),
           dataRelationshipContext:
-            rawViewMetadata.config.contextClass && rawViewMetadata.config.name
-              ? rawViewMetadata.config.name
+            rawViewMetadata["config"].contextClass && rawViewMetadata["config"].name
+              ? rawViewMetadata["config"].name
               : null,
           hideLabel,
           onRecordChange: handleSelection
-        }
+        },
       },
-      null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;);
+      '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional);
     }
   }, [
     firstChildMeta.config?.datasource?.source,
@@ -262,7 +264,7 @@ export default function DataReference(props /* : DataReferenceProps */) {
 
   // Only include the views region for rendering when it has content
   if (firstChildMeta?.type !== 'Region') {
-    const viewsRegion = rawViewMetadata.children[1];
+    const viewsRegion = rawViewMetadata["children"][1];
     if (viewsRegion?.name === 'Views' && viewsRegion.children.length) {
       childrenToRender = [recreatedFirstChild, ...children.slice(1)];
     } else {

package/tests/assets/components/SDK-React/createAll/override-sdk/template/Details/Details.tsx

@@ -45,7 +45,7 @@ export default function Details(props /* : DetailsProps */) {
       }
 
       return getPConnect().createComponent(field,
-        '','', {}); // 2nd, 3rd, and 4th args empty string/object until typedef marked correctly as optional;);
+        '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional
     });
   }
 

package/tests/assets/components/SDK-React/createAll/override-sdk/template/DetailsThreeColumn/DetailsThreeColumn.tsx

@@ -47,7 +47,7 @@ export default function DetailsThreeColumn(props /* : DetailsThreeColumnProps */
       }
 
       return getPConnect().createComponent(field,
-        null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+        '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional);
     });
   }
 

package/tests/assets/components/SDK-React/createAll/override-sdk/template/DetailsTwoColumn/DetailsTwoColumn.tsx

@@ -48,7 +48,7 @@ export default function DetailsTwoColumn(props /* : DetailsTwoColumnProps */) {
       }
 
       return getPConnect().createComponent(field,
-        null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+        '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional
     });
   }
 

package/tests/assets/components/SDK-React/createAll/override-sdk/template/InlineDashboardPage/InlineDashboardPage.tsx

@@ -23,7 +23,7 @@ export default function InlineDashboardPage(props: InlineDashboardPageProps) {
     return Children.toArray(children);
   }, [children]);
 
-  const allFilters = getPConnect().getRawMetadata().children[1];
+  const allFilters = getPConnect().getRawMetadata()["children"][1];
 
   useEffect(() => {
     setFilterComponents(buildFilterComponents(getPConnect, allFilters));

package/tests/assets/components/SDK-React/createAll/override-sdk/template/MultiReferenceReadOnly/MultiReferenceReadOnly.tsx

@@ -29,7 +29,7 @@ export default function MultiReferenceReadOnly(props: MultiReferenceReadOnlyProp
       hideLabel
     }
   },
-  null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+  '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional
 
    return (
     <React.Fragment>{component}</React.Fragment>

package/tests/assets/components/SDK-React/createAll/override-sdk/template/NarrowWideDetails/NarrowWideDetails.tsx

@@ -50,7 +50,7 @@ export default function NarrowWideDetails(props /* : NarrowWideDetailsProps */)
       }
 
       return getPConnect().createComponent(field,
-        null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+        '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional
     });
   }
 

package/tests/assets/components/SDK-React/createAll/override-sdk/template/PromotedFilters/PromotedFilters.tsx

@@ -6,16 +6,18 @@ import ListView from '@pega/react-sdk-components/lib/components/template/ListVie
 import { isEmptyObject } from '@pega/react-sdk-components/lib/components/helpers/common-utils';
 import './PromotedFilters.css';
 
-import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
-
-interface PromotedFilterProps extends PConnProps {
-  // If any, enter additional props that only exist on this component
-  viewName: string,
-  filters: Array<any>,
-  listViewProps: any,
-  pageClass: string,
-  parameters?: object
-}
+// import type { PConnProps } from '../../../types/PConnProps';
+
+// Can't use PromotedFilterProps until getContainerManager() knows about addTransientItem
+//  Currently just expects "object"
+// interface PromotedFilterProps extends PConnProps {
+//   // If any, enter additional props that only exist on this component
+//   viewName: string,
+//   filters: Array<any>,
+//   listViewProps: any,
+//   pageClass: string,
+//   parameters?: object
+// }
 
 
 const localeCategory = 'SimpleTable';
@@ -65,7 +67,7 @@ function isValidInput(input) {
   return Object.values(input).findIndex((v) => v) >= 0;
 }
 
-export default function PromotedFilters(props: PromotedFilterProps) {
+export default function PromotedFilters(props /* : PromotedFilterProps */) {
   const localizedVal = PCore.getLocaleUtils().getLocaleValue;
   const { getPConnect, viewName, filters, listViewProps, pageClass, parameters } = props;
   const [initTable, setInitTable] = useState(false);

package/tests/assets/components/SDK-React/createAll/override-sdk/template/SimpleTable/SimpleTable.tsx

@@ -1,18 +1,18 @@
 import React from 'react';
 import FieldGroupTemplate from '@pega/react-sdk-components/lib/components/template/FieldGroupTemplate';
 import SimpleTableManual from '@pega/react-sdk-components/lib/components/template/SimpleTable/SimpleTableManual';
-import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
-
-interface SimpleTableProps extends PConnProps {
-  // If any, enter additional props that only exist on this component
-  multiRecordDisplayAs: string,
-  allowTableEdit: boolean,
-  contextClass: any
-}
+// import type { PConnProps } from '../../../../types/PConnProps';
 
+// Can't use SimpleTableProps until getComponentConfig() and getFieldMetadata() are NOT private
+// interface SimpleTableProps extends PConnProps {
+//   // If any, enter additional props that only exist on this component
+//   multiRecordDisplayAs: string,
+//   allowTableEdit: boolean,
+//   contextClass: any
+// }
 
 
-export default function SimpleTable(props: SimpleTableProps) {
+export default function SimpleTable(props /* : SimpleTableProps */) {
   const { getPConnect, multiRecordDisplayAs, allowTableEdit } = props;
 
   let { contextClass } = props;

package/tests/assets/components/SDK-React/createAll/override-sdk/template/SimpleTableManual/SimpleTableManual.tsx

@@ -150,7 +150,7 @@ export default function SimpleTableManual(props: SimpleTableManualProps) {
   //    config.datasource (ex: "@ASSOCIATED .DeclarantChoice")
   //  Neither of these appear in the resolved props
 
-  const rawConfig = rawMetadata?.config;
+  const rawConfig = rawMetadata?.["config"];
   const rawFields =
     rawConfig?.children?.[0]?.children || rawConfig?.presets?.[0].children?.[0]?.children;
 

package/tests/assets/components/SDK-React/createAll/override-sdk/template/SingleReferenceReadOnly/SingleReferenceReadOnly.tsx

@@ -1,7 +1,6 @@
 import React from "react";
 import type { PConnProps } from '@pega/react-sdk-components/lib/types/PConnProps';
 
-// Need to fix an error noted in comment below before typedefs will work correctly
 interface SingleReferenceReadOnlyProps extends PConnProps {
   // If any, enter additional props that only exist on this component
   config: any,
@@ -56,7 +55,7 @@ export default function SingleReferenceReadOnly(props: SingleReferenceReadOnlyPr
       dataRelationshipContext
     }
   },
-  null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+  '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional
 
   return (
     <React.Fragment>{component}</React.Fragment>

package/tests/assets/components/SDK-React/createAll/override-sdk/template/WideNarrowDetails/WideNarrowDetails.tsx

@@ -5,7 +5,7 @@ import createPConnectComponent from '@pega/react-sdk-components/lib/bridge/react
 import FieldGroup from '@pega/react-sdk-components/lib/components/designSystemExtension/FieldGroup';
 // import type { PConnProps } from '../../../../types/PConnProps';
 
-// Can't use PConnProps until getPConnect.getChildren() type is ok
+// Can't use PConnProps until PConnect.getChildren() type is ok
 // interface WideNarrowDetailsProps extends PConnProps {
 //   // If any, enter additional props that only exist on this component
 //   showLabel?: boolean,
@@ -43,7 +43,7 @@ export default function WideNarrowDetails(props /* : WideNarrowDetailsProps */)
   // Set up highlighted data to pass in return if is set to show, need raw metadata to pass to createComponent
   let highlightedDataArr = [];
   if (showHighlightedData) {
-    const { highlightedData = [] } = getPConnect().getRawMetadata()["config"];
+    const { highlightedData = [] } = getPConnect().getRawMetadata().config;
     highlightedDataArr = highlightedData.map(field => {
       field.config.displayMode = 'STACKED_LARGE_VAL';
 
@@ -54,7 +54,7 @@ export default function WideNarrowDetails(props /* : WideNarrowDetailsProps */)
       }
 
       return getPConnect().createComponent(field,
-        null, null, {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional;
+        '', '', {}); // 2nd, 3rd, and 4th args empty string/object/null until typedef marked correctly as optional
     });
   }
 

package/tests/assets/components/SDK-React/createAll/override-sdk/widget/Attachment/Attachment.tsx

@@ -44,7 +44,7 @@ export default function Attachment(props /* :AttachmentProps */) {
     categoryName = value.pyCategoryName;
   }
 
-  let valueRef = pConn.getStateProps().value;
+  let valueRef = pConn.getStateProps()["value"];
   valueRef = valueRef.indexOf('.') === 0 ? valueRef.substring(1) : valueRef;
   const [file, setFile] = useState(fileTemp);
 
@@ -254,7 +254,7 @@ export default function Attachment(props /* :AttachmentProps */) {
             }
           );
         }
-        const fieldName = pConn.getStateProps().value;
+        const fieldName = pConn.getStateProps()["value"];
         const context = pConn.getContextName();
 
         PCore.getMessageManager().clearMessages({