@automateinc/fleet-types 1.0.0 → 1.0.2

package/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+	"extends": "@404-software/eslint-config",
+	"rules": {
+		"prettier/prettier": [
+			"error",
+			{
+				"bracketSameLine": false,
+				"arrowParens": "avoid",
+				"quoteProps": "as-needed",
+				"singleQuote": false,
+				"trailingComma": "all",
+				"useTabs": true,
+				"bracketSpacing": true,
+				"tabWidth": 2,
+				"semi": true,
+				"jsxSingleQuote": false,
+				"printWidth": 120,
+				"endOfLine": "auto"
+			}
+		],
+		"no-console": "off",
+		"@typescript-eslint/no-explicit-any": "off",
+		"@typescript-eslint/no-empty-function": "off"
+	}
+}

package/.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged
+

package/README.md

@@ -7,11 +7,11 @@
 To install the package, use npm:
 
 ```bash
-npm i fleet-types@https://github.com/automateinc/fleet-types.git
+npm i @automateinc/fleet-types
 ```
 
 ## Example Usage
 
 ```js
-import { IAttendance } from "fleet-types";
+import { IAttendance } from "@automateinc/fleet-types";
 ```

package/dist/types/attendance-presence-check.d.ts

@@ -1,11 +1,11 @@
 export interface IAttendancePresenceCheck {
-  id: string;
-  createdAt: string;
-  updatedAt: string;
-  
-  status: "PENDING" | "CONFIRMED" | "EXPIRED";
-  createdBy: "USER" | "SYSTEM";
-  attendanceId: string;
-  userId?: string;
-  imageId?: string;
-  }
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	status: "PENDING" | "CONFIRMED" | "EXPIRED";
+	createdBy: "USER" | "SYSTEM";
+	attendanceId: string;
+	userId?: string;
+	imageId?: string;
+}

package/dist/types/attendance.d.ts

