@techextensor/tab-core-utility 2.2.133 → 2.2.135

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

@@ -1,8 +1,8 @@
 import { ObjectCreationType } from '../enums/dsq.enum';
-import { DeploymentStatus } from '../enums/permission.enum';
+import { DataAccessSet, 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';
+import { AppFields, DataSourceQueries, FieldAccess } from './data-source-queries.class';
 export declare class Application {
     ID: string | any;
     AppName: string | any;
@@ -45,12 +45,15 @@ export declare class AppObject {
 }
 export declare class ObjectAccess {
     ID: string;
-    ProfileID: Profile;
-    IsVisible: boolean;
-    IsReadOnly: boolean;
-    CanCreate: boolean;
-    CanEdit: boolean;
-    CanDelete: boolean;
+    RoleID: string;
+    IsEnabled: string;
+    READ: DataAccessSet;
+    CREATE: DataAccessSet;
+    UPDATE: DataAccessSet;
+    DELETE: DataAccessSet;
+    AuthFilters: any;
+    fieldAccesses: Array<FieldAccess>;
+    ObjectID: string;
 }
 export declare class AppMenu {
     ID: string | any;

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

@@ -0,0 +1,124 @@
+import { ObjectType } from '../enums/common.enum';
+import { ObjectCreationType } from '../enums/dsq.enum';
+import { DeploymentStatus } from '../enums/permission.enum';
+import { AppFieldModel } from './app-field.model';
+import { ObjectAccess } from './app-object.class';
+import { Resources } from './common.class';
+import { DataSourceQueryModel } from './data-source-query.model';
+export declare class AppObjectModel {
+    private readonly raw;
+    readonly ID: string;
+    readonly ObjectName: string;
+    readonly DisplayName: string;
+    readonly Description: string;
+    readonly SystemDBTableName: string;
+    readonly IsSystem: boolean;
+    readonly IsVisible: boolean;
+    readonly IsDeprecated: boolean;
+    readonly IsSupportBluePrint: boolean | null;
+    readonly IsLocationTracking: boolean | null;
+    readonly ObjectType: ObjectType;
+    readonly DeploymentStatus: DeploymentStatus;
+    readonly CreationType: ObjectCreationType;
+    readonly AllowVersioning: boolean;
+    readonly EnableTracking: boolean;
+    readonly AllowSearchable: boolean;
+    readonly AllowReports: boolean;
+    readonly AllowActivities: boolean;
+    readonly AllowSharing: boolean;
+    readonly AllowSoftDelete: boolean | null;
+    readonly IsReplicationNeeded: boolean | null;
+    readonly IsCacheEnable: boolean | null;
+    readonly CacheTtl: number | null;
+    readonly AppObjectConfiguration: string;
+    readonly CRUDAppObjectId: string | null;
+    readonly ConnectionId: string | null;
+    readonly IsSupportLayout: boolean | null;
+    readonly AccessList: Array<ObjectAccess>;
+    readonly Resources: Array<Resources>;
+    readonly parsedAppObjectConfiguration: any;
+    private readonly fieldMap;
+    private readonly dsqMap;
+    private allFields;
+    private allDSQs;
+    constructor(raw: any);
+    /**
+     * Returns all fields associated with this AppObject. The fields are cached so that subsequent calls
+     * are faster. The cache is stored in a map by ID.
+     *
+     * @returns {AppFieldModel[]} An array of AppFieldModel objects.
+     */
+    fields(): AppFieldModel[];
+    /**
+     * Retrieves a field by its ID or name.
+     * If the field is cached, it returns it from the cache.
+     * Otherwise, it searches through all fields.
+     *
+     * @param {string} idOrName - The ID or name of the field to retrieve.
+     * @returns {AppFieldModel | undefined} - The field model if found, otherwise undefined.
+     */
+    field(idOrName: string): AppFieldModel | undefined;
+    /**
+     * Retrieves all fields of the app object that are lookup fields.
+     * A lookup field is a field that has a relationship with another field.
+     * It is used to perform lookups, such as retrieving a list of values
+     * from a related field.
+     *
+     * @returns {AppFieldModel[]} - An array of AppFieldModel objects that are lookup fields.
+     */
+    lookupFields(): AppFieldModel[];
+    /**
+     * Finds and returns the fields for the app object that satisfy the given filter function.
+     * The filter function is called with each field as an argument, and should return true if the field
+     * should be included in the result.
+     * @param {function} filterFn The filter function to apply to the fields.
+     * @returns {AppFieldModel[]} The array of fields that satisfy the filter function.
+     */
+    findFields(filterFn: (field: AppFieldModel) => boolean): AppFieldModel[];
+    /**
+     * Retrieves all data source queries associated with this AppObject.
+     * The queries are cached for faster subsequent access. The cache is stored in a map by ID, QueryName, and DisplayName.
+     *
+     * @returns {DataSourceQueryModel[]} An array of DataSourceQueryModel objects.
+     */
+    dataSourceQueries(): DataSourceQueryModel[];
+    /**
+     * Retrieves a data source query by its ID or name.
+     * If the query is cached, it returns it from the cache.
+     * Otherwise, it searches through all data source queries.
+     *
+     * @param {string} idOrName - The ID or name of the data source query to retrieve.
+     * @returns {DataSourceQueryModel | undefined} - The data source query model if found, otherwise undefined.
+     */
+    dataSourceQuery(idOrName: string): DataSourceQueryModel | undefined;
+    /**
+     * Finds and returns the data source queries that satisfy the given filter function.
+     * The filter function is called with each data source query as an argument.
+     * If the filter function returns true, the data source query is included in the result.
+     *
+     * @param {function} filterFn - The filter function to apply to the data source queries.
+     * @returns {DataSourceQueryModel[]} - The array of data source queries that satisfy the filter function.
+     */
+    findDataSourceQueries(filterFn: (dsq: DataSourceQueryModel) => boolean): DataSourceQueryModel[];
+    /**
+     * Searches for the given term in the fields and data source queries of this AppObject.
+     * The search is case-insensitive and performed on the following fields:
+     *   - Field name and description
+     *   - Data source query name, display name, and description
+     *
+     * @param {string} term - The search term to search for.
+     * @returns {{ fields: AppFieldModel[]; dsqs: DataSourceQueryModel[] }} - An object with the search results.
+     *   The `fields` property contains an array of AppFieldModel objects that match the search term.
+     *   The `dsqs` property contains an array of DataSourceQueryModel objects that match the search term.
+     */
+    search(term: string): {
+        fields: AppFieldModel[];
+        dsqs: DataSourceQueryModel[];
+    };
+    /**
+     * Converts the current object to a JSON object.
+     *
+     * @returns {any} The raw data as a JSON object.
+     */
+    toJSON(): any;
+}

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

@@ -0,0 +1,27 @@
+import { ScreenType } from "../enums/common.enum";
+export declare class AppScreenModel {
+    private raw;
+    readonly ID: string;
+    readonly Name: string;
+    readonly Description: string;
+    readonly ScreenType: ScreenType;
+    readonly DataSourceQuery: string;
+    readonly Container: string | null;
+    readonly ScreenConfiguration: string;
+    readonly AppId: string;
+    readonly RecordId: string;
+    readonly IsSystemRecord: boolean;
+    constructor(raw: any);
+    /**
+     * Searches for the given term in the properties of the current app screen
+     * @param {string} term The search term
+     * @returns {boolean} Whether the search term is present in any field
+     */
+    search(term: string): boolean;
+    /**
+     * Converts the current object to a JSON object.
+     *
+     * @returns A JSON representation of the current object.
+     */
+    toJSON(): any;
+}

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

@@ -1,3 +1,4 @@
+import { ResourceType } from "../enums/common.enum";
 export declare class Role {
     ID: string | any;
     RoleName: string | any;
@@ -17,6 +18,8 @@ export declare class Profile {
 export declare class Resources {
     ID: string;
     Value: string;
+    Setting_Key: string;
+    resourceType: ResourceType;
 }
 export declare class EmailTemplate {
     ID: string;

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

@@ -1,7 +1,6 @@
 import { DataTypes } from '../enums/controllers.enum';
-import { SortSequence, ConjuctionClause, RelationalOperator, ObjectCreationType } from '../enums/dsq.enum';
+import { SortSequence, ConjuctionClause, RelationalOperator, ObjectCreationType, DataSourceQueryFieldType } from '../enums/dsq.enum';
 import { AppObject } from './app-object.class';
-import { Profile } from './common.class';
 export declare class DataSourceQueries {
     ID: string;
     ObjectID: AppObject;
@@ -14,9 +13,14 @@ export declare class DataSourceQueries {
     Parameters: Parameters[];
 }
 export declare class DataSourceQueries_Fields {
+    ID: string;
+    Field: AppFields;
     SeqNo: number;
     Field_GridAttributes: string;
     LookupDetails: string;
+    FieldType: DataSourceQueryFieldType;
+    FieldDetails: string;
+    AppFieldID: string;
 }
 export declare class Parameters {
     ID: string;
@@ -72,10 +76,10 @@ export declare class LookUpDetails {
     LookupObject: string;
     LookupField: string;
     DisplayField: string;
+    selectQuery: any;
 }
 export declare class FieldAccess {
-    ID: string;
-    ProfileID: Profile;
+    FieldID: string;
     IsVisible: boolean;
     IsReadOnly: boolean;
 }

package/lib/tab-core-utility/app/models/data-source-query.model.d.ts

@@ -0,0 +1,69 @@
+import { AppObjectModel } from './app-object.model';
+import { DataSourceQueries_Fields } from './data-source-queries.class';
+import { FilterModel } from './filter.model';
+import { ParameterModel } from './parameter.model';
+import { SortModel } from './sort.model';
+export declare class DataSourceQueryModel {
+    private readonly raw;
+    readonly parentAppObject: AppObjectModel;
+    readonly ID: string;
+    readonly ObjectID: string;
+    readonly ObjectID_Tosave: string;
+    readonly QueryName: string;
+    readonly DisplayName: string;
+    readonly FilterLogic: string | null;
+    private enrichedFields;
+    private cachedParameters;
+    private cachedFilters;
+    private cachedSorts;
+    constructor(raw: any, parentAppObject: AppObjectModel);
+    /**
+     * Gets the fields for the data source query. The fields are enriched with the corresponding `AppFieldModel` objects.
+     * @returns {DataSourceQueries_Fields[]} The array of enriched fields.
+     */
+    fields(): DataSourceQueries_Fields[];
+    /**
+     * Finds and returns the fields for the data source query that satisfy the given filter function.
+     * @param {function} filterFn The filter function to apply to the fields.
+     * @returns {DataSourceQueries_Fields[]} The array of fields that satisfy the filter function.
+     */
+    findFields(filterFn: (field: DataSourceQueries_Fields) => boolean): DataSourceQueries_Fields[];
+    /**
+     * Retrieves and caches the parameters for the data source query.
+     * @returns {ParameterModel[]} The array of ParameterModel instances.
+     */
+    parameters(): ParameterModel[];
+    /**
+     * Retrieves the mandatory parameters for the data source query.
+     * @returns {ParameterModel[]} The array of mandatory ParameterModel instances.
+     */
+    mandatoryParameters(): ParameterModel[];
+    /**
+     * Finds a parameter by its name (case-insensitive).
+     * @param {string} name The name of the parameter to find.
+     * @returns {ParameterModel | undefined} The parameter model instance if found, otherwise undefined.
+     */
+    parameter(name: string): ParameterModel | undefined;
+    /**
+     * Retrieves and caches the filters for the data source query.
+     * @returns {FilterModel[]} The array of FilterModel instances.
+     */
+    filters(): FilterModel[];
+    /**
+     * Retrieves and caches the sorts for the data source query.
+     * @returns {SortModel[]} The array of SortModel instances.
+     */
+    sorts(): SortModel[];
+    /**
+     * Check if the given search term is present in any of the fields of the
+     * current data source query
+     * @param {string} term The search term
+     * @returns {boolean} Whether the search term is present in any field
+     */
+    search(term: string): boolean;
+    /**
+     * Converts the DataSourceQueryModel instance to a JSON representation.
+     * @returns {any} The raw data in JSON format.
+     */
+    toJSON(): any;
+}

package/lib/tab-core-utility/app/models/filter.model.d.ts

@@ -0,0 +1,21 @@
+import { ConjuctionClause, DataSourceQueryFilterFieldType, FilterValueType, RelationalOperator } from "../enums/dsq.enum";
+export declare class FilterModel {
+    private readonly raw;
+    readonly ID: string;
+    readonly ConjuctionClause: ConjuctionClause;
+    readonly RelationalOperator: RelationalOperator;
+    readonly ValueType: FilterValueType;
+    readonly value: string;
+    readonly Sequence: number;
+    readonly GroupID: number;
+    readonly LookupDetail: string | null;
+    readonly FieldType: DataSourceQueryFilterFieldType;
+    readonly FieldID: string;
+    constructor(raw: any);
+    /**
+     * Converts the current object to a JSON object.
+     *
+     * @returns A JSON representation of the current object.
+     */
+    toJSON(): any;
+}

package/lib/tab-core-utility/app/models/orgInfo.model.d.ts

@@ -0,0 +1,23 @@
+export declare class OrgInfoModel {
+    private raw;
+    readonly ID: string;
+    readonly OrganizationName: string;
+    readonly PrimaryContact: string;
+    readonly Address: string;
+    readonly LocaleSettings: string;
+    readonly Subdomain: string;
+    readonly TenantCode: string;
+    constructor(raw: any);
+    /**
+     * Check if the given search term is present in any of the fields of the
+     * current org info
+     * @param {string} term The search term
+     * @returns {boolean} Whether the search term is present in any field
+     */
+    search(term: string): boolean;
+    /**
+     * Get raw data for this app object
+     * @returns {any} The raw data for this app object
+     */
+    toJSON(): any;
+}

package/lib/tab-core-utility/app/models/parameter.model.d.ts

@@ -0,0 +1,14 @@
+export declare class ParameterModel {
+    private readonly raw;
+    readonly ID: string;
+    readonly ParameterName: string;
+    readonly DataSourceQueryID: string;
+    readonly MappingFieldName: string;
+    readonly IsMandatory: boolean;
+    constructor(raw: any);
+    /**
+     * Converts the model to JSON.
+     * @returns {any} The model as a JSON object.
+     */
+    toJSON(): any;
+}

package/lib/tab-core-utility/app/models/sort.model.d.ts

@@ -0,0 +1,15 @@
+import { DataSourceQueryFilterFieldType, SortSequence } from "../enums/dsq.enum";
+export declare class SortModel {
+    private readonly raw;
+    readonly ID: string;
+    readonly SortSequence: SortSequence;
+    readonly Sequence: number;
+    readonly LookupDetails: string | null;
+    readonly FieldType: DataSourceQueryFilterFieldType;
+    readonly AppFieldID: string;
+    constructor(raw: any);
+    /**
+     * Get raw data for this app object
+     */
+    toJSON(): any;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@techextensor/tab-core-utility",
-  "version": "2.2.133",
+  "version": "2.2.135",
   "peerDependencies": {
     "@angular/common": "^17.3.0",
     "@angular/core": "^17.3.0",