@techextensor/tab-core-utility 2.1.5 → 2.1.7

package/src/lib/tab-core-utility/app/crud/tab-get.service.ts

@@ -0,0 +1,160 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { HttpHeaders } from "@angular/common/http";
+import { Injectable, inject } from "@angular/core";
+import { ApiService } from "../../core/http-client/api.service";
+import { DSQHelper } from "../helpers/common/dsq.helpers";
+import { getHeaders } from "../utils/req-res.util";
+import { API } from "../constants/api-constants";
+import { getAppObject } from "../utils/tab-app.util";
+import { Common } from "../constants/common";
+import { APISelectQuery } from "../models/api-query.class";
+import { FilterValueType } from "../enums/dsq.enum";
+import { QueryType } from "../enums/query.enum";
+
+
+@Injectable({ providedIn: 'root' })
+export class TabGetService {
+  private readonly apiService = inject(ApiService);
+  private readonly dsqHelper = inject(DSQHelper);
+
+  /**
+   * Execute RAW DSQ with Name
+   * @param data - Object containing AppObjectName and DSQName
+   * @returns Response from the API
+   */
+  executeRAWDSQWithName(data: any): any {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(
+        `${API.getDSQ}/${data.AppObjectName}/${data.DSQName}`,
+        data,
+        headers
+      );
+    }
+    return null;
+  }
+
+  /**
+   * Get Record
+   * @param params - Parameters for the request
+   * @returns Response from the API
+   */
+  getRecord(params: any): any {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.get(`${API.getrecord}`, params, headers);
+    }
+    return null;
+  }
+
+  /**
+   * Execute Raw SQL
+   * @param data - Data for the request
+   * @returns Response from the API
+   */
+  executeRawSql(data: any): any {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(
+        `${API.rawSQL}${data}`,
+        '',
+        headers
+      );
+    }
+    return null;
+  }
+
+  /**
+   * Get History
+   * @param appObjectId - ID of the application object
+   * @param recordIds - Array of record IDs
+   * @returns Response from the API
+   */
+  getHistory(appObjectId: string, recordIds: string[]): any {
+    const data: any = {};
+    if (appObjectId && recordIds) {
+      const appObjectName = getAppObject(appObjectId)?.ObjectName;
+      const headers = getHeaders();
+      if (appObjectName && headers) {
+        data.ObjectName = appObjectName;
+        data.RecordIds = recordIds;
+        return this.apiService.post(
+          `${API.getHistory}`,
+          data,
+          headers
+        );
+      }
+    }
+    return null;
+  }
+
+  /**
+   * Change Password
+   * @param data - Data for changing password
+   * @returns Response from the API
+   */
+  changePassword(data: any): any {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(
+        `${API.changePassword}`,
+        data,
+        headers
+      );
+    }
+  }
+
+  /**
+   * Reset Password
+   * @param data - Data for resetting password
+   * @returns Response from the API
+   */
+  resetPassword(data: any): any {
+    const headers = new HttpHeaders({
+      'Content-Type': 'application/json',
+      applicationCode: Common.applicationCode,
+    });
+    return this.apiService.post(
+      `${API.restpassword}`,
+      data,
+      headers
+    );
+  }
+
+  /**
+   * PMJAY Import
+   * @param data - Data for PMJAY import
+   * @returns Response from the API
+   */
+  pmjayImport(data: any): any {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(
+        `${API.pmjayImport}`,
+        data,
+        headers
+      );
+    }
+  }
+
+  /**
+   * Executes a select query with optional parameters
+   * @param data - The select query data
+   * @param parameters - Optional parameters to be applied to the query
+   * @returns Result of the select query execution
+   */
+  selectExecutor(data: APISelectQuery, parameters?: any): any {
+    if (parameters && Object.keys(parameters).length) {
+      data?.WhereClause?.Filters.forEach((element: any) => {
+        if (
+          element.ValueType === FilterValueType.Parameter &&
+          parameters[element.FieldID]
+        ) {
+          element.Value = parameters[element.FieldID];
+        }
+      });
+    }
+    return this.dsqHelper.executeQuery(data, QueryType.Select);
+  }
+}

package/src/lib/tab-core-utility/app/crud/tab-insert.service.ts

