@techextensor/tab-core-utility 2.2.11 → 2.2.14

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

@@ -0,0 +1,63 @@
+import { AppObject } from '../../models/app-object.class';
+import { JqWidghtModel } from '../../interfaces/grid.interface';
+import * as i0 from "@angular/core";
+export declare 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): {
+        label: any;
+        type: string;
+        key: any;
+        input: boolean;
+        redrawOn: any;
+        'customOptions.dataSourceQueryId': any;
+    };
+    /**
+     * 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): import("rxjs").Observable<{}> | {
+        label: any;
+        type: string;
+        key: any;
+        input: boolean;
+        redrawOn: any;
+        'customOptions.dataSourceQueryId': any;
+        logic: {
+            name: string;
+            trigger: {
+                type: string;
+                javascript: string;
+            };
+            actions: {
+                name: string;
+                type: string;
+                property: {
+                    label: string;
+                    value: string;
+                    type: string;
+                };
+                text: string;
+            }[];
+        }[];
+    };
+    /**
+     * Retrieves the default grid configuration.
+     * @returns The default grid configuration.
+     */
+    getDefaultGridConfiguration(): JqWidghtModel | null;
+    /**
+     * Determines the column type based on the data type.
+     * @param dataType The data type.
+     * @returns The column type.
+     */
+    getColumnType(dataType: number): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GridHelper, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<GridHelper>;
+}

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

@@ -0,0 +1,38 @@
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare class MediaUploadHelper {
+    private readonly 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MediaUploadHelper, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MediaUploadHelper>;
+}

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

@@ -0,0 +1,25 @@
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare class PluginHelper {
+    private readonly 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PluginHelper, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PluginHelper>;
+}

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

@@ -0,0 +1,11 @@
+import * as i0 from "@angular/core";
+export declare class ScreenHelper {
+    /**
+     * Retrieves screen data based on the provided screen ID.
+     * @param screenId The ID of the screen to retrieve.
+     * @returns The screen data if found, otherwise null.
+     */
+    getScreen(screenId: string): any;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ScreenHelper, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ScreenHelper>;
+}

package/lib/tab-core-utility/app/interfaces/grid.interface.d.ts

@@ -0,0 +1,110 @@
+export interface JqWidghtModel {
+    width?: number | any;
+    height?: number | any;
+    source?: SourceModel;
+    columns?: Array<ColumnDetailModel>;
+    isPageable?: boolean;
+    isAutoheight?: boolean;
+    isSortable?: boolean;
+    selectionmode?: string;
+    columngroups?: Array<ColumngroupModel>;
+    isAltRow?: boolean;
+    isenabletooltips?: boolean;
+    iseditable?: boolean;
+    sourceId?: string;
+    typeOfData?: string;
+    actualData?: Array<any>;
+    dataField?: Array<DataFieldsModel>;
+    actionArray?: Array<ActionModel>;
+    isShowToolbar?: boolean;
+    isShowStatusBar?: boolean;
+    actionsIn?: string;
+    isFilterable?: boolean;
+    isSortbackGroungColor?: boolean;
+    isautoshowfiltericon?: boolean;
+    isshowfilterrow?: boolean;
+    pagermode?: string;
+    isGroupable?: boolean;
+    isRowlevelEdit?: boolean;
+    isRowlevelDelete?: boolean;
+    isRowlevelView?: boolean;
+    primaryKeycolumnName?: string;
+    gridId?: string;
+    id?: string;
+    groups?: any;
+    groupColumns?: string;
+    gridColumnArr?: Array<string> | any;
+    theme?: string;
+    pagesizeoptions?: string;
+    defaultPageSize?: string;
+    currentScreenId?: string;
+    customNavigate?: string;
+    gridName?: string;
+    gridState?: string | any;
+    iscolumnsreorder?: boolean;
+    isStateB?: boolean;
+    addScreenId?: string;
+    editScreenId?: string;
+    viewScreenId?: string;
+}
+export interface SourceModel {
+    datatype?: string;
+    datafields?: Array<DataFieldsModel>;
+    id?: string;
+    localdata?: any;
+    pagesize?: string;
+}
+export interface DataFieldsModel {
+    name?: string;
+    type?: string;
+    seq?: number;
+}
+export interface ColumnDetailModel {
+    text?: string;
+    dataField?: string;
+    width?: string;
+    cellsalign?: string;
+    cellsformat?: string;
+    columnType?: string;
+    columnGroup?: string;
+    editable?: boolean;
+    buttonclick?: any;
+    renderer?: any;
+    columntype?: string;
+    filtertype?: string;
+    seq?: number;
+    align?: string;
+    sortable?: boolean;
+    hidden?: boolean;
+    filterable?: boolean;
+    cellsrenderer?: any;
+    filterParameter?: string;
+    addScreenId?: string;
+    editScreenId?: string;
+    viewScreenId?: string;
+    appFieldId?: string;
+    isPrimaryKey?: boolean;
+    LookUpDetails?: any;
+    dropDownLookup?: any;
+    SystemDBFieldName?: any;
+}
+export interface ColumngroupModel {
+    text?: string;
+    align?: string;
+    name?: string;
+}
+export interface ActionModel {
+    name?: string;
+    imgSrc?: string;
+    buttonWidth?: number;
+    buttonHeight?: number;
+    buttonValue?: string;
+    imgPosition?: string;
+    textPosition?: string;
+    textImageRelation?: string;
+}
+export interface ColumnLevelActions {
+    name?: string;
+    rowId?: number;
+    valueToShow?: string;
+}

