@techextensor/tab-sdk 0.0.3 → 0.0.6

package/lib/auth/auth.service.d.ts

@@ -0,0 +1,58 @@
+import { LoginUserRequest, CommonApiResponse, RegisterTenant, ResetPasswordUserRequest, RefreshTokenRequest, UserDetailsRequest, ChangePasswordUserRequest } from '@techextensor/tab-core-utility';
+import * as i0 from "@angular/core";
+export declare class AuthUtilService {
+    private readonly _authService;
+    /**
+     * Authenticates a user based on the provided login credentials.
+     *
+     * @param credentials The login credentials.
+     * @returns The response from the server.
+     */
+    login(credentials: LoginUserRequest): Promise<CommonApiResponse>;
+    /**
+     * Registers a new tenant based on the provided details.
+     *
+     * @param tenantDetails The tenant details.
+     * @returns The response from the server.
+     */
+    registerTenant(tenantDetails: RegisterTenant): Promise<CommonApiResponse>;
+    /**
+     * 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.
+     */
+    registerUser(userDetails: any, headers?: Record<string, string>): Promise<CommonApiResponse>;
+    /**
+     * Resets a user's password based on the provided reset password credentials.
+     *
+     * @param credentials The reset password credentials.
+     * @returns The response from the server.
+     */
+    resetPassword(credentials: ResetPasswordUserRequest): Promise<CommonApiResponse>;
+    /**
+     * 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.
+     */
+    changePassword(credentials: ChangePasswordUserRequest): Promise<CommonApiResponse>;
+    /**
+     * Refreshes a user's token based on the provided refresh token details.
+     *
+     * @param tokenDetails The refresh token details.
+     * @returns The response from the server.
+     */
+    refreshToken(tokenDetails: RefreshTokenRequest): Promise<CommonApiResponse>;
+    /**
+     * 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.
+     */
+    getUserDetails(userDetailsRequest: UserDetailsRequest, headers?: Record<string, string>): Promise<CommonApiResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AuthUtilService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AuthUtilService>;
+}

package/lib/crud/crud.service.d.ts

@@ -0,0 +1,88 @@
+import { APISelectQuery, CommonApiResponse, DeletePayload, GetPayload, InsertPayload, UpdatePayload, ImprotDataPayload, RcordHistoryPayload, SearchDataPayload } from '@techextensor/tab-core-utility';
+import * as i0 from "@angular/core";
+export declare class CrudService {
+    private readonly _tabCrudService;
+    private readonly _tabGetService;
+    /**
+     * Retrieves a record from the database using the provided payload.
+     *
+     * @param payload - The payload containing information to retrieve the record.
+     * @param headers - Optional headers to pass to the server.
+     * @returns A promise that resolves to a common API response containing the retrieved record.
+     */
+    get(payload: GetPayload, headers?: any): Promise<CommonApiResponse>;
+    /**
+     * Inserts a record into the database using the provided payload.
+     *
+     * @param payload - The payload containing information to insert the record.
+     * @param headers - Optional headers to pass to the server.
+     * @returns A promise that resolves to a common API response containing the inserted record.
+     */
+    insert(payload: InsertPayload, headers?: any): Promise<CommonApiResponse>;
+    /**
+     * Updates a record in the database using the provided payload.
+     *
+     * @param payload - The payload containing information to update the record.
+     * @param headers - Optional headers to pass to the server.
+     * @returns A promise that resolves to a common API response containing the updated record.
+     */
+    update(payload: UpdatePayload, headers?: any): Promise<CommonApiResponse>;
+    /**
+     * Deletes a record from the database using the provided payload.
+     *
+     * @param payload - The payload containing information to delete the record.
+     * @param headers - Optional headers to pass to the server.
+     * @returns A promise that resolves to a common API response containing the deleted record.
+     */
+    delete(payload: DeletePayload, headers?: any): Promise<CommonApiResponse>;
+    /**
+     * Executes a stored procedure using the provided payload.
+     *
+     * @param sp - The name of the stored procedure to execute.
+     * @param headers - Optional headers to pass to the server.
+     * @returns A promise that resolves to a common API response containing the result of executing the stored procedure.
+     */
+    executeSp(sp: string, headers?: any): Promise<CommonApiResponse>;
+    /**
+     * Executes a select query using the provided select query ID.
+     *
+     * @param selectQueryId - The ID of the select query to execute.
+     * @param parameters - Optional parameters to pass to the select query.
+     * @returns A promise that resolves to a common API response containing the result of executing the select query.
+     */
+    executeSelectQuery(selectQueryId: string, parameters?: any): Promise<CommonApiResponse>;
+    /**
+     * Executes a select query using the provided select query data.
+     *
+     * @param data - The select query data.
+     * @param parameters - Optional parameters to pass to the select query.
+     * @returns A promise that resolves to a common API response containing the result of executing the select query.
+     */
+    executeSelectExecutor(data: APISelectQuery, parameters?: any): Promise<CommonApiResponse>;
+    /**
+     * Gets the search data using the provided search query and limit.
+     *
+     * @param searchQuery - The search query to search for.
+     * @param limit - The number of records to limit the results to.
+     * @param parameters - Optional parameters to pass to the search query.
+     * @returns A promise that resolves to a common API response containing the search data.
+     */
+    getSearchData(payload: SearchDataPayload, parameters?: any): Promise<CommonApiResponse>;
+    /**
+     * Retrieves the history of records for a specified app object.
+     *
+     * @param appObjectId - The ID of the app object to retrieve the record history for.
+     * @param recordIds - An array of record IDs to retrieve the history for.
+     * @returns A promise that resolves to a common API response containing the record history.
+     */
+    getRecordHistory(payload: RcordHistoryPayload): Promise<CommonApiResponse>;
+    /**
+     * Imports data into the database.
+     *
+     * @param data - The data to import.
+     * @returns A promise that resolves to a common API response containing the result of importing the data.
+     */
+    import(payload: ImprotDataPayload): Promise<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CrudService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CrudService>;
+}