@@ -0,0 +1,75 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Injectable, inject } from '@angular/core';
+import { DSQHelper } from '../helpers/common/dsq.helpers';
+import { ScreenHelper } from '../helpers/screen/screen.helpers';
+import { WhereClauseHelper } from '../helpers/common/where-clause.helpers';
+import { RequestResponseHelper } from '../helpers/common/req-res.helpers';
+import { getAppObject, getDataFromDataSourceQueryID, syncAppObjectFields } from '../utils/tab-app.util';
+import { AppObject, AppScreen } from '../models/app-object.class';
+import { getPrimaryKeyFields, removeMultiplePrimaryKey, removePrimaryKey } from '../utils/req-res.util';
+import { APIFilterCriteria } from '../models/api-query.class';
+import { createDynamicData, removeBlankValue } from '../utils/json.util';
+import { QueryType } from '../enums/query.enum';
+
+
+@Injectable({ providedIn: 'root' })
+export class TabInsertService {
+  private readonly dsqHelper = inject(DSQHelper);
+  private readonly screenHelper = inject(ScreenHelper);
+  private readonly whereClauseHelper = inject(WhereClauseHelper);
+  private readonly requestResponseHelper = inject(RequestResponseHelper);
+
+  /**
+   * Inserts data by screen ID.
+   * @param screenId The ID of the screen.
+   * @param data The data to insert.
+   * @returns An Observable with the insert result.
+   */
+  insertByScreenId(screenId: string, data: any) {
+    const screen: AppScreen = this.screenHelper.getScreen(screenId);
+    const screenDataSource = getDataFromDataSourceQueryID(screen.DataSourceQuery);
+    return this.insertByObjectId(screenDataSource.ObjectID_Tosave, data);
+  }
+
+  /**
+   * Inserts data by object ID.
+   * @param objectId The ID of the object.
+   * @param data The data to insert.
+   * @returns An Observable with the insert result.
+   */
+  insertByObjectId(objectId: string, data: any) {
+    const appObject: AppObject = getAppObject(objectId);
+    return this.prepareInsert(appObject, data);
+  }
+
+  /**
+   * Prepares data for insertion.
+   * @param appObject The app object.
+   * @param data The data to insert.
+   * @returns An Observable with the prepared data.
+   */
+  prepareInsert(appObject: AppObject, data: any) {
+    const crudTableName = appObject.SystemDBTableName;
+    syncAppObjectFields(data.data, appObject);
+    const PrimaryKeyFields = getPrimaryKeyFields(appObject);
+    if (PrimaryKeyFields && PrimaryKeyFields.length === 1) {
+      removePrimaryKey(data.data, PrimaryKeyFields[0]?.FieldName);
+    } else if (PrimaryKeyFields && PrimaryKeyFields.length > 1) {
+      removeMultiplePrimaryKey(data.data, PrimaryKeyFields);
+    }
+    const whereClause: APIFilterCriteria = this.whereClauseHelper.bindWhereClauseForInsert();
+    const dataObj: any = createDynamicData(data.data);
+    removeBlankValue(dataObj);
+    const requestPayload = this.requestResponseHelper.insertPayload(crudTableName, whereClause, dataObj);
+    return this.insert(requestPayload);
+  }
+
+  /**
+   * Inserts data.
+   * @param data The data to insert.
+   * @returns An Observable with the insert result.
+   */
+  insert(data: any) {
+    return this.dsqHelper.executeQuery(data, QueryType.Insert);
+  }
+}

package/src/lib/tab-core-utility/app/crud/tab-update.service.ts