package/lib/tab-core-utility/app/interfaces/orgInfo.interface.d.ts

@@ -0,0 +1,31 @@
+import { RecordInfo } from "./common-api.interface";
+export interface OrgInfoResponse {
+    RequestId: string;
+    IsSuccess: boolean;
+    Result: Result[];
+    StatusCode: string;
+    RecordAffectted: number;
+    TotalRecords: number;
+    TotalExecutionTime: number;
+    Log: string[];
+    Errors: any[];
+}
+export interface Result {
+    RecordInfo: RecordInfo;
+    LocaleSettings: string;
+    OrganizationName: string;
+    ID: string;
+    PrimaryContact: any;
+    Address: any;
+}
+export interface Info {
+    FavIcon: string;
+    Org_Brand_Color: string;
+    Org_Logo: string;
+    Org_Menu_Logo: string;
+    ShowSignUp: string;
+    TagLine: string;
+    profileScreenID: string;
+    workFlowName: string;
+    OrganizationName: string;
+}

package/lib/tab-core-utility/app/interfaces/schema.interface.d.ts

@@ -0,0 +1,11 @@
+export interface SchemaResponse {
+    RequestId: string;
+    IsSuccess: boolean;
+    Result: string;
+    StatusCode: string;
+    RecordAffectted: number;
+    TotalRecords: number;
+    TotalExecutionTime: number;
+    Log: any[];
+    Errors: any[];
+}

package/lib/tab-core-utility/app/models/api-query.class.d.ts

@@ -0,0 +1,69 @@
+import { ConjuctionClause, RelationalOperator, FilterValueType, SortSequence } from '../enums/dsq.enum';
+import { JoinType, QueryType } from '../enums/query.enum';
+import { LookUpDetails } from './data-source-queries.class';
+export declare class APIQuery {
+    QueryObjectID: string | any;
+    QueryType: QueryType | any;
+    Joins: JoinDetails[];
+    WhereClause: APIFilterCriteria;
+    constructor();
+}
+export declare class APIInsertQuery extends APIQuery {
+    Values: APIValueSets[];
+}
+export declare class APIUpdateQuery extends APIQuery {
+    Values: APIValueSets[];
+}
+export declare class APIDeleteQuery extends APIQuery {
+}
+export declare class APISelectQuery extends APIQuery {
+    ResultField_AppfieldIds: string[];
+    Sort: APISort[];
+    Distinct: boolean;
+    NoLock: boolean;
+    TopCount?: number;
+    LoadLookUpValues: boolean;
+}
+export declare class JoinDetails {
+    JoinType: JoinType | any;
+    Relationship: ChildRelationShip | any;
+}
+export declare class ChildRelationShip {
+    RelSourceObjectID: string | any;
+    RelSourceFieldID: string | any;
+    RelTargetObjectID: string | any;
+    RelTargetFieldID: string | any;
+    LocalId: string;
+    childDetails: LookUpDetails;
+}
+export declare class APIFilterCriteria {
+    Filters: APIFilter[] | any;
+    FilterLogic: string | any;
+}
+export declare class APIFilter {
+    ConjuctionClause: ConjuctionClause | any;
+    FieldID: string | any;
+    RelationalOperator: RelationalOperator | any;
+    ValueType: FilterValueType | any;
+    value: string | any;
+    Sequence: number | any;
+    GroupID: number | any;
+    parameterName: string | any;
+    Value: string | any;
+}
+export declare class APIValueSets {
+    AppFieldID: string | any;
+    Value: string | any;
+}
+export declare class APISort {
+    ID: string | any;
+    FieldID: string | any;
+    SortSequence: SortSequence | any;
+    Sequence: number | any;
+}
+export declare class APIParameters {
+    ID: string | any;
+    ParameterName: string | any;
+    DataSourceQueryID: string | any;
+    MappingFieldName: string | any;
+}

