@automateinc/fleet-types 1.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,147 @@
+import { AxiosError } from "axios";
+import { UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
+
+type APIError = {
+	error:
+		| string
+		| Array<{
+				message: string;
+				field: string;
+		  }>;
+};
+
+export type MutationOptions<Response, Args = void> = UseMutationOptions<Response, AxiosError<APIError>, Args, any>;
+
+export type QueryOptions<Response> = UseQueryOptions<Response, AxiosError<APIError>, Response, any>;
+
+export type InfiniteQueryOptions<Response> = Omit<
+	UseInfiniteQueryOptions<Response, AxiosError<APIError>, Response, Response, any>,
+	"queryKey" | "queryFn"
+>;
+
+export type FormInputType<T extends (...args: any) => any> = Parameters<ReturnType<T>["mutate"]>[0];
+
+export type PaginatedResponse<T> = {
+	limit: number;
+	page: number;
+	count: number;
+	exceedCount: boolean;
+	exceedTotalPages: boolean;
+	result: T[];
+	hasNextPage: boolean;
+	hasPrevPage: boolean;
+	totalPages: number;
+};
+
+export * from "./attendance";
+export * from "./attendance-presence-check";
+export * from "./attendance-count";
+export * from "./company";
+export * from "./contract";
+export * from "./dispatch";
+export * from "./dispatch-attendance";
+export * from "./dispatch-count";
+export * from "./employee";
+export * from "./nfc-tag";
+export * from "./employee-status";
+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 "./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 "./recruitment";
+export * from "./recruitment-employment-information-history";
+export * from "./recruitment-employment-information";
+export * from "./recruitment-medical-information";
+export * from "./recruitment-other-information";
+export * from "./recruitment-passport-information";
+export * from "./recruitment-visa-information";
+export * from "./recruitment-personal-information";
+export * from "./file";
+export * from "./gender";
+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 "./schedule-site";
+export * from "./position";
+export * from "./one-time-password";
+export * from "./position-version";
+export * from "./shift";
+export * from "./shift-type";
+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 "./unit";
+export * from "./unit-room";
+export * from "./bunk";
+export * from "./permission";
+export * from "./permission-group";
+export * from "./vendor";
+export * from "./vendor-contact";
+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-make";
+export * from "./vehicle-model";
+export * from "./vehicle-registration";
+export * from "./vehicle-insurance";
+export * from "./vehicle-contract";
+export * from "./vehicle-contract-payment";
+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";

package/dist/types/loan-installment.d.ts

@@ -0,0 +1,14 @@
+export interface ILoanInstallment {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	status: "PENDING" | "PAID" | "OVERDUE" | "CANCELLED";
+
+	dueDate: string;
+
+	amount: number;
+
+	loanId: string;
+}

package/dist/types/loan.d.ts

@@ -0,0 +1,18 @@
+export interface ILoan {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	documentId: string;
+	employeeId: string;
+
+	startDate: string;
+
+	reason: string;
+
+	totalAmount: number;
+	repaymentPeriod: number;
+
+	status: "PENDING" | "PAID";
+}

package/dist/types/metadata-documents.d.ts

@@ -0,0 +1,4 @@
+export interface IMetadataDocuments {
+	name: string;
+	fileId: string;
+}

package/dist/types/metadata-expiring-documents.d.ts

@@ -0,0 +1,7 @@
+export interface IMetadataExpiringDocuments {
+	name: string;
+	categoryId: string;
+	typeId: string;
+	expiryDate: string;
+	expiringIn: number;
+}

package/dist/types/metadata-missing-documents.d.ts

@@ -0,0 +1,5 @@
+export interface IMetadataMissingDocuments {
+	name: string;
+	categoryId: string;
+	typeId: string;
+}

package/dist/types/metadata-status-check.d.ts

@@ -0,0 +1,14 @@
+export interface IMetadataStatusCheck {
+	currentStatus?: string;
+	newStatus?: string;
+	targetStatus?: string;
+	requirements?: Array<{
+		categoryId?: string;
+		complete: boolean;
+		label: string;
+		name: string;
+		typeId?: string;
+		optional: boolean;
+		noShow: boolean;
+	}>;
+}

package/dist/types/metadata.d.ts

@@ -0,0 +1,14 @@
+import { IMetadataDocuments, IMetadataExpiringDocuments, IMetadataMissingDocuments, IMetadataStatusCheck } from ".";
+
+export interface IMetadata {
+	expiringDocuments?: {
+		[key: string]: IMetadataExpiringDocuments;
+	};
+	statusCheck?: IMetadataStatusCheck;
+	documents?: {
+		[key: string]: IMetadataDocuments;
+	};
+	missingDocuments?: {
+		[key: string]: IMetadataMissingDocuments;
+	};
+}

package/dist/types/models.d.ts

@@ -0,0 +1,61 @@
+export type IModel =
+	| "team"
+	| "region"
+	| "role"
+	| "company"
+	| "employeeStatus"
+	| "contractAllowance"
+	| "contractDeduction"
+	| "contractBenefit"
+	| "contract"
+	| "loan"
+	| "loanInstallment"
+	| "employee"
+	| "file"
+	| "user"
+	| "requestType"
+	| "requestAction"
+	| "requestCategory"
+	| "requestActionExecution"
+	| "requestVerification"
+	| "requestValue"
+	| "request"
+	| "recruitmentPersonalInformation"
+	| "recruitmentEmploymentInformation"
+	| "recruitmentPassportInformation"
+	| "recruitmentMedicalInformation"
+	| "recruitmentVisaInformation"
+	| "recruitmentOtherInformation"
+	| "recruitmentNationalCardInformation"
+	| "recruitment"
+	| "config"
+	| "permission"
+	| "permissionGroup"
+	| "apiKey"
+	| "employeeEvent"
+	| "employeeField"
+	| "contact"
+	| "signingMode"
+	| "restriction"
+	| "ceiling"
+	| "tag"
+	| "client"
+	| "clientClass"
+	| "clientContact"
+	| "zone"
+	| "siteClass"
+	| "clientSite"
+	| "position"
+	| "positionVersion"
+	| "shiftType"
+	| "shift"
+	| "schedule"
+	| "scheduleSite"
+	| "standardOperatingProcedure"
+	| "nFCTag"
+	| "dispatch"
+	| "dispatchAttendance"
+	| "attendanceLeaveReason"
+	| "attendance"
+	| "oneTimePasswordAttempt"
+	| "oneTimePassword";

package/dist/types/nfc-tag.d.ts

@@ -0,0 +1,11 @@
+export interface INFCTag {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	type: "SITE_INFORMATION" | "EMPLOYEE";
+	uri: string;
+	data?: any;
+	siteId?: number;
+	employeeId?: number;
+}

package/dist/types/one-time-password.d.ts

@@ -0,0 +1,16 @@
+export interface IOneTimePassword {
+	createdAt: string;
+	updatedAt: string;
+	id: string;
+
+	expiryTime: string;
+	timeSent: string;
+	requesterIp?: string;
+	maxAttempts: number;
+	type: "DOCUMENT_SIGNING" | "EMAIL_VERIFICATION" | "PHONE_VERIFICATION" | "PASSWORD_RESET";
+	status: "PENDING" | "VERIFIED" | "REJECTED";
+	method: "WHATSAPP" | "SMS" | "EMAIL";
+
+	requestId?: string;
+	contactId?: string;
+}

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

@@ -0,0 +1,6 @@
+export interface IPaymentCycle {
+	id: string;
+	createdAt: Date;
+	from: Date;
+	to: Date;
+}

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

@@ -0,0 +1,8 @@
+export interface IPermissionGroup {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	description?: string;
+	teamId: string;
+}

package/dist/types/permission.d.ts

@@ -0,0 +1,7 @@
+export interface IPermission {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	description?: string;
+}

package/dist/types/phone-line-commitment.d.ts

@@ -0,0 +1,11 @@
+export interface IPhoneLineCommitment {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+	deletedAt?: string;
+
+	amount: number;
+	dueUntil: string;
+
+	lineId: string;
+}

package/dist/types/phone-line-contract.d.ts

@@ -0,0 +1,14 @@
+export interface IPhoneLineContract {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+	deletedAt?: string;
+
+	identifier: string;
+	startDate?: string;
+	endDate?: string;
+	status: "ACTIVE" | "INACTIVE" | "ENDED";
+
+	vendorId: string;
+	companyId: string;
+}

package/dist/types/phone-line-package.d.ts

@@ -0,0 +1,14 @@
+export interface IPhoneLinePackage {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+	deletedAt?: string;
+
+	price: number;
+	dataThreshold: number;
+	internationalBarring: boolean;
+
+	primaryKey: string;
+
+	regionId: string;
+}

package/dist/types/phone-line.d.ts

@@ -0,0 +1,19 @@
+export interface IPhoneLine {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+	deletedAt?: string;
+
+	number: string;
+
+	assignment: "EMPLOYEE" | "USER" | "SITE" | "POSITION" | "UNASSIGNED";
+	status: "ACTIVE" | "TERMINATED";
+
+	packageId: string;
+	contractId: string;
+
+	employeeId?: string;
+	userId?: string;
+	siteId?: string;
+	positionId?: string;
+}

package/dist/types/position-version.d.ts

@@ -0,0 +1,21 @@
+export interface IPositionVersion {
+	id: string;
+	updatedAt: Date;
+	createdAt: Date;
+
+	status: "UNVERIFIED" | "PENDING_VERIFICATION" | "VERIFIED" | "REJECTED";
+	version: number;
+	coversSaturday: boolean;
+	coversSunday: boolean;
+	coversMonday: boolean;
+	coversTuesday: boolean;
+	coversWednesday: boolean;
+	coversThursday: boolean;
+	coversFriday: boolean;
+	dailyHours: number;
+	dailyCoverage: string;
+	weeklyCoverage: string;
+
+	positionId: string;
+	activePositionId: string;
+}

package/dist/types/position.d.ts

@@ -0,0 +1,10 @@
+export interface IPosition {
+	id: string;
+	updatedAt: Date;
+	createdAt: Date;
+
+	name: string;
+	primaryKey: string;
+	siteId: string;
+	roleId: string;
+}

package/dist/types/recruitment-employment-information-history.d.ts

@@ -0,0 +1,7 @@
+export interface IRecruitmentEmploymentInformationHistory {
+	companyName: string;
+	startDate: string;
+	endDate?: string;
+	position: string;
+	description?: string;
+}

package/dist/types/recruitment-employment-information.d.ts

@@ -0,0 +1,12 @@
+import { IFile, IRecruitmentEmploymentInformationHistory } from ".";
+
+export interface IRecruitmentEmploymentInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	retirementStatus: boolean;
+	resume?: IFile;
+
+	desiredRole?: string;
+	history?: IRecruitmentEmploymentInformationHistory[];
+}

