@tagsamurai/fats-api-services 1.0.3-alpha.41 → 1.0.3-alpha.43

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tagsamurai/fats-api-services",
-  "version": "1.0.3-alpha.41",
+  "version": "1.0.3-alpha.43",
   "author": "developer.tagsamurai",
   "description": "Fixed Asset Tag Samurai Services Library",
   "module": "./api-services.es.js",

package/src/dto/riskRegister.dto.d.ts

@@ -0,0 +1,19 @@
+import { QueryParams } from '../types/fetchResponse.type';
+export interface GetRiskQuery extends QueryParams {
+    page?: string;
+    limit?: string;
+    sortBy?: string;
+    sortOrder?: string;
+    search?: string;
+    type?: string;
+    status?: boolean;
+    dataType?: string;
+    isRequired?: string;
+    category?: string;
+    _id?: string;
+}
+export interface GetRiskOptionsQuery extends QueryParams {
+    category?: boolean;
+    riskLevel?: boolean;
+    status?: boolean;
+}

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

@@ -0,0 +1,16 @@
+import { AxiosResponse } from 'axios';
+import { CancelForm, RiskForm, RiskLog, RiskOptions, RiskReview, RiskType } from '../types/risk.type';
+import { FetchDetailResponse, FetchListResponse, FetchResponse } from '../types/fetchResponse.type';
+import { GetRiskOptionsQuery, GetRiskQuery } from '../dto/riskRegister.dto';
+declare const RiskRegisterServices: {
+    getRisk: (params: GetRiskQuery) => Promise<AxiosResponse<FetchListResponse<RiskType>>>;
+    getRiskLogs: (id: string) => Promise<AxiosResponse<FetchListResponse<RiskLog[]>>>;
+    getRiskOptions: (params: GetRiskOptionsQuery) => Promise<AxiosResponse<FetchDetailResponse<RiskOptions>>>;
+    getRiskReview: (id: string) => Promise<AxiosResponse<FetchDetailResponse<RiskReview>>>;
+    postRisk: (data: RiskForm) => Promise<AxiosResponse<FetchResponse>>;
+    editRisk: (data: RiskForm) => Promise<AxiosResponse<FetchResponse>>;
+    cancelRisk: (id: string, data: CancelForm) => Promise<AxiosResponse<FetchResponse>>;
+    verifyRisk: (id: string, data: RiskForm) => Promise<AxiosResponse<FetchResponse>>;
+    reopenRisk: (id: string, data: RiskForm) => Promise<AxiosResponse<FetchResponse>>;
+};
+export default RiskRegisterServices;

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

@@ -0,0 +1,55 @@
+import { Option } from './options.type';
+export interface RiskType {
+    _id: string;
+    riskName: string;
+    cause: string;
+    impact: string;
+    category: 'Operational' | 'Financial' | 'Compliance' | 'Safety' | 'Environment' | 'Technology';
+    likelihoodSeverity: number;
+    impactSeverity: number;
+    riskLevel: 'Low' | 'Medium' | 'High' | 'Critical';
+    mitigation: string;
+    targetDate: string;
+    status: 'Waiting for Review' | 'In Progress' | 'Overdue' | 'Completed' | 'Canceled';
+    personInCharge: string;
+    lastModified: string;
+}
+export interface RiskReview extends Omit<RiskType, 'likelihoodSeverity' | 'impactSeverity' | 'targetDate' | 'status' | 'lastModified'> {
+    proofDocument: File;
+    note?: string;
+    reopenNote?: string;
+}
+export interface RiskLog {
+    _id: string;
+    riskName: string;
+    cause: string;
+    impact: string;
+    category: string;
+    likelihoodSeverity: number;
+    impactSeverity: number;
+    mitigation: string;
+    targetDate: string;
+    personInCharge: string;
+    lastModified: string;
+    proofDocument?: File;
+    note?: string;
+    action: 'created' | 'edited';
+}
+export interface RiskOptions {
+    category?: Option[];
+}
+export interface RiskForm {
+    riskName: string;
+    cause: string;
+    impact: string;
+    mitigation: string;
+    category: string;
+    likelihoodSeverity: number;
+    impactSeverity: number;
+    initialDate: string;
+    personInCharge?: string;
+    note?: string;
+}
+export interface CancelForm {
+    note: string;
+}