package/lib/enum/store.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum StorageType {
+    Local = "local",
+    Session = "session"
+}

package/lib/enum/ui.enum.d.ts

@@ -0,0 +1,10 @@
+export declare enum ScreenDisplayMode {
+    Sidebar = "sidebar",
+    Popup = "popup",
+    SameTab = "sameTab",
+    NewTab = "newTab"
+}
+export declare enum NavigationType {
+    NavigateToUrl = "navigateToUrl",
+    NavigateToSubdomain = "navigateToSubdomain"
+}

package/lib/http/http.service.d.ts

@@ -0,0 +1,35 @@
+import { HttpExecuteRequestPayload } from '@techextensor/tab-core-utility';
+import { RequestStatus } from '../interface/http.interface';
+import * as i0 from "@angular/core";
+export declare class HttpService {
+    private readonly _tabGetService;
+    /**
+     * Executes an HTTP request using the provided payload.
+     *
+     * @param payload - The payload containing information to execute the HTTP request.
+     * @returns A promise that resolves to the response from the server.
+     */
+    executeRequest(payload: HttpExecuteRequestPayload): Promise<any>;
+    /**
+     * Generates an HTTP request for the given data source query name.
+     *
+     * @param dataSourceQueryName - The name of the data source query for which to generate the HTTP request.
+     * @returns A promise that resolves to the generated HTTP request.
+     */
+    generateRequest(dataSourceQueryName: string): Promise<any>;
+    /**
+     * Sets the request status for the given URL.
+     *
+     * @param status - The request status to set.
+     */
+    setRequestStatus(status: RequestStatus): void;
+    /**
+     * Gets the request status for the given URL.
+     *
+     * @param url - The URL for which to get the request status.
+     * @returns The request status for the given URL.
+     */
+    getRequestStatus(url: string): RequestStatus | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<HttpService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<HttpService>;
+}

package/lib/interface/http.interface.d.ts

@@ -0,0 +1,8 @@
+export interface RequestStatus {
+    url: string;
+    status: string;
+    statusCode: number;
+    executionTime: number;
+    error?: string;
+    size: string;
+}

package/lib/interface/ui.interface.d.ts

@@ -0,0 +1,24 @@
+import { ScreenDisplayMode } from "../enum/ui.enum";
+export interface BaseScreenOptions {
+    screenId: string;
+    reqtokens?: any;
+    submission?: any;
+    title?: string;
+    width?: string | number;
+    height?: string | number;
+    customClass?: string;
+    refresher?: () => void;
+    closer?: () => void;
+}
+export interface ScreenOpenOptions extends BaseScreenOptions {
+    mode: ScreenDisplayMode;
+}
+export interface NavigationOptions {
+    screenId: string;
+    reqtokens?: Record<string, any>;
+}
+export interface NavigateToSubdomainOptions {
+    subDomain: string;
+    appCode: string;
+    url: string;
+}

