@tagsamurai/gsts-api-services 2.0.1-alpha.3 → 2.0.1-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tagsamurai/gsts-api-services",
-  "version": "2.0.1-alpha.3",
+  "version": "2.0.1-alpha.5",
   "author": "developer.tagsamurai",
   "description": "Global Settings Tag Samurai Services Library",
   "module": "./api-services.es.js",

package/src/dto/iam.dto.d.ts

@@ -0,0 +1,85 @@
+import { QueryParams } from '../types/fetchResponse.type';
+import { ModuleAccess } from '../types/iam.type';
+export interface LoginPayload {
+    email: string;
+    password: string | null;
+    overrideSession: boolean;
+    isMobile: boolean;
+    otp: string | null;
+    captcha: string;
+    agreePolicy: boolean;
+}
+export interface SetPasswordPayload {
+    type: 'confirm' | 'reset';
+    token: string;
+    password: string;
+}
+export interface BaseParams extends QueryParams {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sortBy?: string;
+    sortOrder?: number;
+    column?: string[];
+}
+export interface GetPositionListParams extends BaseParams {
+}
+export interface CreateEditPositionPayload {
+    name: string;
+}
+export interface GetDivisionListParams extends BaseParams {
+}
+export interface CreateEditDivisionPayload {
+    name: string;
+}
+export interface CreateUserPayload {
+    profilePicture?: File | string;
+    firstName: string;
+    lastName: string;
+    positionId?: string;
+    divisionId: string;
+    employeeId?: string;
+    email: string;
+    access: string;
+    expiryDate?: string;
+    tag?: string;
+}
+export interface GetGlobalUserListParams extends BaseParams {
+    isActive?: boolean[];
+    position?: string[];
+    division?: string[];
+    modifiedBy?: string[];
+    updatedAt?: string[];
+}
+export type GetGlobalUserOptionsParams = {
+    isActiveOptions?: boolean;
+    positionOptions?: boolean;
+    divisionOptions?: boolean;
+    modifiedByOptions?: boolean;
+};
+export interface SetActiveGlobalUserPayload {
+    isActive: boolean;
+}
+export interface EditUserPayload extends CreateUserPayload {
+}
+export interface EditUserFcmTokenPayload {
+    data: {
+        userId: string;
+        token: string;
+    }[];
+}
+export interface ResendActivationEmailPayload {
+    ids: string[];
+}
+export interface ChangePasswordPayload {
+    oldPassword: string;
+    newPassword: string;
+}
+export interface ModuleAuthPayload {
+    module: ModuleAccess;
+}
+export interface GetConcurrentUsersParams extends BaseParams {
+}
+export interface LogoutSessionPayload {
+    sessionId: string;
+}

package/src/services/iam.service.d.ts