@@ -0,0 +1,105 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable, inject } from "@angular/core";
+import { DSQHelper } from "../helpers/common/dsq.helpers";
+import { ScreenHelper } from "../helpers/screen/screen.helpers";
+import { WhereClauseHelper } from "../helpers/common/where-clause.helpers";
+import { RequestResponseHelper } from "../helpers/common/req-res.helpers";
+import { APIFilterCriteria, APIUpdateQuery } from "../models/api-query.class";
+import { QueryType } from "../enums/query.enum";
+import { getAppObject, getAppObjectFromSystemDBTableName, getDataFromDataSourceQueryID, syncAppObjectFields } from "../utils/tab-app.util";
+import { AppObject, AppScreen } from "../models/app-object.class";
+import { createDynamicData, removeBlankValue } from "../utils/json.util";
+import { getEditRecordId, getPrimaryKeyFields, removeMultiplePrimaryKey, removePrimaryKey } from "../utils/req-res.util";
+import { UpdateQueryParameter } from "../models/data-source-queries.class";
+
+
+@Injectable({ providedIn: 'root' })
+export class TabUpdateService {
+  private readonly dsqHelper = inject(DSQHelper);
+  private readonly screenHelper = inject(ScreenHelper);
+  private readonly whereClauseHelper = inject(WhereClauseHelper);
+  private readonly requestResponseHelper = inject(RequestResponseHelper);
+
+  update(data: APIUpdateQuery) {
+    return this.dsqHelper.executeQuery(data, QueryType.Update);
+  }
+
+  updateUsingDSQ(dsqId: string, data: any, tableName: string, queryFieldsArray?: any) {
+    const appObject: AppObject = getDataFromDataSourceQueryID(dsqId);
+    if (appObject) {
+      if (data && data.data) {
+        const whereClause: APIFilterCriteria = this.whereClauseHelper.bindWhereClauseForUpdate(tableName, queryFieldsArray);
+        let dataObj: any = [];
+        dataObj = createDynamicData(data.data);
+        const requestPayload = this.requestResponseHelper.updateRequestPayload(tableName, whereClause, dataObj);
+        return this.update(requestPayload);
+      }
+    }
+    return null;
+  }
+
+  updateUsingScreenId(screenId: string, data: any, objectIdToSave?: string) {
+    let fields;
+    let appObject: any = AppObject;
+    let crudTableName;
+    if (screenId) {
+      const screen: AppScreen = this.screenHelper.getScreen(screenId);
+      const screenDataSource = getDataFromDataSourceQueryID(screen.DataSourceQuery);
+      fields = screenDataSource.Fields;
+      appObject = getAppObject(screenDataSource.ObjectID_Tosave);
+      crudTableName = appObject.SystemDBTableName;
+      syncAppObjectFields(data.data, appObject);
+    }
+    if (objectIdToSave) {
+      fields = [];
+      appObject = getAppObject(objectIdToSave);
+      appObject.Fields.forEach((element: any) => {
+        fields.push({ Field: element })
+      });
+      crudTableName = appObject.SystemDBTableName;
+      syncAppObjectFields(data.data, appObject);
+    }
+
+    const PrimaryKeyFields: any = getPrimaryKeyFields(appObject);
+    let whereClause: any = APIFilterCriteria;
+    if (appObject) {
+      if (data.data) {
+        const recordId = getEditRecordId(data.data, PrimaryKeyFields[0]?.FieldName);
+        data['recordId'] = recordId;
+
+        if (PrimaryKeyFields && PrimaryKeyFields.length === 1) {
+          removePrimaryKey(data.data, PrimaryKeyFields[0]?.FieldName);
+          whereClause = this.whereClauseHelper.bindWhereClauseForUpdateGrid(fields, data.recordId, PrimaryKeyFields[0].FieldName, crudTableName);
+        } else if (PrimaryKeyFields && PrimaryKeyFields.length > 1) {
+          whereClause = this.whereClauseHelper.bindWhereClauseForMultiplePrimaryKeys(data.data, PrimaryKeyFields, crudTableName);
+          removeMultiplePrimaryKey(data.data, PrimaryKeyFields);
+        }
+        const dataObj: any = createDynamicData(data.data);
+        removeBlankValue(dataObj);
+        const requestPayload = this.requestResponseHelper.updateRequestPayload(crudTableName, whereClause, dataObj);
+        return this.update(requestPayload);
+      }
+    }
+    return null;
+  }
+
+  updateScreen(screenId: string, screenData: any) {
+    const screen: AppScreen = this.screenHelper.getScreen(screenId);
+    if (screen) {
+      const appObject = getAppObjectFromSystemDBTableName('TABMD_AppScreen');
+      if (appObject) {
+        syncAppObjectFields(screenData, appObject);
+      }
+      Object.assign({}, screen, { Container: screenData.Container });
+      const queryFilters: UpdateQueryParameter[] = [];
+      queryFilters.push({ FieldName: 'ID', FieldValue: screenId })
+      const whereClause = this.whereClauseHelper.bindWhereClauseForUpdate('TABMD_AppScreen', queryFilters);
+      const dataObj: any = createDynamicData(screenData);
+      removeBlankValue(dataObj);
+      const requestPayload = this.requestResponseHelper.updateRequestPayload('TABMD_AppScreen', whereClause, dataObj);
+      return this.update(requestPayload);
+    }
+    return null;
+  }
+}

package/src/lib/tab-core-utility/app/crud/tab-workflow.service.ts