package/lib/store/store.service.d.ts

@@ -0,0 +1,406 @@
+import * as i0 from "@angular/core";
+export declare class StoreService {
+    private readonly _localStorageService;
+    private readonly _sessionStorageService;
+    /**
+     * Retrieves the tenant ID from the local storage.
+     */
+    get tenantId(): string | null;
+    /**
+     * Sets the tenant ID in the organization info.
+     *
+     * @param value - The tenant ID to set.
+     */
+    set tenantId(value: string | null);
+    /**
+     * Retrieves the tenant name from the organization info.
+     */
+    get tenantName(): string | null;
+    /**
+     * Sets the tenant name in the organization info.
+     *
+     * @param value - The tenant name to set.
+     */
+    set tenantName(value: string | null);
+    /**
+     * Retrieves the subdomain from the organization info.
+     *
+     * @returns The subdomain if it exists, otherwise `null`.
+     */
+    get subdomain(): string | null;
+    /**
+     * Sets the subdomain in the organization info.
+     *
+     * @param value - The subdomain to set.
+     */
+    set subdomain(value: string | null);
+    /**
+     * Retrieves the app ID from the app info.
+     *
+     * @returns The app ID if it exists, otherwise `null`.
+     */
+    get appId(): string | null;
+    /**
+     * Sets the app ID in the app info.
+     *
+     * @param value - The app ID to set.
+     */
+    set appId(value: string | null);
+    /**
+     * Retrieves the app name from the app info.
+     *
+     * @returns The app name if it exists, otherwise `null`.
+     */
+    get appName(): string | null;
+    /**
+     * Sets the app name in the app info.
+     *
+     * @param value - The app name to set.
+     */
+    set appName(value: string | null);
+    /**
+     * Retrieves the environment ID from the environment info.
+     *
+     * @returns The environment ID if it exists, otherwise `null`.
+     */
+    get environmentId(): string | null;
+    /**
+     * Sets the environment ID in the environment info.
+     *
+     * @param value - The environment ID to set.
+     */
+    set environmentId(value: string | null);
+    /**
+     * Retrieves the environment name from the environment info.
+     *
+     * @returns The environment name if it exists, otherwise `null`.
+     */
+    get environmentName(): string | null;
+    /**
+     * Sets the environment name in the environment info.
+     *
+     * @param value - The environment name to set.
+     */
+    set environmentName(value: string | null);
+    /**
+     * Retrieves the token from the token info.
+     *
+     * @returns The token if it exists, otherwise `null`.
+     */
+    get token(): string | null;
+    /**
+     * Sets the token in the token info.
+     *
+     * @param value - The token to set.
+     */
+    set token(value: string | null);
+    /**
+     * Retrieves the refresh token from the token info.
+     *
+     * @returns The refresh token if it exists, otherwise `null`.
+     */
+    get refreshToken(): string | null;
+    /**
+     * Sets the refresh token in the token info.
+     *
+     * @param value - The refresh token to set.
+     */
+    set refreshToken(value: string | null);
+    /**
+     * Retrieves the refresh token expiry time from the token info.
+     *
+     * @returns The refresh token expiry time if it exists, otherwise `null`.
+     */
+    get refreshTokenExpiry(): string | null;
+    /**
+     * Sets the refresh token expiry time in the token info.
+     *
+     * @param value - The refresh token expiry time to set.
+     */
+    set refreshTokenExpiry(value: string | null);
+    /**
+     * Retrieves the static token from the token info.
+     *
+     * @returns The static token if it exists, otherwise `null`.
+     */
+    get staticToken(): string | null;
+    /**
+     * Sets the static token in the token info.
+     *
+     * @param value - The static token to set.
+     */
+    set staticToken(value: string | null);
+    /**
+     * Retrieves the user ID from the user info.
+     *
+     * @returns The user ID if it exists, otherwise `null`.
+     */
+    get userId(): string | null;
+    /**
+     * Retrieves the user's roles from the user information.
+     *
+     * @returns An array of user roles if they exist, otherwise `null`.
+     */
+    get userRoles(): any[] | null;
+    /**
+     * Retrieves the user's teams from the user information.
+     *
+     * @returns An array of user teams if they exist, otherwise `null`.
+     */
+    get userTeams(): any[] | null;
+    /**
+     * Removes the tenant ID from the organization information.
+     */
+    removeTenantId(): void;
+    /**
+     * Removes the tenant name from the organization information.
+     */
+    removeTenantName(): void;
+    /**
+     * Removes the subdomain from the organization information.
+     *
+     * This removes the subdomain property from the organization information
+     * stored in local storage.
+     */
+    removeSubdomain(): void;
+    /**
+     * Removes the app ID from the app information.
+     *
+     * This removes the app ID property from the app information stored in local storage.
+     */
+    removeAppId(): void;
+    /**
+     * Removes the app name from the app information.
+     *
+     * This removes the app name property from the app information stored in local storage.
+     */
+    removeAppName(): void;
+    /**
+     * Removes the environment ID from the environment information.
+     *
+     * This removes the ID property from the environment information
+     * stored in local storage.
+     */
+    removeEnvironmentId(): void;
+    /**
+     * Removes the environment name from the environment information.
+     *
+     * This removes the Name property from the environment information
+     * stored in local storage.
+     */
+    removeEnvironmentName(): void;
+    /**
+     * Removes the token from the token info.
+     *
+     * This removes the token property from the token information stored in session
+     * storage.
+     */
+    removeToken(): void;
+    /**
+     * Removes the refresh token from the token information.
+     *
+     * This removes the refresh token property from the token information stored in session
+     * storage.
+     */
+    removeRefreshToken(): void;
+    /**
+     * Removes the refresh token expiry time from the token information.
+     *
+     * This removes the refresh token expiry time property from the token information stored in session
+     * storage.
+     */
+    removeRefreshTokenExpiry(): void;
+    /**
+     * Removes the static token from the token information.
+     *
+     * This removes the static token property from the token information stored in session
+     * storage.
+     */
+    removeStaticToken(): void;
+    /**
+     * Removes the specified key from the organization information.
+     *
+     * This removes the specified key from the organization information stored in local storage.
+     *
+     * @param key The key to remove from the organization information.
+     */
+    private removeFromOrgInfo;
+    /**
+     * Removes the specified key from the app information.
+     *
+     * This removes the specified key from the app information stored in session
+     * storage.
+     *
+     * @param key The key to remove from the app information.
+     */
+    private removeFromAppInfo;
+    /**
+     * Removes the specified key from the environment information.
+     *
+     * This removes the specified key from the environment information stored in session
+     * storage.
+     *
+     * @param key The key to remove from the environment information.
+     */
+    private removeFromEnvironmentInfo;
+    /**
+     * Removes the specified key from the token information.
+     *
+     * This removes the specified key from the token information stored in session
+     * storage.
+     *
+     * @param key The key to remove from the token information.
+     */
+    private removeFromTokenInfo;
+    /**
+     * Retrieves the organization information from local storage.
+     *
+     * @returns The organization information object or null if it doesn't exist.
+     */
+    getOrgInfo(): any;
+    /**
+     * Saves the organization information to local storage.
+     *
+     * @param orgInfo - The organization information to store.
+     */
+    setOrgInfo(orgInfo: any): void;
+    /**
+     * Retrieves the app information from session storage.
+     *
+     * @returns The app information object or null if it doesn't exist.
+     */
+    getAppInfo(): any;
+    /**
+     * Saves the app information to session storage.
+     *
+     * @param appInfo - The app information to store.
+     */
+    setAppInfo(appInfo: any): void;
+    /**
+     * Retrieves the environment information from session storage.
+     *
+     * @returns The environment information object or null if it doesn't exist.
+     */
+    getEnvironmentInfo(): any;
+    /**
+     * Saves the environment information to session storage.
+     *
+     * @param envInfo - The environment information to store.
+     */
+    setEnvironmentInfo(envInfo: any): void;
+    /**
+     * Retrieves the token information from session storage.
+     *
+     * @returns The token information object or null if it doesn't exist.
+     */
+    getTokenInfo(): any;
+    /**
+     * Saves the token information to session storage.
+     *
+     * @param tokenInfo - The token information to store.
+     */
+    setTokenInfo(tokenInfo: any): void;
+    /**
+     * Retrieves the user information from local storage.
+     *
+     * @returns The user information object or null if it doesn't exist.
+     */
+    getUserInfo(): any;
+    /**
+     * Sets the user information in local storage.
+     *
+     * @param userInfo The user information to store.
+     */
+    setUserInfo(userInfo: any): void;
+    /**
+     * Sets a key-value pair in local storage.
+     *
+     * @param key The key to store the value under.
+     * @param data The value to store.
+     */
+    setLocal(key: string, data: any): void;
+    /**
+     * Retrieves a value from local storage by key.
+     *
+     * @param key The key associated with the value to retrieve.
+     * @returns The value stored in local storage, or null if it doesn't exist.
+     */
+    getLocal(key: string): any;
+    /**
+     * Removes a key-value pair from local storage.
+     *
+     * @param key The key associated with the value to remove.
+     */
+    removeLocal(key: string): void;
+    /**
+     * Clears all local storage data.
+     */
+    clearLocal(): void;
+    /**
+     * Sets a key-value pair in session storage.
+     *
+     * @param key The key to store the value under.
+     * @param data The value to store.
+     */
+    setSession(key: string, data: any): void;
+    /**
+     * Retrieves a value from session storage by key.
+     *
+     * @param key The key associated with the value to retrieve.
+     * @returns The value stored in session storage, or null if it doesn't exist.
+     */
+    getSession(key: string): any;
+    /**
+     * Removes a key-value pair from session storage.
+     *
+     * @param key The key associated with the value to remove.
+     */
+    removeSession(key: string): void;
+    /**
+     * Clears all session storage data.
+     */
+    clearSession(): void;
+    /**
+     * Clears all authentication-related data from local and session storage.
+     *
+     * This method is typically used after a user logs out.
+     */
+    clearAuth(): void;
+    /**
+     * Generic getter method for retrieving data from either local or session storage.
+     *
+     * @param storage The type of storage to retrieve from.
+     * @param key The key associated with the data to retrieve.
+     * @returns The retrieved data, deserialized from JSON if it was stored as a string.
+     */
+    private getFromStorage;
+    /**
+     * Sets a key-value pair in the specified storage type.
+     *
+     * @param storage The type of storage to use (local or session).
+     * @param key The key under which the data should be stored.
+     * @param data The data to store.
+     */
+    private setToStorage;
+    /**
+     * Removes a key-value pair from the specified storage type.
+     *
+     * This method removes the given key from either local or session storage
+     * based on the specified storage type.
+     *
+     * @param storage The type of storage to remove from (local or session).
+     * @param key The key associated with the value to remove.
+     */
+    private removeFromStorage;
+    /**
+     * Clears all key-value pairs from the specified storage type.
+     *
+     * This method clears all key-value pairs from either local or session storage
+     * based on the specified storage type.
+     *
+     * @param storage The type of storage to clear (local or session).
+     */
+    private clearStorage;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StoreService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<StoreService>;
+}

