@techextensor/tab-core-utility 2.1.5 → 2.1.7

package/src/lib/tab-core-utility/app/helpers/common/req-res.helpers.ts

@@ -0,0 +1,75 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable } from '@angular/core';
+import { APIFilterCriteria, APIValueSets } from '../../models/api-query.class';
+import { QueryType } from '../../enums/query.enum';
+@Injectable({ providedIn: 'root' })
+export class RequestResponseHelper {
+  /**
+   * Generates the payload for inserting data into a table
+   * @param table The table name to insert data into
+   * @param whereClause The filter criteria for the insert operation
+   * @param value The value sets to be inserted
+   * @returns The payload for the insert operation
+   */
+  insertPayload(
+    table: string,
+    whereClause: APIFilterCriteria,
+    value: APIValueSets[]
+  ) {
+    return this.createPayload(table, whereClause, value, QueryType.Insert);
+  }
+
+  /**
+   * Generates the payload for deleting data from a table
+   * @param tableName The table name to delete data from
+   * @param whereClause The filter criteria for the delete operation
+   * @returns The payload for the delete operation
+   */
+  deletePayload(tableName: string, whereClause: APIFilterCriteria) {
+    return {
+      QueryObjectID: tableName,
+      QueryType: QueryType.Delete,
+      Joins: [],
+      WhereClause: whereClause,
+    };
+  }
+
+  /**
+   * Generates the payload for updating data in a table
+   * @param tableName The table name to update data in
+   * @param whereClause The filter criteria for the update operation
+   * @param value The value sets to be updated
+   * @returns The payload for the update operation
+   */
+  updateRequestPayload(
+    tableName: string,
+    whereClause: APIFilterCriteria,
+    value: APIValueSets[]
+  ) {
+    return this.createPayload(tableName, whereClause, value, QueryType.Update);
+  }
+
+  /**
+   * Creates a payload object based on the input parameters
+   * @param table The table name for the payload
+   * @param whereClause The filter criteria for the payload
+   * @param value The value sets for the payload
+   * @param queryType The type of query for the payload
+   * @returns The payload object with QueryObjectID, QueryType, Joins, WhereClause, and Values
+   */
+  createPayload(
+    table: string,
+    whereClause: APIFilterCriteria,
+    value: APIValueSets[],
+    queryType: QueryType
+  ) {
+    return {
+      QueryObjectID: table,
+      QueryType: queryType,
+      Joins: [],
+      WhereClause: whereClause,
+      Values: value,
+    };
+  }
+}

package/src/lib/tab-core-utility/app/helpers/common/where-clause.helpers.ts