package/dist/types/recruitment-medical-information.d.ts

@@ -0,0 +1,9 @@
+export interface IRecruitmentMedicalInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	referenceNumber?: string;
+	expiryDate?: string;
+	institutionName?: string;
+}

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

@@ -0,0 +1,13 @@
+import { IFile } from ".";
+
+export interface IRecruitmentNationalCardInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	number?: string;
+	country?: string;
+	expiryDate: string;
+	placeOfIssue?: string;
+	issueDate?: string;
+	recruitmentId: string;
+}

package/dist/types/recruitment-other-information-additional-information.d.ts

@@ -0,0 +1,4 @@
+export interface IRecruitmentOtherInformationAdditionalInformation {
+	name: string;
+	value: string;
+}

package/dist/types/recruitment-other-information.d.ts

@@ -0,0 +1,8 @@
+import { IRecruitmentOtherInformationAdditionalInformation } from ".";
+
+export interface IRecruitmentOtherInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	additionalInformation: IRecruitmentOtherInformationAdditionalInformation[];
+}

package/dist/types/recruitment-passport-information.d.ts

@@ -0,0 +1,12 @@
+export interface IRecruitmentPassportInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	number?: string;
+	expiryDate?: string;
+	country?: string;
+	placeOfIssue?: string;
+	issueDate?: string;
+	secondPage?: boolean;
+}