package/lib/tab-sdk.service.d.ts

@@ -1,19 +1,35 @@
 import { Injector } from '@angular/core';
-import { DataService } from './data/data.service';
+import { MetadataHelper } from '@techextensor/tab-core-utility';
 import { UiService } from './ui/ui.service';
+import { AuthUtilService } from './auth/auth.service';
 import { FormService } from './ui/form.service';
-import { AuthService } from './core/auth.service';
-import { UtilsService } from './common/utils.service';
-import { MetadataHelper } from '@techextensor/tab-core-utility';
+import { TransitionService } from './workflow/transition.service';
+import { AppService } from './app/app.service';
+import { FileService } from './app/file.service';
+import { ReportService } from './app/report.service';
+import { ReleaseService } from './app/release.service';
+import { AnalyticsService } from './app/analytics.service';
+import { TranslatorService } from './app/translator.service';
+import { CrudService } from './crud/crud.service';
+import { HttpService } from './http/http.service';
+import { StoreService } from './store/store.service';
 import * as i0 from "@angular/core";
 export declare class TabSdk {
-    static data: DataService;
+    static app: AppService;
+    static auth: AuthUtilService;
     static ui: UiService;
     static form: FormService;
-    static auth: AuthService;
-    static utils: UtilsService;
+    static transition: TransitionService;
     static metadataUtils: MetadataHelper;
-    static context: any;
+    static file: FileService;
+    static report: ReportService;
+    static release: ReleaseService;
+    static analytics: AnalyticsService;
+    static translator: TranslatorService;
+    static crud: CrudService;
+    static http: HttpService;
+    static store: StoreService;
+    static util: any;
     /**
      * Initialize the SDK with necessary services
      */