@@ -0,0 +1,39 @@
+/* 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";
+
+
+@Injectable({ providedIn: 'root' })
+export class TabWorkflowService {
+  private readonly apiService = inject(ApiService);
+
+  /**
+   * Executes a TAB workflow.
+   * @param endPoint The endpoint for the workflow.
+   * @param data The data to send with the request.
+   * @returns An observable of the workflow execution result.
+   */
+  executeTABWorkflow(endPoint: string, data: string) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(endPoint, data, headers);
+    }
+    return null;
+  }
+
+  /**
+   * Executes an ELSA workflow.
+   * @param endPoint The endpoint for the workflow.
+   * @param data The data to send with the request.
+   * @returns An observable of the workflow execution result.
+   */
+  executeELSAWorkflow(endPoint: string, data: string) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.postWorkflow(endPoint, data, headers);
+    }
+    return null;
+  }
+}

package/src/lib/tab-core-utility/app/enums/controllers.enum.ts

@@ -0,0 +1,24 @@
+export enum DataTypes {
+  AutoNumber = 1,
+  Number = 2,
+  CheckBox = 3,
+  Currency = 4,
+  Date = 5,
+  DateTime = 6,
+  Email = 7,
+  GeoLocation = 8,
+  Percent = 9,
+  PhoneNumber = 10,
+  PickList = 11,
+  PickList_MultiSelect = 12,
+  Text = 13,
+  TextArea = 14,
+  TextArea_RICHEDITOR = 15,
+  URL = 16,
+  UniqueIdentifier = 17,
+  Insert_TimeStamp = 18,
+  Update_TimeStamp = 19,
+  NextNumber = 20,
+  Array = 21,
+  JSON = 22,
+}

package/src/lib/tab-core-utility/app/enums/dsq.enum.ts

@@ -0,0 +1,46 @@
+export enum ConjuctionClause {
+  AND = 1,
+  OR = 2,
+  AND_NOT = 3,
+  OR_NOT = 4,
+}
+
+export enum RelationalOperator {
+  GreaterThan = 1,
+  LessThan = 2,
+  EqualTo = 3,
+  IN = 4,
+  NOTIN = 5,
+  IsNULL = 6,
+  IsNotNULL = 7,
+  NotEqualTo = 8,
+  GreaterThanOREqualTo = 9,
+  LessThanOREqualTo = 10,
+  Contains = 11,
+  NotContains = 12,
+  StartsWith = 13,
+  NotStartsWith = 14,
+  EndsWith = 15,
+  NotEndsWith = 16,
+  Between = 17,
+  NotBetween = 18,
+  SplitContains = 19,
+  NotSplitContains = 20,
+}
+
+export enum FilterValueType {
+  Literal = 1,
+  Parameter = 2,
+  Property = 3,
+  Global = 4,
+}
+
+export enum SortSequence {
+  Asc = 1,
+  Desc = 2,
+}
+
+export enum ObjectCreationType {
+  Standard = 1,
+  Custom = 2,
+}

package/src/lib/tab-core-utility/app/enums/permission.enum.ts

@@ -0,0 +1,18 @@
+export enum AccessType {
+  READ = 'READ',
+  CREATE = 'CREATE',
+  UPDATE = 'UPDATE',
+  DELETE = 'DELETE',
+}
+
+export enum AccessPermission {
+  None = 1,
+  Own = 2,
+  Team = 3,
+  All = 4,
+}
+
+export enum DeploymentStatus {
+  InDevelopment = 1,
+  Deployed = 2,
+}

package/src/lib/tab-core-utility/app/enums/query.enum.ts

@@ -0,0 +1,12 @@
+export enum QueryType {
+  Select,
+  Insert,
+  Update,
+  Delete,
+  Upsert,
+}
+
+export enum JoinType {
+  LeftJoin = 1,
+  RightJoin = 2,
+}

package/src/lib/tab-core-utility/app/enums/workflow.enum.ts

@@ -0,0 +1,35 @@
+export enum WorkFlowTriggerType {
+  EventBased = 1,
+  DateBased = 2,
+}
+
+export enum WorkFlowEventExecution_WorkFlowTriggerEvent {
+  Created = 1,
+  Edited = 2,
+  CreatedOrEdited = 3,
+  Deleted = 4,
+}
+
+export enum WorkFlowEventExecution_WorkFlowTriggerFieldCriteria {
+  WhenAnyFieldIsUpdated = 1,
+  WhenAnySelectedFieldIsUpdated = 2,
+  WhenSelectedAllFieldsAreUpdated = 3,
+}
+
+export enum WorkFlowEventExecution_WorkFlowTriggerOccurence {
+  Everytime = 1,
+  FirstTime = 2,
+}
+
+export enum WorkFlowTimeExecution_DaysRelationalOperator {
+  Before = 1,
+  After = 2,
+}
+
+export enum WorkFlowTimeExecution_ExecutionCycle {
+  Once = 1,
+  Weekly = 2,
+  Monthly = 3,
+  Yearly = 4,
+  Daily = 5,
+}

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