package/lib/tab-core-utility/app/models/app-object.class.d.ts

@@ -0,0 +1,74 @@
+import { ObjectCreationType } from '../enums/dsq.enum';
+import { DeploymentStatus } from '../enums/permission.enum';
+import { ChildRelationShip } from './api-query.class';
+import { Configurations, EmailTemplate, Profile, Resources, Role } from './common.class';
+import { AppFields, DataSourceQueries } from './data-source-queries.class';
+export declare class Application {
+    ID: string | any;
+    AppName: string | any;
+    DisplayName: string | any;
+    PlatformVersion: string | any;
+    AppVersion: string | any;
+    Description: string | any;
+    AppObjects: AppObject[];
+    AppScreens: AppScreen[];
+    AppMenus: AppMenu[];
+    AppConfigurations: Configurations[];
+    Roles?: Role[];
+    Profiles?: Profile[];
+    WorkFlows: any[];
+    Plugins: any[];
+}
+export declare class AppObject {
+    ID: string | any;
+    ObjectName: string | any;
+    DisplayName: string | any;
+    Description: string | any;
+    EnableTracking: boolean | false;
+    AllowSearchable: boolean | false;
+    CreationType: ObjectCreationType | any;
+    AllowReports: boolean | false;
+    AllowActivities: boolean | false;
+    AllowSharing: boolean | false;
+    DeploymentStatus: DeploymentStatus | any;
+    Fields: AppFields[];
+    ChildRelationShips: ChildRelationShip[];
+    DataSourceQueries: DataSourceQueries[];
+    SystemDBTableName: string | any;
+    AccessList: ObjectAccess[];
+    EmailTemplates: EmailTemplate[];
+    Resources: Resources[];
+    IsSystem: boolean | false;
+    IsVisible: boolean | false;
+    IsDeprecated: boolean | false;
+    ObjectID_Tosave: string | any;
+}
+export declare class ObjectAccess {
+    ID: string;
+    ProfileID: Profile;
+    IsVisible: boolean;
+    IsReadOnly: boolean;
+    CanCreate: boolean;
+    CanEdit: boolean;
+    CanDelete: boolean;
+}
+export declare class AppMenu {
+    ID: string | any;
+    MenuName: string | any;
+    DisplayName: string | any;
+    ScreenID: string | any;
+    ShortCut: string | any;
+    Icon: string | any;
+    ParentID?: number;
+    Sequence?: number;
+    Url: string | any;
+}
+export declare class AppScreen {
+    ID: string | any;
+    Name: string | any;
+    Description: string | any;
+    DataSourceQuery: DataSourceQueries | any;
+    Container: string | any;
+    ScreenType: number | any;
+    DataSourceQueryID: string | any;
+}

package/lib/tab-core-utility/app/models/common.class.d.ts

@@ -0,0 +1,24 @@
+export declare class Role {
+    ID: string | any;
+    RoleName: string | any;
+    Description: string | any;
+    ParentRole: Role | any;
+}
+export declare class Configurations {
+    ID: string | any;
+    Setting_Key: string | any;
+    Value: string | any;
+}
+export declare class Profile {
+    ID: string;
+    ProfileName: string;
+    Description: string;
+}
+export declare class Resources {
+    ID: string;
+    Value: string;
+}
+export declare class EmailTemplate {
+    ID: string;
+    Template: string;
+}

package/lib/tab-core-utility/app/models/data-source-queries.class.d.ts