@@ -0,0 +1,262 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable } from '@angular/core';
+import { from } from 'rxjs';
+import { filter, map, toArray } from 'rxjs/operators';
+
+import {
+  ConjuctionClause,
+  RelationalOperator,
+  FilterValueType,
+} from '../../enums/dsq.enum';
+import { APIFilterCriteria } from '../../models/api-query.class';
+import {
+  getAppObjectFromSystemDBTableName,
+  getAppObject,
+} from '../../utils/tab-app.util';
+
+@Injectable({ providedIn: 'root' })
+export class WhereClauseHelper {
+  /**
+   * Binds the where clause for deleting records based on field, value, field name, and CRUD table name
+   * @param fields The fields to bind the where clause
+   * @param value The value to match in the where clause
+   * @param fieldName The field name to match in the where clause
+   * @param crudTableName The CRUD table name for the where clause
+   * @returns The bound where clause for delete operation
+   */
+  bindWhereClauseForDelete(
+    fields: any,
+    value: any,
+    fieldName: string,
+    crudTableName: string
+  ) {
+    const appobj = getAppObjectFromSystemDBTableName(crudTableName);
+    if (appobj && appobj.CRUDAppObjectId !== null) {
+      const crudAppObj = getAppObject(appobj.CRUDAppObjectId);
+      if (crudAppObj) {
+        crudTableName = crudAppObj.SystemDBTableName;
+      }
+    }
+    return this.bindWhereClause(fields, value, fieldName, crudTableName);
+  }
+
+  /**
+   * Binds the where clause for deleting records with multiple primary keys
+   * @param data The data containing primary key values
+   * @param fieldName The field name of the primary key
+   * @param crudTableName The CRUD table name for the where clause
+   * @returns The bound where clause for delete operation with multiple primary keys
+   */
+  bindWhereClauseForDeleteWithMultiplePrimaryKeys(
+    data: any,
+    fieldName: string,
+    crudTableName: string
+  ) {
+    return this.bindWhereClauseForMultiplePrimaryKeys(
+      data,
+      fieldName,
+      crudTableName
+    );
+  }
+
+  /**
+   * Binds the where clause for an insert operation
+   * @returns The bound where clause for insert operation
+   */
+  bindWhereClauseForInsert() {
+    return this.bindWhereClauseEmpty();
+  }
+
+  /**
+   * Binds an empty where clause
+   * @returns The bound empty where clause
+   */
+  bindWhereClauseEmpty() {
+    const whereClause = new APIFilterCriteria();
+    whereClause.FilterLogic = '1';
+    whereClause.Filters = [];
+    return whereClause;
+  }
+
+  /**
+   * Binds the where clause based on provided parameters
+   * @param fields The fields to bind the where clause
+   * @param value The value to match in the where clause
+   * @param fieldName The field name to match in the where clause
+   * @param crudTableName The CRUD table name for the where clause
+   * @returns The bound where clause
+   */
+  private bindWhereClause(
+    fields: any,
+    value: any,
+    fieldName: string,
+    crudTableName: string
+  ) {
+    return from(fields).pipe(
+      filter((f: any) =>
+        fieldName
+          ? f.Field?.FieldName === fieldName
+          : f.Field?.FieldName === 'Id' || f.Field?.FieldName === 'ID'
+      ),
+      map((field: any) => ({
+        ConjuctionClause: ConjuctionClause.AND,
+        FieldID: crudTableName + '.' + field.Field.SystemDBFieldName,
+        RelationalOperator: RelationalOperator.EqualTo,
+        ValueType: FilterValueType.Literal,
+        value: value,
+        Sequence: 0,
+        GroupID: 0,
+      })),
+      toArray(),
+      map((filters: any[]) => {
+        const whereClause = new APIFilterCriteria();
+        whereClause.Filters = filters;
+        whereClause.FilterLogic = '1';
+        return whereClause;
+      })
+    );
+  }
+
+  /**
+   * Binds the where clause for deleting records with multiple primary keys
+   * @param data The data containing primary key values
+   * @param primaryKeys The array of primary key fields
+   * @param crudTableName The CRUD table name for the where clause
+   * @returns The bound where clause for delete operation with multiple primary keys
+   */
+  bindWhereClauseForMultiplePrimaryKeys(
+    data: any,
+    primaryKeys: any,
+    crudTableName: string
+  ) {
+    const whereClause = new APIFilterCriteria();
+    whereClause.Filters = [];
+    if (primaryKeys && primaryKeys.length > 0) {
+      primaryKeys.forEach((element: any) => {
+        const value = data[element.FieldName];
+        if (value) {
+          const filter: any = {
+            ConjuctionClause: ConjuctionClause.AND,
+            FieldID: crudTableName + '.' + element.SystemDBFieldName,
+            RelationalOperator: RelationalOperator.EqualTo,
+            ValueType: FilterValueType.Literal,
+            value: value,
+            Sequence: 0,
+            GroupID: 0,
+          };
+          whereClause.Filters.push(filter);
+        }
+      });
+    }
+    whereClause.FilterLogic = '1';
+    return whereClause;
+  }
+
+  /**
+   * Binds the where clause for updating records
+   * @param tableName The name of the table to update
+   * @param queryFieldsArray The array of fields and values for the update query
+   * @returns The bound where clause for update operation
+   */
+  bindWhereClauseForUpdate(tableName: string, queryFieldsArray: any) {
+    const whereClause = new APIFilterCriteria();
+    whereClause.Filters = [];
+    if (queryFieldsArray.length) {
+      queryFieldsArray.forEach((element: any) => {
+        const filter: any = {
+          ConjuctionClause: ConjuctionClause.AND,
+          FieldID: tableName + '.' + element.FieldName,
+          RelationalOperator: RelationalOperator.EqualTo,
+          ValueType: FilterValueType.Literal,
+          value: element.FieldValue,
+          Sequence: 0,
+          GroupID: 0,
+        };
+        whereClause.Filters.push(filter);
+      });
+    }
+    whereClause.FilterLogic = '1';
+    return whereClause;
+  }
+
+  /**
+   * Binds the where clause for deleting records by table and primary key
+   * @param tableName The name of the table from which to delete records
+   * @param primaryKey The name of the primary key field
+   * @param primaryKeyValue The value of the primary key
+   * @returns The bound where clause for delete operation using table and primary key
+   */
+  bindWhereClauseForDeleteByTable(
+    tableName: string,
+    primaryKey: string,
+    primaryKeyValue: string
+  ) {
+    const whereClause = new APIFilterCriteria();
+    whereClause.Filters = [];
+    const filter: any = {
+      ConjuctionClause: ConjuctionClause.AND,
+      FieldID: tableName + '.' + primaryKey,
+      RelationalOperator: RelationalOperator.EqualTo,
+      ValueType: FilterValueType.Literal,
+      value: primaryKeyValue,
+      Sequence: 0,
+      GroupID: 0,
+    };
+    whereClause.Filters.push(filter);
+    whereClause.FilterLogic = '1';
+    return whereClause;
+  }
+
+  /**
+   * Binds the where clause for deleting records using IN operator by table
+   * @param tableName The name of the table from which to delete records
+   * @param primaryKey The name of the primary key field
+   * @param values The array of values for the IN operator
+   * @returns The bound where clause for delete operation using IN operator and table
+   */
+  bindWhereClauseForDeleteUsingInOperatorByTable(
+    tableName: string,
+    primaryKey: string,
+    values: []
+  ) {
+    const appobj = getAppObjectFromSystemDBTableName(tableName);
+    if (appobj?.CRUDAppObjectId !== null) {
+      const crudAppObj = getAppObject(appobj.CRUDAppObjectId);
+      if (crudAppObj) {
+        tableName = crudAppObj.SystemDBTableName;
+      }
+    }
+    const whereClause = new APIFilterCriteria();
+    whereClause.Filters = [];
+    const filter: any = {
+      ConjuctionClause: ConjuctionClause.AND,
+      FieldID: tableName + '.' + primaryKey,
+      RelationalOperator: RelationalOperator.IN,
+      ValueType: FilterValueType.Literal,
+      value: values.join(','),
+      Sequence: 0,
+      GroupID: 0,
+    };
+    whereClause.Filters.push(filter);
+    whereClause.FilterLogic = '1';
+    return whereClause;
+  }
+
+  /**
+   * Binds the where clause for updating records in a grid
+   * @param Fields The fields to bind the where clause
+   * @param value The value to match in the where clause
+   * @param fieldName The field name to match in the where clause
+   * @param crudTableName The CRUD table name for the where clause
+   * @returns The bound where clause for update operation in a grid
+   */
+  bindWhereClauseForUpdateGrid(
+    Fields: any,
+    value: any,
+    fieldName: string,
+    crudTableName: string
+  ) {
+    return this.bindWhereClause(Fields, value, fieldName, crudTableName);
+  }
+}