@@ -0,0 +1,45 @@
+import { AxiosResponse } from 'axios';
+import { DropdownOption } from '../types/options.type';
+import { FetchDetailResponse, FetchListResponse } from '../types/fetchResponse.type';
+import { CreateEditDivisionPayload, CreateEditPositionPayload, GetDivisionListParams, GetPositionListParams, LoginPayload, SetPasswordPayload, CreateUserPayload, GetGlobalUserListParams, GetGlobalUserOptionsParams, SetActiveGlobalUserPayload, EditUserPayload, EditUserFcmTokenPayload, ResendActivationEmailPayload, ChangePasswordPayload, ModuleAuthPayload, GetConcurrentUsersParams, LogoutSessionPayload } from '../dto/iam.dto';
+import { PositionList, LoginResponse, RequestOtpResponse, RequestResetLinkResponse, DivisionList, DivisionListDetail, GlobalUserList, GlobalUserOptions, GlobalUserDetail, LoginModuleResponse, ConcurrentUserList, VerifyTokenResponse, PositionDetail, ChangePasswordResponse } from '../types/iam.type';
+declare const IamServices: {
+    login: (payload: LoginPayload) => Promise<AxiosResponse<FetchDetailResponse<LoginResponse>>>;
+    logout: () => Promise<AxiosResponse>;
+    verifyToken: (token: string) => Promise<AxiosResponse<FetchDetailResponse<VerifyTokenResponse>>>;
+    requestOtp: (email: string) => Promise<AxiosResponse<RequestOtpResponse>>;
+    requestResetLink: (email: string) => Promise<AxiosResponse<RequestResetLinkResponse>>;
+    setPassword: (payload: SetPasswordPayload) => Promise<AxiosResponse>;
+    confirmEmailChange: (token: string) => Promise<AxiosResponse>;
+    cancelEmailChange: (token: string) => Promise<AxiosResponse>;
+    getPositionList: (params: GetPositionListParams) => Promise<AxiosResponse<FetchListResponse<PositionList>>>;
+    getPositionDetail: (id: string) => Promise<AxiosResponse<FetchDetailResponse<PositionDetail>>>;
+    createPosition: (payload: CreateEditPositionPayload) => Promise<AxiosResponse>;
+    editPosition: (id: string, payload: CreateEditPositionPayload) => Promise<AxiosResponse>;
+    deletePosition: (ids: string[]) => Promise<AxiosResponse>;
+    getDivisionList: (params: GetDivisionListParams) => Promise<AxiosResponse<FetchListResponse<DivisionList>>>;
+    getDivisionDetail: (id: string) => Promise<AxiosResponse<FetchDetailResponse<DivisionListDetail>>>;
+    createDivision: (payload: CreateEditDivisionPayload) => Promise<AxiosResponse>;
+    editDivision: (id: string, payload: CreateEditDivisionPayload) => Promise<AxiosResponse>;
+    deleteDivision: (ids: string[]) => Promise<AxiosResponse>;
+    createUsers: (payload: CreateUserPayload) => Promise<AxiosResponse>;
+    getGlobalUserList: (params: GetGlobalUserListParams) => Promise<AxiosResponse<FetchListResponse<GlobalUserList>>>;
+    getGlobalUserOptions: (params: GetGlobalUserOptionsParams) => Promise<AxiosResponse<FetchDetailResponse<GlobalUserOptions>>>;
+    getGlobalUserDetail: (id: string) => Promise<AxiosResponse<FetchDetailResponse<GlobalUserDetail>>>;
+    setActiveGlobalUser: (ids: string[], payload: SetActiveGlobalUserPayload) => Promise<AxiosResponse>;
+    editUsers: (id: string, payload: EditUserPayload) => Promise<AxiosResponse>;
+    editUsersFcmToken: (payload: EditUserFcmTokenPayload) => Promise<AxiosResponse>;
+    resendActivationEmail: (payload: ResendActivationEmailPayload) => Promise<AxiosResponse>;
+    changePassword: (id: string, payload: ChangePasswordPayload) => Promise<AxiosResponse<ChangePasswordResponse>>;
+    deleteUsers: (ids: string[]) => Promise<AxiosResponse>;
+    logoutModule: (payload: ModuleAuthPayload) => Promise<AxiosResponse>;
+    loginModule: (payload: ModuleAuthPayload) => Promise<AxiosResponse<FetchDetailResponse<LoginModuleResponse>>>;
+    getConcurrentUsers: (params: GetConcurrentUsersParams, moduleId?: string) => Promise<AxiosResponse<FetchDetailResponse<ConcurrentUserList>>>;
+    logoutSession: (payload: LogoutSessionPayload, moduleId?: string) => Promise<AxiosResponse>;
+    getPositionDropdown: () => Promise<AxiosResponse<FetchDetailResponse<DropdownOption[]>>>;
+    getDivisionDropdown: () => Promise<AxiosResponse<FetchDetailResponse<DropdownOption[]>>>;
+    exportPositionTable: () => Promise<AxiosResponse<Blob>>;
+    exportDivisionTable: () => Promise<AxiosResponse<Blob>>;
+    exportUserTable: () => Promise<AxiosResponse<Blob>>;
+};
+export default IamServices;

package/src/types/iam.type.d.ts

