@techextensor/tab-sdk 0.0.0

package/projects/tab-sdk/src/lib/app/analytics.service.ts

@@ -0,0 +1,54 @@
+import { inject, Injectable } from '@angular/core';
+import { AppHelper, CommonApiResponse, PerformanceAnalyticsPayload, ScreenPerformancePayload } from '@techextensor/tab-core-utility';
+import { firstValueFrom } from 'rxjs';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class AnalyticsService {
+    private _appHelper: AppHelper = inject(AppHelper);
+
+    /**
+     * Retrieves the summary of performance analytics based on the provided payload.
+     * 
+     * @param payload The performance analytics payload.
+     * @returns A promise that resolves to a common API response containing the performance analytics summary.
+     */
+    async getSummaryOfPerformance(payload: PerformanceAnalyticsPayload): Promise<CommonApiResponse> {
+        const response = await firstValueFrom(
+            this._appHelper.getSummaryOfPerformanceAnalytics(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Retrieves the detail of performance analytics based on the provided payload.
+     * 
+     * @param payload The performance analytics payload.
+     * @returns A promise that resolves to a common API response containing the performance analytics detail.
+     */
+    async getDetailOfPerformance(payload: PerformanceAnalyticsPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.getDetailOfPerformanceAnalytics(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Inserts the screen performance statistics based on the provided payload.
+     * 
+     * @param payload The screen performance payload containing the statistics to be inserted.
+     * @returns A promise that resolves to a common API response containing the result of the insertion.
+     */
+    async insertScreenPerformance(payload: ScreenPerformancePayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.insertScreenPerformanceStatistics(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+}

package/projects/tab-sdk/src/lib/app/app.service.ts

@@ -0,0 +1,188 @@
+import { inject, Injectable } from '@angular/core';
+import { AppHelper, CloneDsqPayload, CommonApiResponse, GetDataJsonByTypePayload, RefreshGlobalSearchDataPayload, RefreshRecordInfoDataPayload, RegisterAppObjectsPayload, SyncAppFieldsPayload } from '@techextensor/tab-core-utility';
+import { firstValueFrom } from 'rxjs';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class AppService {
+    private _appHelper: AppHelper = inject(AppHelper);
+
+    /**
+     * Rebuilds the current app.
+     * 
+     * @returns A promise that resolves to a common API response.
+     */
+    async rebuild(): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.rebuildApp()
+        );
+        // Return the response from the server.
+        return response;
+    }
+
+    /**
+     * Retrieves the schema for the current app.
+     * 
+     * @returns A promise that resolves to a common API response containing the schema.
+     */
+    async getSchema(): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.getSchema()
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Retrieves the current app's permission.
+     * 
+     * @returns A promise that resolves to a common API response containing the permission information.
+     */
+    async getPermission(): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.getPermission()
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Registers app objects based on the provided payload.
+     * 
+     * @param payload The register app objects payload.
+     * @returns A promise that resolves to a common API response.
+     */
+    async registerAppObject(payload: RegisterAppObjectsPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.registerAppObjects(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Clones a data source query (DSQ) based on the provided payload.
+     * 
+     * @param payload The clone DSQ payload.
+     * @returns A promise that resolves to a common API response.
+     */
+    async cloneDsq(payload: CloneDsqPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.cloneDsq(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Retrieves data in JSON format based on the provided payload.
+     * 
+     * @param payload The get data JSON by type payload.
+     * @returns A promise that resolves to a common API response containing the data in JSON format.
+     */
+    async getDataJsonByType(payload: GetDataJsonByTypePayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.getDataJsonByType(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Synchronizes the current app's fields based on the provided payload.
+     * 
+     * @param payload The sync app fields payload.
+     * @returns A promise that resolves to a common API response.
+     */
+    async syncAppFields(payload: SyncAppFieldsPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.syncAppFields(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Sets the tab components based on the provided connection ID.
+     * 
+     * @param connectionId The ID of the connection to set the components for.
+     * @returns A promise that resolves to a common API response.
+     */
+    async setTabComponents(connectionId: string): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.setTabComponents(connectionId)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Performs validation for the connection with the provided ID.
+     * 
+     * @param connectionId The ID of the connection to validate.
+     * @returns A promise that resolves to a common API response containing the validation result.
+     */
+    async performValidation(connectionId: string): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.performValidation(connectionId)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Tests the connection with the provided connection ID.
+     * 
+     * @param connectionId The ID of the connection to test.
+     * @returns A promise that resolves to a common API response containing the test result.
+     */
+    async testConnection(connectionId: string): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.testConnection(connectionId)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Refreshes the global search data based on the provided payload.
+     * 
+     * @param payload The refresh global search data payload.
+     * @returns A promise that resolves to a common API response containing the refreshed global search data.
+     */
+    async refreshGlobalSearchData(payload: RefreshGlobalSearchDataPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.refreshGlobalSearchData(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Refreshes the record information data based on the provided payload.
+     * 
+     * @param payload The refresh record info data payload.
+     * @returns A promise that resolves to a common API response containing the refreshed record info data.
+     */
+    async refreshRecordInfoData(payload: RefreshRecordInfoDataPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to await the completion of the observable
+        const response = await firstValueFrom(
+            this._appHelper.refreshRecordInfoData(payload)
+        );
+
+        // Return the response from the server
+        return response;
+    }
+}

package/projects/tab-sdk/src/lib/app/file.service.ts

@@ -0,0 +1,92 @@
+import { inject, Injectable } from '@angular/core';
+import { ApiService, CommonApiResponse, MediaUploadHelper, UploadMediaFilesPayload } from '@techextensor/tab-core-utility';
+import { firstValueFrom } from 'rxjs';
+import { TabSdk } from '../tab-sdk.service';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class FileService {
+    private _mediaUploadHelper: MediaUploadHelper = inject(MediaUploadHelper);
+    private apiService: ApiService = inject(ApiService);
+
+    /**
+     * Uploads media files using the provided payload and optional headers.
+     *
+     * @param payload The payload containing the media files to upload.
+     * @param headers Optional headers to pass to the server.
+     * @returns A promise that resolves to a common API response.
+     */
+    async uploadMediaFiles(payload: UploadMediaFilesPayload, headers?: any): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._mediaUploadHelper.uploadMediaFiles(payload, headers)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Removes a media file from the server using the provided media ID.
+     *
+     * @param mediaId The ID of the media file to remove.
+     * @returns A promise that resolves to a common API response.
+     */
+    async removeMediaFile(mediaId: string): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._mediaUploadHelper.removeMediaFile(mediaId)
+        );
+        // Return the response from the server
+        return response;
+    }
+
+    /**
+     * Processes an FTP URL and returns a processed URL.
+     *
+     * @param params - The parameters containing data, an optional defaultHeader, and an optional imgElement.
+     * @returns A promise that resolves to the processed URL or null if an error occurs.
+     */
+    async processFtpUrl(params: { data: string, defaultHeader?: boolean, imgElement?: HTMLImageElement }): Promise<any> {
+        // Return null if the data is invalid
+        if (!params?.data || params?.data === 'null' || params?.data === 'undefined') return null;
+
+        try {
+            let url = params.data;
+
+            // Extract the value from a JSON string if it contains 'value'
+            if (url?.includes('value')) {
+                url = JSON.parse(url).value;
+            }
+
+            // Check if the URL is an image from the FileManager service
+            if (url.includes('FileManager/GetImage')) {
+                const options: any = { responseType: 'blob' };
+
+                // Add default headers if specified
+                if (params.defaultHeader) {
+                    options.headers = TabSdk.util?.getDefaultAppHeaders();
+                }
+
+                // Fetch the image as a blob
+                const blob = await firstValueFrom(this.apiService.getByUrl(url, options));
+
+                // Create an object URL from the blob
+                url = URL.createObjectURL(blob);
+            }
+
+            // Set the image element's source to the processed URL
+            if (params.imgElement) {
+                params.imgElement.src = url;
+                params.imgElement.onload = null;
+            }
+
+            return url;
+
+        } catch (e) {
+            // Log any errors that occur during processing
+            console.error("Error processing FTP", e);
+            return null;
+        }
+    }
+}

package/projects/tab-sdk/src/lib/app/release.service.ts

@@ -0,0 +1,38 @@
+import { inject, Injectable } from '@angular/core';
+import { CommonApiResponse, TabReleaseService } from '@techextensor/tab-core-utility';
+import { firstValueFrom } from 'rxjs';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class ReleaseService {
+    private _tabReleaseService: TabReleaseService = inject(TabReleaseService);
+
+    /**
+     * Retrieves the data differences between the current app version and the latest
+     * released version of the app.
+     * 
+     * @returns A promise that resolves to a common API response containing the data
+     * differences in JSON format.
+     */
+    async getTabDataDiff(): Promise<CommonApiResponse> {
+        const response = await firstValueFrom(
+            this._tabReleaseService.getDataJsonDiff()
+        );
+        return response;
+    }
+
+    /**
+     * Retrieves the metadata differences between the current app version and the latest
+     * released version of the app.
+     * 
+     * @returns A promise that resolves to a common API response containing the metadata
+     * differences in JSON format.
+     */
+    async getMetaDataDiff(): Promise<CommonApiResponse> {
+        const response = await firstValueFrom(
+            this._tabReleaseService.getMetaDataJsonDiff()
+        );
+        return response;
+    }
+}

package/projects/tab-sdk/src/lib/app/report.service.ts

@@ -0,0 +1,51 @@
+import { inject, Injectable } from '@angular/core';
+import { AppHelper, CommonApiResponse, ReportPayload } from '@techextensor/tab-core-utility';
+import { firstValueFrom } from 'rxjs';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class ReportService {
+    private _appHelper: AppHelper = inject(AppHelper);
+
+    /**
+     * Exports a report based on the provided payload.
+     * 
+     * @param payload The payload containing the parameters for the report.
+     * @returns A promise that resolves to a common API response containing the report.
+     */
+    async export(payload: ReportPayload): Promise<CommonApiResponse> {
+        const response = await firstValueFrom(
+            this._appHelper.exportReport(payload)
+        );
+        return response;
+    }
+
+    /**
+     * Downloads a report based on the provided payload.
+     * 
+     * @param payload The payload containing the parameters for the report.
+     * @returns A promise that resolves to a common API response containing the report.
+     */
+    async download(payload: ReportPayload): Promise<Blob> {
+        const response = await firstValueFrom(
+            this._appHelper.downloadReport(payload)
+        );
+        return response;
+    }
+
+    /**
+     * Sends a report based on the provided payload.
+     * 
+     * @param payload The payload containing the parameters for the report.
+     * @returns A promise that resolves to a common API response containing the report.
+     */
+    async send(payload: ReportPayload): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._appHelper.sendReport(payload)
+        );
+        // Return the response from the server
+        return response;
+    }
+}

package/projects/tab-sdk/src/lib/app/translator.service.ts

@@ -0,0 +1,80 @@
+import { inject, Injectable } from '@angular/core';
+import {  firstValueFrom, Observable } from 'rxjs';
+import { translatePayload, TranslationService } from '@techextensor/tab-core-utility';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class TranslatorService {
+    private readonly _translationService: TranslationService = inject(TranslationService);
+
+    /**
+     * Gets the current active language
+     * 
+     * @returns The current language code
+     */
+    getCurrentLanguage(): string {
+        return this._translationService.getCurrentLanguage();
+    }
+
+    /**
+     * Gets an observable of the current language changes
+     * 
+     * @returns An observable of the current language code
+     */
+    getLanguageChanges(): Observable<string> {
+        return this._translationService.currentLanguage$;
+    }
+
+    /**
+     * Changes the application language
+     * 
+     * @param payload The translate payload containing language and languageCode
+     * @returns A promise that resolves when the language has been changed
+     */
+    async changeLanguage(payload: translatePayload): Promise<any> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._translationService.changeLanguage(payload)
+        );
+        // Return the response
+        return response;
+    }
+
+    /**
+     * Translates a key to the current language
+     * 
+     * @param key The translation key
+     * @param params Optional parameters for interpolation
+     * @returns The translated string
+     */
+    translate(key: string, params?: any): string {
+        if(!key?.length) return key;
+        return this._translationService.translate(key, params);
+    }
+
+    /**
+     * Gets a translation as an observable for async operations
+     * 
+     * @param key The translation key
+     * @param params Optional parameters for interpolation
+     * @returns An observable of the translated string
+     */
+    async getTranslation(key: string, params?: any): Promise<string> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const translation = await firstValueFrom(
+            this._translationService.getTranslation(key, params)
+        );
+        // Return the translated string
+        return translation;
+    }
+
+    /**
+     * Registers an external library integration for translations
+     * 
+     * @param handler Function to handle the integration with language and translations
+     */
+    registerIntegration(handler: (lang: string, translations: any) => void): void {
+        this._translationService.registerIntegration(handler);
+    }
+}

package/projects/tab-sdk/src/lib/auth/auth.service.ts

@@ -0,0 +1,119 @@
+import { inject, Injectable } from '@angular/core';
+import {
+    LoginUserRequest,
+    AuthService,
+    CommonApiResponse,
+    RegisterTenant,
+    ResetPasswordUserRequest,
+    RefreshTokenRequest,
+    UserDetailsRequest,
+    ChangePasswordUserRequest
+} from '@techextensor/tab-core-utility';
+import { firstValueFrom } from 'rxjs';
+
+@Injectable({
+    providedIn: 'root'
+})
+export class AuthUtilService {
+    private readonly _authService: AuthService = inject(AuthService);
+
+    /**
+     * Authenticates a user based on the provided login credentials.
+     * 
+     * @param credentials The login credentials.
+     * @returns The response from the server.
+     */
+    async login(credentials: LoginUserRequest): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.signIn(credentials)
+        );
+        return response;
+    }
+
+    /**
+     * Registers a new tenant based on the provided details.
+     * 
+     * @param tenantDetails The tenant details.
+     * @returns The response from the server.
+     */
+    async registerTenant(tenantDetails: RegisterTenant): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.registerTenant(tenantDetails)
+        );
+        return response;
+    }
+
+    /**
+     * Registers a new user based on the provided user details.
+     * 
+     * @param userDetails The user details.
+     * @param headers Optional headers to pass to the server.
+     * @returns The response from the server.
+     */
+    async registerUser(userDetails: any, headers?: Record<string, string>): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.register(userDetails, headers)
+        );
+        return response;
+    }
+
+    /**
+     * Resets a user's password based on the provided reset password credentials.
+     * 
+     * @param credentials The reset password credentials.
+     * @returns The response from the server.
+     */
+    async resetPassword(credentials: ResetPasswordUserRequest): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.resetPassword(credentials)
+        );
+        return response;
+    }
+
+    /**
+     * Changes a user's password based on the provided credentials.
+     * 
+     * @param credentials The credentials containing the user's current and new password.
+     * @returns The response from the server.
+     */
+    async changePassword(credentials: ChangePasswordUserRequest): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.changePassword(credentials)
+        );
+        return response;
+    }
+
+    /**
+     * Refreshes a user's token based on the provided refresh token details.
+     * 
+     * @param tokenDetails The refresh token details.
+     * @returns The response from the server.
+     */
+    async refreshToken(tokenDetails: RefreshTokenRequest): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.refreshToken(tokenDetails)
+        );
+        return response;
+    }
+
+    /**
+     * Gets the user details for the provided user details request.
+     * 
+     * @param userDetailsRequest The user details request.
+     * @param headers Optional headers to pass to the server.
+     * @returns The response from the server.
+     */
+    async getUserDetails(userDetailsRequest: UserDetailsRequest, headers?: Record<string, string>): Promise<CommonApiResponse> {
+        // Use the firstValueFrom RxJs operator to wait for the observable to complete
+        const response = await firstValueFrom(
+            this._authService.getUserDetails(userDetailsRequest, headers)
+        );
+        return response;
+    }
+}