package/src/lib/tab-core-utility/app/helpers/screen/forms.helpers.ts

@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable } from '@angular/core';
+
+@Injectable({ providedIn: 'root' })
+export class FormDataHelper {
+
+  /**
+ * Sets form data based on the provided data object.
+ * @param data$ An Observable emitting the data object containing form data.
+ * @returns An Observable emitting an object containing the modified form data.
+ */
+  setFormData(data: any) {
+    const objNew: any = {};
+    if (!!data && !!data.Result) {
+      Object.entries(data.Result[0]).forEach(([key, value]) => {
+        if (key !== undefined) {
+          if (typeof value === 'number') {
+            value = value.toString();
+          }
+          if (key == 'Logo') {
+            if (value !== '' && value !== null && value !== undefined) {
+              // Additional handling can be added here if necessary
+            }
+          } else {
+            objNew[key] = value;
+          }
+        }
+      });
+    }
+    return objNew;
+  }
+}

package/src/lib/tab-core-utility/app/helpers/screen/grid-column-data.helpers.ts

@@ -0,0 +1,88 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable, inject } from '@angular/core';
+import { of } from 'rxjs';
+import { map } from 'rxjs/operators';
+import { ColumnDetailModel } from '../../interfaces/grid.interface';
+import { GridHelper } from './grid.helpers';
+
+@Injectable({ providedIn: 'root' })
+export class GridColumnDataHelper {
+  private readonly gridHelper = inject(GridHelper);
+
+  /**
+   * Retrieves column data based on the provided fields.
+   * @param fields The fields to generate column data from.
+   * @returns An Observable emitting an array of column data.
+   */
+  getColumnData(fields: any) {
+    return of(fields).pipe(
+      map((fields: any[]) => {
+        return fields.map((field) => this.mapToColumnDetailModel(field));
+      })
+    );
+  }
+
+  /**
+   * Maps field data to a ColumnDetailModel.
+   * @param field The field data to map.
+   * @returns The mapped ColumnDetailModel.
+   */
+  private mapToColumnDetailModel(field: any): ColumnDetailModel {
+    const columnD: ColumnDetailModel = {
+      text: field?.Field?.DisplayName,
+      dataField: field?.Field?.FieldName,
+      columntype: this.gridHelper.getColumnType(
+        field?.Field?.FieldType?.DataType
+      ),
+      appFieldId: field?.Field?.ID,
+      seq: field?.SeqNo,
+      isPrimaryKey: field?.Field?.IsPrimaryKey,
+      SystemDBFieldName: field?.Field?.SystemDBFieldName,
+    };
+
+    if (field?.FieldType == 2) {
+      columnD.dataField = field?.LookupDetails?.replaceAll('.', '_');
+      columnD.dataField = field?.FieldDetails?.replaceAll('.', '_');
+    }
+
+    if (field && field?.Field_GridAttributes) {
+      const attr = JSON.parse(field?.Field_GridAttributes);
+      Object.assign(columnD, attr);
+      if (!!attr.cellsrenderer && attr.cellsrenderer !== '') {
+        columnD.cellsrenderer = this.getRendererValue(attr.cellsrenderer);
+      }
+    }
+
+    if (field && field?.Field?.LookUpDetails) {
+      columnD.LookUpDetails = field?.Field?.LookUpDetails;
+      columnD.dropDownLookup = field?.Field?.dropDownData;
+    }
+
+    return columnD;
+  }
+
+  /**
+   * Retrieves the renderer value based on the provided key.
+   * @param key The key to retrieve the renderer value for.
+   * @returns The renderer value.
+   */
+  private getRendererValue(key: string) {
+    return key && key === 'LINKRENDERER' ? this.rowLinkRenderer : null;
+  }
+
+  /**
+   * Renderer function for rendering row links.
+   * @param row The row number.
+   * @param column The column information.
+   * @param value The value to render.
+   * @returns The HTML string for rendering the row link.
+   */
+  private rowLinkRenderer = (
+    row: number,
+    column: any,
+    value: string
+  ): string => {
+    return `&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a data-row='${row}' style='cursor:pointer;' column-name='${column}' action='redirect' class='Link_click' >${value}</a>`;
+  };
+}