@@ -1,4 +1,4 @@
-import { IAttendanceLeaveReason, ICoords, IEmployee, IFile } from ".";
+import { IAttendanceLeaveReason, ICoords, IFile } from ".";
 
 export interface IAttendance {
 	id: string;

package/dist/types/employee-monthly-payroll.d.ts

@@ -0,0 +1,62 @@
+interface Value<T = number> {
+	format?: string;
+	value: T;
+	postfix?: string;
+	defaultHidden?: boolean;
+}
+
+export interface EmployeeMonthlyPayroll {
+	status: Value<string>;
+	company: Value<string>;
+	role: Value<string>;
+	salaryHold: Value<boolean>;
+	contractStartDate: Value<string>;
+	contractType: Value<string>;
+	totalAllowances: Value;
+	otherPay: Value;
+	fixedAllowances: Value;
+	foodAllowances: Value;
+	daysOffOvertime: Value;
+	daysOffOvertimeAllowance: Value;
+	siteAllowances: Value;
+	monthlyDays: Value;
+	maxNormalHours: Value;
+	increments: Value;
+	dailyTransportAndRiskAllowances: Value;
+	dailyTeamLeaderAllowance: Value;
+	dailySiteAllowances: Value;
+	dailyShiftAllowances: Value;
+	dailyOtherPay: Value;
+	dailyFixedAllowances: Value;
+	performanceIncrement: Value;
+	otherIncrements: Value;
+	dailyOtherAllowances: Value;
+	basicSalary: Value;
+	totalGrossSalary: Value;
+	totalNetPay: Value;
+	contractualDailyHours: Value;
+	totalAbsentDays: Value;
+	totalWorkedDays: Value;
+	sickLeaveDays: Value;
+	totalHours: Value;
+	normalHours: Value;
+	overtimeHours: Value;
+	dailyRate: Value;
+	hourlyRate: Value;
+	normalPay: Value;
+	overtimePay: Value;
+	normalRatio: Value;
+	overtimeRatio: Value;
+	SIODeductions: Value;
+	adjustmentsPlus: Value;
+	adjustmentsMinus: Value;
+	otherDeductions: Value;
+	totalDeductions: Value;
+	contractTotalSalary: Value;
+	iban: Value<string>;
+	retired: Value<boolean>;
+	bankTransfer: Value;
+	bankUpload1: Value;
+	bankUpload2: Value;
+	cashPayment: Value;
+}

package/dist/types/index.d.ts

@@ -44,6 +44,7 @@ export * from "./dispatch-count";
 export * from "./employee";
 export * from "./nfc-tag";
 export * from "./employee-status";
+export * from "./employee-monthly-payroll";
 export * from "./region";
 export * from "./request";
 export * from "./request-verification";

package/dist/types/metadata.d.ts

@@ -2,13 +2,21 @@ import { IMetadataDocuments, IMetadataExpiringDocuments, IMetadataMissingDocumen
 
 export interface IMetadata {
 	expiringDocuments?: {
-		[key: string]: IMetadataExpiringDocuments;
+		[key: PropertyKey]: IMetadataExpiringDocuments;
 	};
 	statusCheck?: IMetadataStatusCheck;
 	documents?: {
-		[key: string]: IMetadataDocuments;
+		[key: PropertyKey]: IMetadataDocuments;
 	};
 	missingDocuments?: {
-		[key: string]: IMetadataMissingDocuments;
+		[key: PropertyKey]: IMetadataMissingDocuments;
+	};
+	fields?: {
+		[key: PropertyKey]: any;
+	};
+	payroll?: {
+		iban: string;
+		increment: number;
+		contractType: "TRANSFER" | "CASH" | "CHECK" | "UNPAID" | "FORSA" | "OTHER";
 	};
 }

package/dist/types/recruitment-national-card-information.d.ts

@@ -1,5 +1,3 @@
-import { IFile } from ".";
-
 export interface IRecruitmentNationalCardInformation {
 	id: string;
 	createdAt: string;

package/dist/types/request-value.d.ts

@@ -6,9 +6,12 @@ export interface IRequestValue {
 	name: string;
 	value: any;
 	model?: IModel;
+	config?: {
+		[key: PropertyKey]: any;
+	};
 	required?: boolean;
 	relation?: {
-		[key: string]: any;
+		[key: PropertyKey]: any;
 	};
 	relationValue?: string;
 	file?: IFile;

package/dist/types/request.d.ts

@@ -17,6 +17,9 @@ export interface IRequest {
 	verifiedById?: string;
 	rejectedById?: string;
 	withdrawnAt?: string;
+	folderKey?: string | null;
+	archivedAt?: string | null;
+	employeeId: string;
 	status: "PENDING_APPROVAL" | "APPROVED" | "REJECTED" | "WITHDRAWN" | "PENDING_VERIFICATION" | "ARCHIVED";
 	actionsExecutionStatus: "PENDING" | "COMPLETED" | "PROCESSING" | "FAILED" | "SKIPPED";
 }

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@automateinc/fleet-types",
   "private": false,
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Reusable TypeScript types and interfaces for Fleet API.",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
   "scripts": {
+    "prepare": "husky install",
     "build": "tsc && cp -R src/types dist/",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "eslintConfig": {
+    "extends": "@404-software/eslint-config"
+  },
   "keywords": [
     "typescript",
     "types",
@@ -22,10 +26,19 @@
   "author": "Automate Inc. <hello@automate.bh> (https://automate.bh)",
   "license": "MIT",
   "devDependencies": {
+    "@404-software/eslint-config": "^1.0.20",
     "@tanstack/react-query": "^4.36.1",
     "axios": "^1.7.9",
+    "eslint": "^8.18.0",
+    "husky": "^9.1.7",
+    "prettier": "^2.7.1",
     "typescript": "5.1.6"
   },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "eslint --fix"
+    ]
+  },
   "dependencies": {
     "asynckit": "^0.4.0",
     "combined-stream": "^1.0.8",