@automateinc/fleet-types 1.0.59 → 1.0.60-dev.e967155

package/.github/workflows/publish.yml

@@ -3,7 +3,11 @@ name: Publish Package to npmjs
 on:
   push:
     branches:
-      - "**"  # all branches
+      - "**" # all branches
+
+permissions:
+  id-token: write # Required for OIDC
+  contents: read
 
 jobs:
   publish:
@@ -17,8 +21,8 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
 
       - run: npm install -g semver
 
@@ -46,9 +50,8 @@ jobs:
       - run: npm ci
 
       - name: Publish to npm
-        run: npm publish --provenance --access public --tag $( [[ "${{ github.ref_name }}" == "main" ]] && echo "latest" || echo "dev" )
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm install -g npm@latest
+      - run: npm publish --provenance --access public --tag $( [[ "${{ github.ref_name }}" == "main" ]] && echo "latest" || echo "dev" )
 
       - name: Output Published Version
         run: 'echo "📦 Published version: ${{ steps.bump.outputs.version }}"'

package/.husky/pre-commit

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

package/.vscode/settings.json

@@ -0,0 +1,47 @@
+{
+	"[javascript]": {
+		"editor.codeActionsOnSave": {
+			"source.fixAll.biome": "explicit",
+			"source.organizeImports.biome": "explicit"
+		},
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[javascriptreact]": {
+		"editor.codeActionsOnSave": {
+			"source.fixAll.biome": "explicit",
+			"source.organizeImports.biome": "explicit"
+		},
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[json]": {
+		"editor.defaultFormatter": "vscode.json-language-features"
+	},
+	"[jsonc]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[sql]": {
+		"editor.formatOnSave": false
+	},
+	"[typescript]": {
+		"editor.codeActionsOnSave": {
+			"source.fixAll.biome": "explicit",
+			"source.organizeImports.biome": "explicit"
+		},
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[typescriptreact]": {
+		"editor.codeActionsOnSave": {
+			"source.fixAll.biome": "explicit",
+			"source.organizeImports.biome": "explicit"
+		},
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"biome.enabled": true,
+	"biome.lsp.bin": "./node_modules/.bin/biome",
+	"editor.codeActionsOnSave": {
+		"source.fixAll.biome": "explicit",
+		"source.organizeImports.biome": "explicit"
+	},
+	"editor.defaultFormatter": "biomejs.biome",
+	"editor.formatOnSave": true
+}

package/biome.json

@@ -0,0 +1,3 @@
+{
+	"extends": ["@automateinc/biomejs/config"]
+}

package/dist/types/attendance-patrol.d.ts

@@ -3,7 +3,7 @@ export interface IAttendancePatrol {
 	createdAt: string;
 	updatedAt?: string;
 
-	status?: 'PENDING' | 'COMPLETED' | 'ON_HOLD';
+	status?: "PENDING" | "COMPLETED" | "ON_HOLD";
 
 	patrolId: string;
 	attendanceId: string;

package/dist/types/cluster-patrol.d.ts

@@ -3,7 +3,7 @@ export interface IClusterPatrol {
 	createdAt: string;
 	updatedAt?: string;
 
-	status?: 'PENDING' | 'COMPLETED' | 'ON_HOLD';
+	status?: "PENDING" | "COMPLETED" | "ON_HOLD";
 
 	patrolId: string;
 	date: string;

package/dist/types/employee-group.d.ts

@@ -0,0 +1,11 @@
+export interface IEmployeeGroup {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+
+	title: string;
+	nationalities: string[];
+
+	regionId: string;
+	metadata?: any;
+}

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

@@ -1,62 +1,28 @@
-interface Value<T = number> {
-	format?: string;
-	value: T;
-	postfix?: string;
-	defaultHidden?: boolean;
-}
-
 export interface IEmployeeMonthlyPayroll {
-	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;
+	id: string;
+	updatedAt: string;
+	createdAt: string;
+
+	status: "PENDING" | "APPROVED" | "PROCESSED";
+
+	metadata?: any;
+	payroll: {
+		outputs: {
+			[key: string]: any;
+		};
+		metrics: {
+			[key: string]: any;
+		};
+		warnings: {
+			[key: string]: boolean;
+		};
+	};
+	formatted: Record<
+		string,
+		{
+			id: string;
+			title: string;
+			value: any;
+		}
+	>;
 }

package/dist/types/index.d.ts

@@ -1,13 +1,13 @@
-import { AxiosError } from "axios";
 import { UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
+import { AxiosError } from "axios";
 
 type APIError = {
 	error:
-	| string
-	| Array<{
-		message: string;
-		field: string;
-	}>;
+		| string
+		| Array<{
+				message: string;
+				field: string;
+		  }>;
 };
 
 export type MutationOptions<Response, Args = void> = UseMutationOptions<Response, AxiosError<APIError>, Args, any>;
@@ -34,141 +34,169 @@ export type PaginatedResponse<T> = {
 };
 
 export * from "./api-key";
+export * from "./asset";
+export * from "./asset-category";
+export * from "./asset-category-field";
+export * from "./asset-type";
+export * from "./asset-value";
 export * from "./attendance";
 export * from "./attendance-action";
-export * from "./attendance-presence-check";
 export * from "./attendance-count";
+export * from "./attendance-draft";
+export * from "./attendance-draft";
+export * from "./attendance-leave-reason";
+export * from "./attendance-patrol";
+export * from "./attendance-patrol";
+export * from "./attendance-patrol-point";
+export * from "./attendance-patrol-point";
+export * from "./attendance-presence-check";
+export * from "./building";
+export * from "./building-contact";
+export * from "./building-lease";
+export * from "./building-lease-payment";
+export * from "./bunk";
+export * from "./call-log";
+export * from "./call-log";
+export * from "./ceiling";
+export * from "./client";
+export * from "./client";
+export * from "./client-class";
+export * from "./client-class";
+export * from "./client-contact";
+export * from "./client-contact";
+export * from "./client-contract";
+export * from "./client-contract";
+export * from "./client-site";
+export * from "./client-site";
+export * from "./cluster-patrol";
+export * from "./cluster-patrol";
+export * from "./cluster-patrol-point";
+export * from "./cluster-patrol-point";
 export * from "./company";
+export * from "./company-file";
+export * from "./company-file";
+export * from "./config";
+export * from "./contact";
 export * from "./contract";
+export * from "./contract-allowance";
+export * from "./contract-benefit";
+export * from "./contract-deduction";
+export * from "./coords";
+export * from "./day-of-week";
+export * from "./day-of-week";
 export * from "./dispatch";
 export * from "./dispatch-attendance";
 export * from "./dispatch-count";
 export * from "./employee";
+export * from "./employee-comment";
+export * from "./employee-comment-reaction";
+export * from "./employee-event";
+export * from "./employee-event";
 export * from "./employee-field";
-export * from "./nfc-tag";
-export * from "./employee-status";
+export * from "./employee-group";
+export * from "./employee-group";
+export * from "./employee-label";
+export * from "./employee-label";
+export * from "./employee-label-assignment";
+export * from "./employee-label-assignment";
 export * from "./employee-monthly-payroll";
-export * from "./region";
-export * from "./request";
-export * from "./request-verification";
-export * from "./restriction";
-export * from "./request-category";
-export * from "./contact";
-export * from "./request-category-field";
-export * from "./request-type";
+export * from "./employee-status";
+export * from "./file";
+export * from "./gender";
+export * from "./leave";
+export * from "./leave";
+export * from "./leave-event";
+export * from "./leave-event";
+export * from "./leave-type";
+export * from "./leave-type";
+export * from "./loan";
+export * from "./loan-installment";
+export * from "./metadata";
+export * from "./metadata-documents";
+export * from "./metadata-expiring-documents";
+export * from "./metadata-missing-documents";
+export * from "./metadata-status-check";
 export * from "./models";
-export * from "./role";
-export * from "./schedule";
-export * from "./schedule-draft";
-export * from "./ceiling";
-export * from "./request-value";
-export * from "./team";
-export * from "./user";
+export * from "./nfc-tag";
+export * from "./notification";
+export * from "./notification";
+export * from "./notification-token";
+export * from "./notification-token";
+export * from "./one-time-password";
+export * from "./patrol";
+export * from "./patrol";
+export * from "./patrol-point";
+export * from "./patrol-point";
+export * from "./payment-cycle";
+export * from "./payment-cycle-config";
+export * from "./payment-cycle-config";
+export * from "./payroll-config";
+export * from "./payroll-config";
+export * from "./permission";
+export * from "./permission-group";
+export * from "./phone-line";
+export * from "./phone-line-commitment";
+export * from "./phone-line-contract";
+export * from "./phone-line-package";
+export * from "./position";
+export * from "./position-template";
+export * from "./position-template";
+export * from "./position-template-item";
+export * from "./position-template-item";
+export * from "./position-version";
 export * from "./recruitment";
-export * from "./recruitment-employment-information-history";
 export * from "./recruitment-employment-information";
+export * from "./recruitment-employment-information-history";
 export * from "./recruitment-medical-information";
+export * from "./recruitment-national-card-information";
 export * from "./recruitment-other-information";
+export * from "./recruitment-other-information-additional-information";
 export * from "./recruitment-passport-information";
-export * from "./recruitment-visa-information";
 export * from "./recruitment-personal-information";
-export * from "./file";
-export * from "./gender";
+export * from "./recruitment-visa-information";
+export * from "./region";
+export * from "./report";
+export * from "./report-category";
+export * from "./report-category-field";
+export * from "./report-comment";
+export * from "./report-comment-reaction";
+export * from "./report-type";
+export * from "./report-value";
+export * from "./request";
 export * from "./request-action";
 export * from "./request-action-execution";
-export * from "./signing-mode";
-export * from "./recruitment-other-information-additional-information";
-export * from "./recruitment-national-card-information";
-export * from "./client-class";
-export * from "./client";
-export * from "./client-contact";
-export * from "./client-site";
-export * from "./tag";
-export * from "./client-class";
-export * from "./client";
-export * from "./client-contact";
-export * from "./client-site";
-export * from "./zone";
+export * from "./request-category";
+export * from "./request-category-field";
+export * from "./request-type";
+export * from "./request-value";
+export * from "./request-verification";
+export * from "./restriction";
+export * from "./role";
+export * from "./schedule";
+export * from "./schedule-attendance";
+export * from "./schedule-day-off";
+export * from "./schedule-draft";
 export * from "./schedule-site";
-export * from "./position";
-export * from "./one-time-password";
-export * from "./position-version";
 export * from "./shift";
 export * from "./shift-type";
+export * from "./signing-mode";
 export * from "./standard-operating-procedure";
-export * from "./schedule-attendance";
-export * from "./coords";
-export * from "./attendance-leave-reason";
-export * from "./employee-comment";
-export * from "./employee-comment-reaction";
-export * from "./metadata";
-export * from "./metadata-expiring-documents";
-export * from "./metadata-status-check";
-export * from "./metadata-missing-documents";
-export * from "./metadata-documents";
-export * from "./config";
-export * from "./contract-allowance";
-export * from "./contract-deduction";
-export * from "./contract-benefit";
-export * from "./payment-cycle";
-export * from "./building";
-export * from "./building-lease";
-export * from "./building-lease-payment";
-export * from "./building-contact";
+export * from "./tag";
+export * from "./tag-color";
+export * from "./tag-color";
+export * from "./team";
 export * from "./unit";
 export * from "./unit-room";
-export * from "./bunk";
-export * from "./permission";
-export * from "./permission-group";
-export * from "./vendor";
-export * from "./vendor-contact";
+export * from "./user";
 export * from "./vehicle";
-export * from "./asset";
-export * from "./asset-type";
-export * from "./asset-category";
-export * from "./asset-category-field";
-export * from "./asset-value";
-export * from "./phone-line";
-export * from "./phone-line-commitment";
-export * from "./phone-line-contract";
-export * from "./phone-line-package";
-export * from "./vendor";
+export * from "./vehicle-contract";
+export * from "./vehicle-contract-payment";
+export * from "./vehicle-insurance";
 export * from "./vehicle-make";
 export * from "./vehicle-model";
 export * from "./vehicle-registration";
-export * from "./vehicle-insurance";
-export * from "./vehicle-contract";
-export * from "./vehicle-contract-payment";
 export * from "./vehicle-status";
-export * from "./loan";
-export * from "./loan-installment";
-export * from "./report";
-export * from "./report-category";
-export * from "./report-category-field";
-export * from "./report-type";
-export * from "./report-value";
-export * from "./report-comment";
-export * from "./report-comment-reaction";
-export * from "./call-log";
-export * from "./notification";
-export * from "./notification-token";
-export * from "./employee-label";
-export * from "./tag-color";
-export * from "./employee-event";
-export * from "./leave-type";
-export * from "./leave-event";
-export * from "./leave";
-export * from "./company-file";
-export * from "./employee-label-assignment";
-export * from "./patrol";
-export * from "./patrol-point";
-export * from "./attendance-patrol";
-export * from "./attendance-patrol-point";
-export * from "./position-template";
-export * from "./position-template-item";
-export * from "./day-of-week";
-export * from "./client-contract";
-export * from "./cluster-patrol";
-export * from "./cluster-patrol-point";
-export * from "./attendance-draft";
-export * from "./schedule-day-off";
+export * from "./vendor";
+export * from "./vendor";
+export * from "./vendor-contact";
+export * from "./zone";

package/dist/types/payment-cycle-config.d.ts

@@ -0,0 +1,8 @@
+export interface IPaymentCycleConfig {
+	id: string;
+	createdAt: Date;
+	from: number;
+	to: number;
+	companyId: string;
+	metadata?: any;
+}

package/dist/types/payroll-config.d.ts

@@ -0,0 +1,13 @@
+export type IPayrollConfig = {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+
+	value: any;
+
+	type: "DRAFT" | "PUBLISHED";
+
+	employeeGroupId: string;
+
+	metadata?: any;
+};

package/dist/types/schedule-day-off.d.ts

@@ -5,7 +5,7 @@ export type IScheduleDayOff = {
 	createdAt: string;
 	updatedAt?: string;
 
-	dayOfWeek: IDayOfWeek
+	dayOfWeek: IDayOfWeek;
 	employeeId: string;
 
 	metadata?: any;

package/package.json

@@ -1,43 +1,7 @@
 {
-  "name": "@automateinc/fleet-types",
-  "private": false,
-  "version": "1.0.59",
-  "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",
-    "interfaces",
-    "api"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/automateinc/fleet-types.git"
-  },
   "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"
-    ]
+  "bugs": {
+    "url": "https://github.com/automateinc/fleet-types/issues"
   },
   "dependencies": {
     "asynckit": "^0.4.0",
@@ -53,8 +17,40 @@
     "react": "^18.3.1",
     "use-sync-external-store": "^1.4.0"
   },
-  "bugs": {
-    "url": "https://github.com/automateinc/fleet-types/issues"
+  "description": "Reusable TypeScript types and interfaces for Fleet API.",
+  "devDependencies": {
+    "@automateinc/biomejs": "^0.4.3",
+    "@biomejs/biome": "^2.3.8",
+    "@tanstack/react-query": "^4.36.1",
+    "axios": "^1.7.9",
+    "husky": "^9.1.7",
+    "typescript": "5.1.6"
+  },
+  "homepage": "https://github.com/automateinc/fleet-types#readme",
+  "keywords": [
+    "typescript",
+    "types",
+    "interfaces",
+    "api"
+  ],
+  "license": "MIT",
+  "lint-staged": {
+    "src/**/*.ts": [
+      "biome ci"
+    ]
+  },
+  "main": "dist/index.js",
+  "name": "@automateinc/fleet-types",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/automateinc/fleet-types.git"
+  },
+  "scripts": {
+    "build": "tsc && cp -R src/types dist/",
+    "prepare": "husky install",
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "homepage": "https://github.com/automateinc/fleet-types#readme"
+  "types": "dist/types/index.d.ts",
+  "version": "1.0.60-dev.e967155"
 }

package/tsconfig.json

@@ -1,11 +1,11 @@
 {
-  "compilerOptions": {
-    "outDir": "./dist",
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true
-  },
-  "include": ["./**/*.ts"],
+	"compilerOptions": {
+		"declaration": true,
+		"emitDeclarationOnly": true,
+		"esModuleInterop": true,
+		"outDir": "./dist",
+		"skipLibCheck": true,
+		"strict": true
+	},
+	"include": ["./**/*.ts"]
 }

package/.eslintrc.json

@@ -1,25 +0,0 @@
-{
-	"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"
-	}
-}