package/src/lib/tab-core-utility/app/helpers/screen/grid.helpers.ts

@@ -0,0 +1,113 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Injectable } from '@angular/core';
+import { AppObject } from '../../models/app-object.class';
+import { getDsqIDFromQueryName } from '../../utils/tab-app.util';
+import { of } from 'rxjs';
+import { Common } from '../../constants/common';
+import { JqWidghtModel } from '../../interfaces/grid.interface';
+
+@Injectable({ providedIn: 'root' })
+export class GridHelper {
+  /**
+   * Generates a grid schema for the master app object.
+   * @param masterAppObj The master app object.
+   * @param dsqID The data source query ID.
+   * @returns The generated grid schema.
+   */
+  generateGridSchema(masterAppObj: AppObject, dsqID: any) {
+    const schema = {
+      label: masterAppObj?.SystemDBTableName,
+      type: 'customGrid',
+      key: masterAppObj?.SystemDBTableName,
+      input: true,
+      redrawOn: masterAppObj?.SystemDBTableName,
+      'customOptions.dataSourceQueryId': dsqID,
+    };
+    return schema;
+  }
+
+  /**
+   * Generates a grid schema for the child relationship.
+   * @param childRel The child relationship.
+   * @param masterAppObj The master app object.
+   * @returns The generated child grid schema.
+   */
+  generateChildGridSchema(childRel: any, masterAppObj: AppObject) {
+    const dsqNameString =
+      'FK_' +
+      childRel.childDetails.LookupObject +
+      '_' +
+      masterAppObj.SystemDBTableName;
+    const dsqObject = getDsqIDFromQueryName(
+      childRel.childDetails.LookupObject,
+      dsqNameString
+    );
+    if (dsqObject) {
+      return {
+        label: childRel?.childDetails?.LookupObject,
+        type: 'customGrid',
+        key: childRel?.childDetails?.LookupObject,
+        input: true,
+        redrawOn: masterAppObj?.SystemDBTableName,
+        'customOptions.dataSourceQueryId': dsqObject ? dsqObject.ID : '',
+        logic: [
+          {
+            name: 'Update Fields',
+            trigger: {
+              type: 'javascript',
+              javascript: 'result=true;',
+            },
+            actions: [
+              {
+                name:
+                  'Refresh ' + childRel?.childDetails?.LookupObject + ' Grid',
+                type: 'property',
+                property: {
+                  label: 'parameters',
+                  value: 'customOptions.parameters',
+                  type: 'string',
+                },
+                text: '{{data.' + masterAppObj?.SystemDBTableName + '}}',
+              },
+            ],
+          },
+        ],
+      };
+    }
+    return of({});
+  }
+
+  /**
+   * Retrieves the default grid configuration.
+   * @returns The default grid configuration.
+   */
+  getDefaultGridConfiguration(): JqWidghtModel | null {
+    const tabData: any = Common.tabJson;
+    if (tabData) {
+      const configuration = tabData?.AppConfigurations.find(
+        (c: any) => c.Setting_Key === 'GridConfig'
+      );
+      if (configuration) {
+        return JSON.parse(configuration.Value);
+      }
+    }
+    return null;
+  }
+
+  /**
+   * Determines the column type based on the data type.
+   * @param dataType The data type.
+   * @returns The column type.
+   */
+  getColumnType(dataType: number): string {
+    if (dataType === 1 || (dataType >= 7 && dataType === 15)) return 'string';
+    else if (dataType === 2 || dataType === 4 || dataType === 16)
+      return 'number';
+    else if (dataType === 3) return 'boolean';
+    else if (dataType === 4 || (dataType >= 7 && dataType <= 15))
+      return 'string';
+    else if (dataType === 5) return 'date';
+    else if (dataType === 6) return 'dateTime';
+    else return 'string';
+  }
+}