@@ -0,0 +1,95 @@
+import { DataTypes } from '../enums/controllers.enum';
+import { SortSequence, ConjuctionClause, RelationalOperator, ObjectCreationType } from '../enums/dsq.enum';
+import { AppObject } from './app-object.class';
+import { Profile } from './common.class';
+export declare class DataSourceQueries {
+    ID: string;
+    ObjectID: AppObject;
+    ObjectID_Tosave: string;
+    QueryName: string;
+    DisplayName: string;
+    Fields: DataSourceQueries_Fields[];
+    Filters: FilterCriteria;
+    Sort: Sort[];
+    Parameters: Parameters[];
+}
+export declare class DataSourceQueries_Fields {
+    Field: AppFields;
+    SeqNo: number;
+    Field_GridAttributes: string;
+    LookupDetails: string;
+}
+export declare class Parameters {
+    ID: string;
+    ParameterName: string;
+    DataSourceQueryID: string;
+    MappingFieldName: string;
+}
+export declare class Sort {
+    ID: string;
+    Field: AppFields;
+    SortSequence: SortSequence;
+    Sequence: number;
+}
+export declare class FilterCriteria {
+    Filters: Filter;
+    FilterLogic: string;
+}
+export declare class Filter {
+    ID: string;
+    ConjuctionClause: ConjuctionClause;
+    Field: string;
+    RelationalOperator: RelationalOperator;
+    ValueType: any;
+    value: string;
+    Sequence: number;
+    GroupID: number;
+}
+export declare class AppFields {
+    ID: string;
+    ObjectID: AppObject;
+    FieldName: string;
+    DisplayName: string;
+    FieldType: FieldType;
+    Description: string;
+    CreationType: ObjectCreationType;
+    IsRequired: boolean;
+    IsUnique: boolean;
+    IsSearchable: boolean;
+    IsConfidential: boolean;
+    SystemDBFieldName: string;
+    IsSystem: boolean;
+    IsVisible: boolean;
+    IsDeprecated: boolean;
+    LookUpDetails: LookUpDetails;
+    AccessList: FieldAccess[];
+    Data: string;
+    IsPrimaryKey: boolean;
+    Field: AppFields;
+}
+export declare class FieldType {
+    DataType: DataTypes;
+    RelationalOperator: RelationalOperator[];
+}
+export declare class LookUpDetails {
+    LookupObject: string;
+    LookupField: string;
+    DisplayField: string;
+}
+export declare class FieldAccess {
+    ID: string;
+    ProfileID: Profile;
+    IsVisible: boolean;
+    IsReadOnly: boolean;
+}
+export declare class UpdateQueryParameter {
+    FieldName: string;
+    FieldValue: string | number;
+}
+export declare class ScreenParameter {
+    event: any;
+    formJson: any;
+    formIOObject: any;
+    serviceList: any;
+    dailogRef: any;
+}

package/lib/tab-core-utility/app/utils/filter.util.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Returns the filter value type as a string.
+ * @param type The filter value type.
+ * @returns The filter value type as a string.
+ */
+export declare function getFilterValueTypeInString(type: number): string;
+/**
+ * Returns the conjunction clause name based on the type.
+ * @param type The conjunction clause type.
+ * @returns The conjunction clause name.
+ */
+export declare function getConjuctionClauseName(type: number): string;
+/**
+ * Returns the conjunction clause value based on the type.
+ * @param type The conjunction clause name.
+ * @returns The conjunction clause value.
+ */
+export declare function getConjuctionClause(type: string): number;
+/**
+ * Returns the filter type based on the element.
+ * @param element The filter element.
+ * @returns The filter type.
+ */
+export declare function getFilterType(element: any): string;
+/**
+ * Returns the filter value type as an integer.
+ * @param type The filter value type.
+ * @returns The filter value type as an integer.
+ */
+export declare function getFilterValueTypeInInt(type: string): string;

package/lib/tab-core-utility/app/utils/form-builder.util.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Returns the form builder type based on the data type.
+ * @param dataType The data type.
+ * @returns The form builder type.
+ */
+export declare function getFormBuilderType(dataType: number): string;
+/**
+ * Returns the field type based on the data type and whether it's a lookup.
+ * @param dataType The data type.
+ * @param isLookup Indicates if it's a lookup field.
+ * @returns The field type.
+ */
+export declare function getFieldsType(dataType: number, isLookup: any): string;

package/lib/tab-core-utility/app/utils/json.util.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Validates if a string is a valid JSON.
+ * @param str The string to validate.
+ * @returns True if the string is a valid JSON, false otherwise.
+ */
+export declare function validateJSON(str: string): boolean;
+/**
+ * Creates dynamic data based on the input object
+ * @param obj The input object to create dynamic data from
+ * @returns The formatted array
+ */
+export declare function createDynamicData(obj: any): {
+    AppFieldID: string;
+    Value: any;
+}[] | null;
+/**
+ * Removes blank values from the input object
+ * @param dataObj The input object to remove blank values from
+ */
+export declare function removeBlankValue(dataObj: any): void;
+/**
+ * Removes blank array keys from the input object
+ * @param dataObj The input object to remove blank array keys from
+ */
+export declare function removeBlankArrayKeys(dataObj: any): void;

package/lib/tab-core-utility/app/utils/operators.util.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Converts a relational operator value to a number.
+ * @param dataType The relational operator value as a string.
+ * @returns The relational operator value as a number.
+ */
+export declare function getRelationalOperatorValueToNumber(dataType: string): number;
+/**
+ * Converts a relational operator value to a string.
+ * @param dataType The relational operator value as a number.
+ * @returns The relational operator value as a string.
+ */
+export declare function getRelationalOperatorValueToString(dataType: number): string;
+/**
+ * Returns a list of operators for the query builder based on the data type.
+ * @param dataType The data type.
+ * @returns A list of operators.
+ */
+export declare function getOperatorListForQueryBuilder(dataType: any): {
+    value: string;
+    key: string;
+}[];