package/dist/types/recruitment-personal-information.d.ts

@@ -0,0 +1,18 @@
+export interface IRecruitmentPersonalInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	firstName?: string;
+	middleNames?: string;
+	fatherName?: string;
+	lastName?: string;
+	gender?: "MALE" | "FEMALE";
+	nationality?: string;
+	nationalNumber: string;
+	dateOfBirth?: string;
+	placeOfBirth?: string;
+	name?: string;
+	fullName?: string;
+	location?: string;
+}

package/dist/types/recruitment-visa-information.d.ts

@@ -0,0 +1,8 @@
+export interface IRecruitmentVisaInformation {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	type: string;
+
+	expiryDate?: string;
+}

package/dist/types/recruitment.d.ts

@@ -0,0 +1,12 @@
+export interface IRecruitment {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	status: "DRAFT" | "VERIFIED" | "PENDING" | "CHANGES_NEEDED" | "RECRUITED";
+	regionId: string;
+	createdById: string;
+	folderKey: string;
+
+	requestedChanges?: string;
+}

package/dist/types/region.d.ts

@@ -0,0 +1,15 @@
+export interface IRegion {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	countryCode: string;
+	configs: IRegionConfig[];
+}
+
+export interface IRegionConfig {
+	id: string;
+	name: string;
+	value: string;
+	type: string;
+}