package/src/lib/tab-core-utility/app/helpers/screen/media-upload.helpers.ts

@@ -0,0 +1,74 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable, inject } from '@angular/core';
+import { ApiService } from '../../../core/http-client/api.service';
+import { getHeaders } from '../../utils/req-res.util';
+import { Observable, of } from 'rxjs';
+import { API } from '../../constants/api-constants';
+@Injectable({ providedIn: 'root' })
+export class MediaUploadHelper {
+  private readonly apiService = inject(ApiService);
+
+  /**
+   * Uploads media object to the server.
+   * @param mediaObject The media object to upload.
+   * @returns An Observable that emits the response from the server.
+   */
+  uploadMediaFile(mediaObject: any): Observable<any> {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(`${API.fileUpload}`, mediaObject, headers);
+    }
+    return of(null);
+  }
+
+  /**
+   * Retrieves a file from the server by its media ID.
+   * @param mediaId The ID of the media file to retrieve.
+   * @returns An Observable that emits the file as a Blob.
+   */
+  getFileByMediaId(mediaId: number, params?: any): Observable<Blob> {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.getBlob(`${API.getMediaFile}?mediaId=${mediaId}`, params, headers);
+    }
+    return of();
+  }
+
+  /**
+   * Downloads all files from the given URL.
+   * @param endPointName The URL to download files from.
+   * @returns An Observable that emits the downloaded files as a Blob.
+   */
+  downloadAllFiles(endPointName: any): Observable<Blob> {
+    return this.apiService.getBlob(endPointName);
+  }
+
+  /**
+   * Downloads PDF files from the given URL.
+   * @param endPointName The URL to download PDF files from.
+   * @param data The data to send along with the request.
+   * @returns An Observable that emits the downloaded PDF files as a Blob.
+   */
+  downloadPdfFiles(endPointName: any, data: any): Observable<Blob> {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.postBlob(endPointName, data, headers);
+    }
+    return of();
+  }
+
+  /**
+   * Retrieves an image from the server by its media ID.
+   * @param mediaId The ID of the media file to retrieve.
+   * @returns An Observable that emits the image as a Blob.
+   */
+  getImageByMediaId(mediaId: any, params?: any): Observable<Blob> {
+    const headers = getHeaders();
+    if (headers) {
+      const endPointName = `${API.getImage}?mediaId=${mediaId}`;
+      return this.apiService.get<Blob>(endPointName, params, headers);
+    }
+    return of();
+  }
+}

