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

package/tests/assets/sdk-a/components/createAll/override-sdk/template/wss-nav-bar/wss-nav-bar.component.scss

@@ -15,16 +15,12 @@
   padding-top: 0.625rem;
   cursor: pointer;
   padding-right: 1rem;
-  &:hover {
-    background-color: var(--app-neutral-color);
-  }
   align-items: center;
 }
 
 .psdk-nav-logo {
-  width: 3.75rem;
-  padding: 0.625rem;
-  margin-right: 1.25rem;
+  max-width: 100%;
+  height: 3rem;
 }
 
 .psdk-nav-svg-icon {
@@ -108,14 +104,11 @@
 
 .psdk-nav-button-span {
   padding: 0 1rem;
-  color: var(--app-nav-color);
-
-  &:hover {
-    background-color: var(--app-neutral-color);
-  }
 }
 
 .psdk-nav-oper-avatar {
+  border-radius: 100%;
+  background-color: var(--mat-sys-primary);
   margin: 0rem;
   padding: 0rem;
   min-width: 2.5rem;
@@ -127,12 +120,14 @@
   align-items: center;
   text-align: center;
   display: inline-flex;
-  background: var(--app-neutral-color);
-  color: var(--app-form-color);
   font-weight: normal;
   font-size: 1rem;
 }
 
+mat-toolbar {
+  background-color: var(--mat-sys-surface-variant);
+}
+
 mat-list {
   padding: 0;
 }
@@ -147,10 +142,6 @@ mat-list-item {
   cursor: pointer !important;
   height: auto !important;
 
-  &:hover {
-    // background-color: rgba(0, 0, 0, 0.5);
-  }
-
   .flex-box {
     display: flex;
     align-items: center;

package/tests/assets/sdk-a/components/createAll/override-sdk/template/wss-nav-bar/wss-nav-bar.component.ts

@@ -1,4 +1,4 @@
-import { ChangeDetectorRef, Component, Input, NgZone, OnDestroy, OnInit } from '@angular/core';
+import { ChangeDetectorRef, Component, Input, OnDestroy, OnInit } from '@angular/core';
 import { CommonModule } from '@angular/common';
 import { MatMenuModule } from '@angular/material/menu';
 import { MatListModule } from '@angular/material/list';
@@ -19,7 +19,6 @@ interface WssNavBarProps {
   templateUrl: './wss-nav-bar.component.html',
   styleUrls: ['./wss-nav-bar.component.scss'],
   providers: [Utils],
-  standalone: true,
   imports: [CommonModule, MatListModule, MatMenuModule, MatIconModule, MatToolbarModule]
 })
 export class WssNavBarComponent implements OnInit, OnDestroy {
@@ -28,6 +27,7 @@ export class WssNavBarComponent implements OnInit, OnDestroy {
   @Input() pages$: any[];
   @Input() caseTypes$: any[];
   @Input() homePage: any;
+  @Input() portalLogoImage$: string;
 
   // For interaction with AngularPConnect
   angularPConnectData: AngularPConnectData = {};
@@ -37,10 +37,6 @@ export class WssNavBarComponent implements OnInit, OnDestroy {
   navExpandCollapse$: string;
   bShowCaseTypes$ = false;
 
-  portalApp$: string | undefined = '';
-  portalLogoImage$: string;
-  showAppName$ = false;
-
   portalOperator$: string | undefined;
   portalOperatorInitials$: string;
 
@@ -56,7 +52,6 @@ export class WssNavBarComponent implements OnInit, OnDestroy {
     private angularPConnect: AngularPConnectService,
     private cdRef: ChangeDetectorRef,
     private psService: ProgressSpinnerService,
-    private ngZone: NgZone,
     private utils: Utils
   ) {}
 
@@ -106,34 +101,29 @@ export class WssNavBarComponent implements OnInit, OnDestroy {
   }
 
   initComponent() {
-    this.ngZone.run(() => {
-      this.navIcon$ = this.utils.getSDKStaticContentUrl().concat('assets/pzpega-logo-mark.svg');
-      this.navExpandCollapse$ = this.utils.getImageSrc('plus', this.utils.getSDKStaticContentUrl());
-
-      // Then, continue on with other initialization
+    this.navIcon$ = this.utils.getSDKStaticContentUrl().concat('assets/pzpega-logo-mark.svg');
+    this.navExpandCollapse$ = this.utils.getImageSrc('plus', this.utils.getSDKStaticContentUrl());
 
-      // making a copy, so can add info
-      this.navPages$ = JSON.parse(JSON.stringify(this.pages$));
+    // Then, continue on with other initialization
 
-      this.navPages$.forEach(page => {
-        page.iconName = this.utils.getImageSrc(page.pxPageViewIcon, this.utils.getSDKStaticContentUrl());
-      });
+    // making a copy, so can add info
+    this.navPages$ = JSON.parse(JSON.stringify(this.pages$));
 
-      this.actionsAPI = this.pConn$.getActionsApi();
-      this.createWork = this.actionsAPI.createWork.bind(this.actionsAPI);
-      this.showPage = this.actionsAPI.showPage.bind(this.actionsAPI);
-      this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as WssNavBarProps;
-      this.logout = this.actionsAPI.logout.bind(this.actionsAPI);
+    this.navPages$.forEach(page => {
+      page.iconName = this.utils.getImageSrc(page.pxPageViewIcon, this.utils.getSDKStaticContentUrl());
+    });
 
-      // const oData = this.pConn$.getDataObject();
+    this.actionsAPI = this.pConn$.getActionsApi();
+    this.createWork = this.actionsAPI.createWork.bind(this.actionsAPI);
+    this.showPage = this.actionsAPI.showPage.bind(this.actionsAPI);
+    this.configProps$ = this.pConn$.resolveConfigProps(this.pConn$.getConfigProps()) as WssNavBarProps;
+    this.logout = this.actionsAPI.logout.bind(this.actionsAPI);
 
-      this.portalLogoImage$ = this.utils.getSDKStaticContentUrl().concat('assets/pzpega-logo-mark.svg');
-      this.portalOperator$ = PCore.getEnvironmentInfo().getOperatorName();
-      this.portalOperatorInitials$ = this.utils.getInitials(this.portalOperator$ ?? '');
-      this.showAppName$ = this.configProps$.showAppName;
+    // const oData = this.pConn$.getDataObject();
 
-      this.portalApp$ = PCore.getEnvironmentInfo().getApplicationLabel();
-    });
+    this.portalOperator$ = PCore.getEnvironmentInfo().getOperatorName();
+    this.portalOperatorInitials$ = this.utils.getInitials(this.portalOperator$ ?? '');
+    this.cdRef.markForCheck();
   }
 
   navPanelButtonClick(oPageData: any) {

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/app-announcement/app-announcement.component.html

@@ -3,11 +3,10 @@
   <div>
     <p>{{ configProps$.description }}</p>
     <div>
-      <h3>{{ configProps$.label }}</h3>
       <ul>
         <li *ngFor="let detail of details$">{{ detail }}</li>
       </ul>
     </div>
   </div>
-  <a *ngIf="configProps$.whatsnewlink != ''" mat-raised-button color="primary" [href]="configProps$.whatsnewlink">See what's new</a>
+  <a *ngIf="configProps$.whatsnewlink != ''" mat-raised-button [href]="configProps$.whatsnewlink">See what's new</a>
 </article>

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/app-announcement/app-announcement.component.scss

@@ -10,10 +10,10 @@ ul {
   padding-inline-start: 20px;
 }
 .psdk-announcement {
-  background-color: var(--app-form-color);
+  background-color: var(--mat-sys-surface-container);
   padding: 1rem;
   margin: 1rem 0;
   border-radius: 0.6125rem;
   border-left: 6px solid;
-  border-left-color: var(--app-primary-color);
+  border-left-color: var(--mat-sys-primary);
 }

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/app-announcement/app-announcement.component.ts

@@ -15,7 +15,6 @@ interface AppAnnouncementProps {
   selector: 'app-app-announcement',
   templateUrl: './app-announcement.component.html',
   styleUrls: ['./app-announcement.component.scss'],
-  standalone: true,
   imports: [CommonModule, MatButtonModule]
 })
 export class AppAnnouncementComponent implements OnInit {

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/app-announcement/config-ext.json

@@ -1,9 +1,8 @@
 {
-    "componentKey": "AppAnnouncement",
-    "name": "AppAnnouncement",
-    "label": "App announcement",
-    "description": "App announcement widget",
-    "type": "Widget",
-    "subtype": "PAGE",
-    "properties": []
-}
+  "name": "AppAnnouncement",
+  "label": "App announcement",
+  "description": "App announcement widget",
+  "type": "Widget",
+  "subtype": "PAGE",
+  "properties": []
+}

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/attachment/Attachment.types.ts

@@ -0,0 +1,92 @@
+export interface ResponseProps {
+  ID: string;
+  extension: string;
+  createDateTime?: Date | string | number;
+  createUser?: string;
+  name: string;
+}
+
+export interface AttachmentActions {
+  rel: string;
+  href: string;
+  title: string;
+  type: string;
+}
+
+export interface AttachmentLinks {
+  delete: AttachmentActions;
+  download: AttachmentActions;
+  edit: AttachmentActions;
+}
+export interface FileObject extends File {
+  icon?: string;
+  ID: string;
+  fileName: string;
+  category: string;
+  responseType: string;
+  fileType: string;
+  mimeType: string;
+  extension: string;
+  thumbnail?: string;
+  nameWithExt: string;
+  inProgress?: boolean;
+  progress?: number;
+  handle: string;
+  label: string;
+  delete?: boolean;
+  error?: boolean;
+  description: string;
+
+  props: {
+    icon?: string;
+    id: string;
+    error?: string;
+    format?: string;
+    name: string;
+    thumbnail?: string;
+    onPreview?: () => void;
+    onDelete?: () => void;
+    onOpen?: () => void;
+    onEdit?: () => void;
+    onCancel?: () => void;
+  };
+  responseProps: ResponseProps;
+  value?: {
+    filename: string;
+    ID: string;
+    thumbnail: string;
+  };
+  categoryName: string;
+  createTime: string;
+  createdBy: string;
+  createdByName: string;
+  links: AttachmentLinks;
+  name: string;
+  meta?: any;
+}
+
+export interface ReduxAttachments {
+  ID?: string;
+  pzInsKey?: string;
+  FileName: string;
+  Category: string;
+  MimeType?: string;
+  FileExtension: string;
+  error: string | null;
+  localAttachment: boolean;
+  thumbnail?: string;
+  fileIndex?: number;
+  instruction?: string;
+}
+
+export interface PageInstructionOptions {
+  allowMultiple: boolean;
+  isMultiAttachmentInInlineEditTable: boolean;
+  attachmentCount: number;
+  insertPageInstruction: boolean;
+  deletePageInstruction: boolean;
+  deleteIndex: number;
+  insertRedux: boolean;
+  isOldAttachment: boolean;
+  deleteRedux: boolean;
+}

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/attachment/AttachmentUtils.ts

@@ -0,0 +1,287 @@
+import download from 'downloadjs';
+
+import type { FileObject, PageInstructionOptions, ReduxAttachments } from './Attachment.types';
+
+const megabyteSize = 1048576;
+
+export const isContentBinary = (headers: Record<string, string>) => {
+  return headers && headers['content-transfer-encoding'] === 'binary';
+};
+
+export const isContentBase64 = (headers: Record<string, string>) => {
+  return headers && headers['content-transfer-encoding'] === 'base64';
+};
+
+export const validateMaxSize = (fileObj: Record<string, number>, maxSizeInMB: string) => {
+  const fileSize = (fileObj['size'] / megabyteSize).toFixed(2);
+  return parseFloat(fileSize) < parseFloat(maxSizeInMB);
+};
+
+export const validateFileExtension = (fileObj: Record<string, string>, allowedExtensions: string) => {
+  if (!allowedExtensions) {
+    return true;
+  }
+  const allowedExtensionList = allowedExtensions
+    .toLowerCase()
+    .split(',')
+    .map(item => item.replaceAll('.', '').trim());
+  const extension = fileObj['name'].split('.').pop()?.toLowerCase() || '';
+  return allowedExtensionList.includes(extension);
+};
+
+export const fileDownload = (data: string | Blob, fileName: string, ext: string | null, headers: Record<string, string>) => {
+  const name = ext ? `${fileName}.${ext}` : fileName;
+  // Temp fix: downloading EMAIl type attachment as html file
+  if (ext === 'html') {
+    download(isContentBase64(headers) ? atob(data as string) : data, name, 'text/html');
+  } else if (isContentBinary(headers)) {
+    download(data, name);
+  } else {
+    download(atob(data as string), name);
+  }
+};
+
+export const fileDownloadVar = (content: { data: string; headers: Record<string, string> }, type: string, name: string, extension: string) => {
+  if (type === 'FILE' || type === undefined) {
+    fileDownload(content.data, name, extension, content.headers);
+  } else if (type === 'URL') {
+    let { data } = content;
+    if (!/^(http|https):\/\//.test(data)) {
+      data = `//${data}`;
+    }
+    window.open(content.data, '_blank');
+  } else if (type === 'EMAIL') {
+    // Temp Fix: for EMAIL type attachment
+    fileDownload(content.data, name, 'html', content.headers);
+  }
+};
+
+export const getMappedValue = (value: string): string => {
+  return PCore.getEnvironmentInfo().getKeyMapping(value) ?? value;
+};
+
+const generateInstructions = (
+  files: FileObject[],
+  pConn: typeof PConnect,
+  attachmentsInModal: ReduxAttachments[] | Pick<ReduxAttachments, 'instruction' | 'fileIndex'>[],
+  options: {
+    allowMultiple: boolean;
+    isMultiAttachmentInInlineEditTable: boolean;
+    attachmentCount: number;
+    insertPageInstruction: boolean;
+    deletePageInstruction: boolean;
+    deleteIndex: number;
+  }
+) => {
+  const { allowMultiple, isMultiAttachmentInInlineEditTable, attachmentCount, insertPageInstruction, deletePageInstruction, deleteIndex } = options;
+  const transformedAttachments: ReduxAttachments[] = [];
+  let valueRef = pConn.getStateProps().value;
+  valueRef = valueRef?.indexOf('.') === 0 ? valueRef.substring(1) : valueRef;
+  const uniqueKey = getMappedValue('pzInsKey');
+  files.forEach((file, index) => {
+    const filename = file.value?.filename || file.props?.name || '';
+    const payload = {
+      [uniqueKey]: file.value?.ID || file.props?.id,
+      FileName: filename,
+      Category: '',
+      // MimeType: getMimeTypeFromFile(filename),
+      FileExtension: filename.split('.').pop() ?? filename,
+      error: file.props?.error || null,
+      localAttachment: true,
+      thumbnail: file.value?.thumbnail
+    };
+    transformedAttachments.push(payload);
+    if (payload.error) {
+      return; // Don't process page instructions for error files, skip current iteration
+    }
+    if (allowMultiple) {
+      if (isMultiAttachmentInInlineEditTable) {
+        if (insertPageInstruction) {
+          attachmentsInModal.push({ ...payload, instruction: 'insert' } as any);
+        } else if (deletePageInstruction) {
+          (attachmentsInModal as Pick<ReduxAttachments, 'instruction' | 'fileIndex'>[]).push({
+            instruction: 'delete',
+            fileIndex: deleteIndex
+          });
+        }
+      } else if (insertPageInstruction) {
+        pConn.getListActions().insert({ ID: payload[uniqueKey] }, attachmentCount + index, undefined, {
+          skipStateUpdate: true
+        });
+      } else if (deletePageInstruction) {
+        pConn.getListActions().deleteEntry(deleteIndex, undefined, { skipStateUpdate: true });
+      }
+    } else if (insertPageInstruction) {
+      pConn.getListActions().replacePage(`.${valueRef}`, { ID: payload[uniqueKey] }, { skipStateUpdate: true });
+    } else if (deletePageInstruction) {
+      pConn.getListActions().deletePage(`.${valueRef}`, { skipStateUpdate: true });
+    }
+  });
+  return transformedAttachments;
+};
+
+export const updateReduxState = (
+  transformedAttachments: ReduxAttachments[],
+  pConn: typeof PConnect,
+  valueRef: string,
+  options: PageInstructionOptions
+) => {
+  const { allowMultiple, isOldAttachment, insertRedux, deleteRedux } = options;
+  let deleteIndex = -1;
+
+  if (allowMultiple || isOldAttachment) {
+    transformedAttachments.forEach(attachment => {
+      const key = isOldAttachment ? `${valueRef}.pxResults` : valueRef;
+      const existingAttachments: ReduxAttachments[] = PCore.getStoreValue(`.${key}`, pConn.getPageReference(), pConn.getContextName()) || [];
+
+      if (insertRedux) {
+        const actionPayLoad = {
+          type: 'LIST_ACTION',
+          payload: {
+            instruction: 'INSERT',
+            context: pConn.getContextName(),
+            referenceList: `${pConn.getPageReference()}.${key}`,
+            listIndex: existingAttachments.length,
+            content: attachment
+          }
+        };
+        PCore.getStore()?.dispatch(actionPayLoad);
+      } else if (deleteRedux) {
+        const uniqueKey = getMappedValue('pzInsKey');
+        deleteIndex = existingAttachments.findIndex(
+          existingAttachment =>
+            existingAttachment[uniqueKey as keyof ReduxAttachments] === transformedAttachments[0][uniqueKey as keyof ReduxAttachments]
+        );
+        const actionPayLoad = {
+          type: 'LIST_ACTION',
+          payload: {
+            instruction: 'DELETE',
+            context: pConn.getContextName(),
+            referenceList: `${pConn.getPageReference()}.${key}`,
+            listIndex: deleteIndex
+          }
+        };
+        PCore.getStore()?.dispatch(actionPayLoad);
+      }
+    });
+  } else if (insertRedux) {
+    const actionPayLoad = {
+      type: 'LIST_ACTION',
+      payload: {
+        instruction: 'REPLACE',
+        context: pConn.getContextName(),
+        referenceList: `${pConn.getPageReference()}.${valueRef}`,
+        content: transformedAttachments[0]
+      }
+    };
+    PCore.getStore()?.dispatch(actionPayLoad);
+  } else if (deleteRedux) {
+    const actionPayLoad = {
+      type: 'LIST_ACTION',
+      payload: {
+        instruction: 'DELETEPAGE',
+        context: pConn.getContextName(),
+        referenceList: `${pConn.getPageReference()}.${valueRef}`
+      }
+    };
+    PCore.getStore()?.dispatch(actionPayLoad);
+  }
+};
+
+export const insertAttachments = (
+  files: FileObject[],
+  pConn: typeof PConnect,
+  attachmentsInModal: ReduxAttachments[],
+  options: PageInstructionOptions
+) => {
+  const { isMultiAttachmentInInlineEditTable } = options;
+  let valueRef = pConn.getStateProps().value;
+  valueRef = valueRef?.indexOf('.') === 0 ? valueRef.substring(1) : valueRef;
+  const transformedAttachments = generateInstructions(files, pConn, attachmentsInModal, {
+    ...options,
+    insertPageInstruction: true
+  });
+
+  if (isMultiAttachmentInInlineEditTable) {
+    return; // For attachments within modal, redux update is not necessary yet, as modal isn't submitted at this stage
+  }
+  updateReduxState(transformedAttachments, pConn, valueRef, { ...options, insertRedux: true });
+};
+
+export const deleteAttachments = (
+  files: FileObject[],
+  pConn: typeof PConnect,
+  attachmentsInModal: Pick<ReduxAttachments, 'instruction' | 'fileIndex'>[],
+  options: PageInstructionOptions
+) => {
+  const { isMultiAttachmentInInlineEditTable } = options;
+  let valueRef = pConn.getStateProps().value;
+  valueRef = valueRef?.indexOf('.') === 0 ? valueRef.substring(1) : valueRef;
+  const transformedAttachments = generateInstructions(files, pConn, attachmentsInModal, {
+    ...options,
+    deletePageInstruction: true
+  });
+
+  if (isMultiAttachmentInInlineEditTable) {
+    return; // For attachments within modal, redux update is not necessary yet, as modal isn't submitted at this stage
+  }
+  updateReduxState(transformedAttachments, pConn, valueRef, { ...options, deleteRedux: true });
+};
+
+export const clearFieldErrorMessages = (pConn: typeof PConnect) => {
+  const fieldName = pConn.getStateProps().value;
+  PCore.getMessageManager().clearMessages({
+    type: PCore.getConstants().MESSAGES.MESSAGES_TYPE_ERROR,
+    property: fieldName,
+    pageReference: pConn.getPageReference(),
+    context: pConn.getContextName()
+  });
+};
+
+export const onFileDownload = (responseProps, context) => {
+  const { ID, name, extension, type, category, responseType } = responseProps;
+
+  if (category !== 'pxDocument') {
+    (
+      PCore.getAttachmentUtils().downloadAttachment(ID, context, responseType) as Promise<{
+        data: string;
+        headers: Record<string, string>;
+      }>
+    )
+      .then(content => {
+        fileDownloadVar(content, type, name, extension);
+      })
+
+      .catch(console.error);
+  } else {
+    (
+      PCore.getAttachmentUtils().downloadDocument(ID, context) as Promise<{
+        data: string;
+        headers: Record<string, string>;
+      }>
+    )
+      .then(content => {
+        fileDownloadVar(content, type, name, extension);
+      })
+
+      .catch(console.error);
+  }
+};
+
+// Prepares new structure as per Cosmos component
+export const transformAttachments = attachments => {
+  const transformedFiles = [...attachments];
+  let deleteIndex = -1;
+  transformedFiles.forEach(attachment => {
+    attachment.props.id = attachment.responseProps.ID;
+    attachment.props.format = attachment.props.name.split('.').pop();
+    if (attachment.props.error) {
+      attachment.responseProps.deleteIndex = deleteIndex;
+    } else {
+      deleteIndex += 1;
+      attachment.responseProps.deleteIndex = deleteIndex;
+    }
+  });
+
+  return transformedFiles;
+};

package/tests/assets/sdk-a/components/createAll/override-sdk/widget/attachment/attachment.component.html

@@ -25,7 +25,7 @@
   </div>
   <span *ngIf="validateMessage" class="file-error">{{ validateMessage }}</span>
   <div *ngIf="files && files.length > 0">
-    <div *ngFor="let file of files">
+    <div *ngFor="let file of files; let i = index">
       <div class="psdk-attachment-card">
         <div className="psdk-utility-card-icon">
           <img *ngIf="!file.inProgress" class="psdk-attachment-card-svg-icon" src="{{ srcImg }}" />
@@ -36,7 +36,7 @@
           <div *ngIf="file.props.meta" [ngStyle]="{ color: file.props.error ? 'red' : null }">{{ file.props.meta }}</div>
         </div>
         <div class="psdk-attachment-action">
-          <button id="delete-attachment" *ngIf="file.ID" class="psdk-utility-button" (click)="deleteFile(file)">
+          <button id="delete-attachment" *ngIf="file.ID" class="psdk-utility-button" (click)="deleteFile(file, i)">
             <img class="psdk-utility-card-action-svg-icon" src="{{ deleteIcon }}" />
           </button>
           <div *ngIf="!file.ID">
@@ -45,7 +45,7 @@
             </button>
             <mat-menu #actionMenu="matMenu">
               <button mat-menu-item (click)="downloadFile(file.responseProps ? file.responseProps : {})">Download</button>
-              <button mat-menu-item (click)="deleteFile(file)">Delete</button>
+              <button mat-menu-item (click)="deleteFile(file, i)">Delete</button>
             </mat-menu>
           </div>
         </div>