@@ -0,0 +1,65 @@
+/* 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 { API } from '../../constants/api-constants';
+import { LocalStorageService } from '../../../auth/local-storage.service';
+
+@Injectable({ providedIn: 'root' })
+export class AppHelper {
+  private readonly apiService = inject(ApiService);
+  private readonly localStorageService = inject(LocalStorageService);
+
+  /**
+   * Rebuilds the application.
+   * @param data Optional data for rebuilding the application
+   * @returns Result of the rebuild operation
+   */
+  rebuildApp(data?: any) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(API.buildApp, data ? data : {}, headers);
+    }
+    return null;
+  }
+
+  /**
+   * Publishes the application.
+   * @param params Optional parameters for publishing the application
+   * @returns Result of the publish operation
+   */
+  publishApp(params?: any) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.get(API.publishApp, params, headers);
+    }
+    return null;
+  }
+
+  /**
+   * Retrieves screen data.
+   * @param params Optional parameters for retrieving screen data
+   * @returns Screen data
+   */
+  getScreen(params?: any) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.get(API.getScreen, params, headers);
+    }
+    return null;
+  }
+
+  /**
+   * Retrieves schema data.
+   * @param params Optional parameters for retrieving schema data
+   * @returns Subscription for getting schema data
+   */
+  getSchema(params?: any) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.get(API.getSchema, params, headers);
+    }
+    return null;
+  }
+}

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

@@ -0,0 +1,80 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { Injectable, inject } from '@angular/core';
+import { ApiService } from '../../../core/http-client/api.service';
+import { QueryType } from '../../enums/query.enum';
+import { API } from '../../constants/api-constants';
+import { getHeaders } from '../../utils/req-res.util';
+import { getAppObjectFromDataSourceQueryID } from '../../utils/tab-app.util';
+import { AccessPermission, AccessType } from '../../enums/permission.enum';
+
+@Injectable({ providedIn: 'root' })
+export class DSQHelper {
+  private readonly apiService = inject(ApiService);
+
+  /**
+   * Executes a query based on the query type
+   * @param data The data to be executed
+   * @param queryType The type of query to be executed
+   * @returns The result of the query execution
+   */
+  executeQuery(data: any, queryType: QueryType) {
+    switch (queryType) {
+      case QueryType.Insert:
+        return this.execution(data, API.insert);
+      case QueryType.Update:
+        return this.execution(data, API.update);
+      case QueryType.Delete:
+        return this.execution(data, API.delete);
+      case QueryType.Select:
+        return this.execution(data, API.select);
+      default:
+        return null;
+    }
+  }
+
+  /**
+   * Executes an HTTP POST request with the provided data and URL
+   * @param data The data to be sent in the POST request
+   * @param endPointName The URL to send the POST request to
+   * @returns The result of the POST request if headers are available, otherwise null
+   */
+  private execution(data: any, endPointName: string) {
+    const headers = getHeaders();
+    if (headers) {
+      return this.apiService.post(endPointName, data, headers);
+    }
+    return null;
+  }
+
+  /**
+   * Checks if the user has access to the specified object based on roles and access type
+   * @param dsqId The DataSourceQuery ID to check access for
+   * @param accessType The type of access to check (e.g., read, write)
+   * @param roles The roles of the user with IDs
+   * @returns True if the user has access, false otherwise
+   */
+  doesHaveObjectAccess(
+    dsqId: string,
+    accessType: AccessType,
+    roles: [{ ID: string }]
+  ) {
+    const appObject = getAppObjectFromDataSourceQueryID(dsqId);
+
+    if (appObject) {
+      const accessList: any[] = appObject.AccessList.filter((access: any) =>
+        roles.some(
+          (role) =>
+            access.RoleID.toLowerCase() === role.ID.toLowerCase() &&
+            access.IsEnabled
+        )
+      );
+
+      return accessList.some(
+        (access) => access[accessType] === AccessPermission.All
+      );
+    }
+
+    return false;
+  }
+}