package/src/lib/tab-core-utility/app/helpers/screen/plugin.helpers.ts

@@ -0,0 +1,52 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable, inject } from '@angular/core';
+import { Observable, of } from 'rxjs';
+import { ApiService } from '../../../core/http-client/api.service';
+import { getHeaders } from '../../utils/req-res.util';
+import { API } from '../../constants/api-constants';
+
+
+@Injectable({ providedIn: 'root' })
+export class PluginHelper {
+  private readonly apiService = inject(ApiService);
+
+  /**
+    * Uploads a plugin object to the server.
+    * @param pluginObject The plugin object to upload.
+    * @returns An Observable emitting the response from the server.
+    */
+  uploadPlugin(pluginObject: any): Observable<any> {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(`${API.pluginUpload}`, pluginObject, headers);
+    }
+    return of(null);
+  }
+
+  /**
+   * Retrieves a file from the server by its ID.
+   * @param Id The ID of the file to retrieve.
+   * @returns An Observable emitting the file as a Blob.
+   */
+  getFile(Id: number, params?: any): Observable<Blob> {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.getBlob(`${API.getFile}?Id=${Id}`, params, headers);
+    }
+    return of();
+  }
+
+  /**
+   * Retrieves all plugins by their type from the server.
+   * @param pluginType The type of plugins to retrieve.
+   * @returns An Observable emitting the response from the server.
+   */
+  getAll(pluginType: number, params?: any): Observable<any> {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.get(`${API.getAllPluginByType}?PluginTypeId=${pluginType}`, params, headers);
+    }
+    return of();
+  }
+}