@@ -0,0 +1,143 @@
+import { MultiSelectOption } from './options.type';
+export interface LoginResponse {
+    _id: string;
+    companyName: string;
+    companyCode: string;
+    fullName: string;
+    profilePicture: string;
+    email: string;
+    isDefault: boolean;
+    access: string[];
+    generalSetting: {
+        dateFormat: string;
+        timeFormat: string;
+        timezone: string;
+        currency: {
+            currency: string;
+            symbol: string;
+            locale: string;
+            label: string;
+        };
+    };
+}
+type BaseMessage = string & {};
+export interface VerifyTokenResponse {
+    message: 'Token Verified!' | 'Token not found' | 'Internal server error' | BaseMessage;
+    data: boolean;
+}
+interface BaseResponse<TMessage> {
+    status: number;
+    message: TMessage;
+    data?: boolean;
+}
+export type RequestResetLinkMessage = 'EMAIL_NOT_REGISTERED' | BaseMessage;
+export type RequestOtpMessage = 'Successfully requested otp' | 'EMAIL_NOT_REGISTERED' | 'INACTIVE_USER' | BaseMessage;
+export interface RequestResetLinkResponse extends BaseResponse<RequestResetLinkMessage> {
+}
+export interface RequestOtpResponse extends BaseResponse<RequestOtpMessage> {
+}
+interface BasePosition {
+    _id: string;
+    name: string;
+}
+export interface PositionList extends BasePosition {
+    inUse: boolean;
+}
+export interface PositionDetail extends BasePosition {
+}
+interface BaseDivision {
+    _id: string;
+    name: string;
+}
+export interface DivisionList extends BaseDivision {
+    inUse: boolean;
+}
+export interface DivisionListDetail extends BaseDivision {
+}
+export interface ChangePasswordResponse {
+    status?: number;
+    message?: 'INCORRECT_PASSWORD' | BaseMessage;
+}
+export interface GlobalUserList {
+    _id: string;
+    isActive: boolean;
+    isDefault: boolean;
+    profilePicture: string | null;
+    fullName: string;
+    email: string;
+    position: string | null;
+    division: string;
+    employeeId: string | null;
+    modifiedBy: string;
+    updatedAt: string;
+    pendingApproval: number;
+    assignedAssets: number;
+    borrowedAssets: number;
+    isEmailConfirmed: boolean;
+}
+export interface GlobalUserOptions {
+    isActiveOptions: {
+        label: string;
+        value: boolean;
+    }[];
+    positionOptions: MultiSelectOption[];
+    divisionOptions: MultiSelectOption[];
+    modifiedByOptions: MultiSelectOption[];
+}
+export type ModuleAccess = 'Global Settings' | 'Fixed Asset' | 'Supply Asset' | 'Admin Console';
+export interface GlobalUserDetail {
+    _id: string;
+    isActive: boolean;
+    isDefault: boolean;
+    isEmailConfirmed: boolean;
+    profilePicture: string | null;
+    userTag: string | null;
+    userType: string;
+    firstName: string;
+    lastName: string;
+    fullName: string;
+    email: string;
+    pendingEmailChange: string | null;
+    position: string | null;
+    division: string;
+    employeeId: string | null;
+    expiryDate: string | null;
+    access: (ModuleAccess | BaseMessage)[];
+}
+export interface LoginModuleResponse extends LoginResponse {
+    isTotalControl: boolean;
+    isReadOnly: boolean;
+    plan: string;
+    addOn: Record<string, boolean>;
+    systemRoles: Record<string, {
+        create: boolean;
+        view: boolean;
+        update: boolean;
+        delete: boolean;
+    }>;
+    transactionRoles: Record<string, {
+        manager: boolean;
+        monitoringReport: boolean;
+        approver: boolean;
+        staff: boolean;
+    }>;
+    generalSetting: LoginResponse['generalSetting'] & {
+        geolocation: boolean;
+    };
+}
+export interface ConcurrentUser {
+    _id: string;
+    profilePicture: string;
+    name: string;
+    email: string;
+    userType: string;
+    position: string;
+    division: string;
+    lastLogin: string;
+}
+export interface ConcurrentUserList {
+    moduleId: string;
+    activeSessions: ConcurrentUser[];
+    count: number;
+}
+export {};