package/dist/types/report-category-field.d.ts

@@ -0,0 +1,23 @@
+export interface IReportCategoryField {
+	name: string;
+	required: boolean;
+	type:
+		| "STRING"
+		| "NUMBER"
+		| "BOOLEAN"
+		| "DATE"
+		| "DATETIME"
+		| "TIME"
+		| "UPLOAD"
+		| "RELATION"
+		| "SINGLE_SELECT"
+		| "SIGNATURE";
+	model?: "contract" | "company" | "contact";
+	config: {
+		options: any[];
+		optionsUrl: string;
+		uploadCategory?: string;
+		variant?: string;
+		dependencies?: any[];
+	};
+}

package/dist/types/report-category.d.ts

@@ -0,0 +1,10 @@
+import { IReportCategoryField } from ".";
+
+export interface IReportCategory {
+	id: string;
+	name: string;
+	typeId: string;
+	fields: IReportCategoryField[];
+	createdAt: string;
+	updatedAt: string;
+}

package/dist/types/report-comment-reaction.d.ts

@@ -0,0 +1,10 @@
+export interface IReportCommentReaction {
+	id: string;
+	createdAt: Date;
+	updatedAt?: Date;
+	deletedAt?: Date;
+
+	userId: string;
+	commentId: string;
+	reaction: string;
+}

package/dist/types/report-comment.d.ts

@@ -0,0 +1,11 @@
+export interface IReportComment {
+	id: string;
+	createdAt: Date;
+	updatedAt: Date;
+	deletedAt?: Date;
+
+	reportId: string;
+	userId: string;
+
+	comment: string;
+}

package/dist/types/report-type.d.ts

@@ -0,0 +1,7 @@
+export interface IReportType {
+	id: string;
+	name: string;
+	typeId: string;
+	createdAt: string;
+	updatedAt: string;
+}

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

@@ -0,0 +1,16 @@
+import { IFile, IReportCategoryField } from ".";
+import { IModel } from "./models";
+
+export interface IReportValue {
+	id: string;
+	type: IReportCategoryField["type"];
+	name: string;
+	value: any;
+	model?: IModel;
+	required?: boolean;
+	relation?: {
+		[key: string]: any;
+	};
+	relationValue?: string;
+	file?: IFile;
+}