@automateinc/fleet-types 1.0.0

package/README.md

@@ -0,0 +1,17 @@
+# Fleet Types
+
+##### Reusable TypeScript types and interfaces for Fleet projects.
+
+## Installation
+
+To install the package, use npm:
+
+```bash
+npm i fleet-types@https://github.com/automateinc/fleet-types.git
+```
+
+## Example Usage
+
+```js
+import { IAttendance } from "fleet-types";
+```

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

@@ -0,0 +1,23 @@
+export interface IAssetCategoryField {
+	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/asset-category.d.ts

@@ -0,0 +1,10 @@
+import { IAssetCategoryField } from "./asset-category-field";
+
+export interface IAssetCategory {
+	id: string;
+	name: string;
+	typeId: string;
+	fields: IAssetCategoryField[];
+	createdAt: string;
+	updatedAt: string;
+}

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

@@ -0,0 +1,6 @@
+export interface IAssetType {
+	id: string;
+	name: string;
+	createdAt: string;
+	updatedAt: string;
+}

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

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

package/dist/types/asset.d.ts

@@ -0,0 +1,17 @@
+export interface IAsset {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+	deletedAt?: string;
+
+	typeId: string;
+	categoryId: string;
+
+	quantity: number;
+
+	employeeId?: string;
+	userId?: string;
+	siteId?: string;
+	positionId?: string;
+	phoneLineCommitmentId?: string;
+}

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

@@ -0,0 +1,8 @@
+export interface IAttendanceCount {
+	"Checked In": number;
+	"Checked Out": number;
+	Approved: number;
+	"Pending Dispatch": number;
+	"Not Scheduled": number;
+	"Missed Dispatch": number;
+}

package/dist/types/attendance-leave-reason.d.ts

@@ -0,0 +1,11 @@
+import { IAttendance } from ".";
+
+export interface IAttendanceLeaveReason {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	name: string;
+	description?: string;
+	attendances?: IAttendance[];
+}

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

@@ -0,0 +1,11 @@
+export interface IAttendancePresenceCheck {
+  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

@@ -0,0 +1,42 @@
+import { IAttendanceLeaveReason, ICoords, IEmployee, IFile } from ".";
+
+export interface IAttendance {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	verified: boolean;
+	approved: boolean;
+	absenceType?: "DAY_OFF" | "SICK_LEAVE" | "NO_SHOW" | "LEAVE";
+
+	checkInImage?: IFile;
+	checkInImageId?: string;
+	checkInLocation?: ICoords;
+	checkInTime?: string;
+	checkOutLocation?: ICoords;
+	checkOutTime?: string;
+
+	employeeId?: string;
+
+	employeeStatus?: "PRESENT" | "ABSENT" | "REROUTED";
+	leaveReason?: IAttendanceLeaveReason;
+	leaveReasonId?: string;
+	notes?: string;
+	reroutedAttendanceId?: string;
+	scheduleDate: string;
+	scheduleId: string;
+	checkInDistance: number;
+	checkOutDistance: number;
+	workHours: number;
+	status:
+		| "PROCESSED"
+		| "NOT_SCHEDULED"
+		| "MISSED_DISPATCH"
+		| "PENDING_DISPATCH"
+		| "CHECKED_IN"
+		| "CHECKED_OUT"
+		| "REQUIRES_ATTENTION"
+		| "UNVERIFIED"
+		| null;
+	type: "SCHEDULED" | "REROUTED" | "REPLACEMENT";
+}

package/dist/types/building-contact.d.ts

@@ -0,0 +1,10 @@
+export interface IBuildingContact {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	number: string;
+	email?: string;
+	notes?: string;
+	buildingId: string;
+}

package/dist/types/building-lease-payment.d.ts

@@ -0,0 +1,13 @@
+export interface IBuildingLeasePayment {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	amount: number;
+	date: string;
+
+	invoiceId?: string;
+	leaseId: string;
+
+	status: "PENDING" | "PAID" | "OVERDUE" | "CANCELLED";
+}

package/dist/types/building-lease.d.ts

@@ -0,0 +1,12 @@
+export interface IBuildingLease {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	buildingId: string;
+
+	startDate: string;
+	endDate: string;
+
+	status: "ACTIVE" | "INACTIVE";
+}

package/dist/types/building.d.ts

@@ -0,0 +1,14 @@
+export interface IBuilding {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	address: string;
+	geolocation: {
+		lat: number;
+		lng: number;
+	};
+	status: "ACTIVE" | "INACTIVE";
+	companyId: string;
+	zoneId: string;
+}

package/dist/types/bunk.d.ts

@@ -0,0 +1,8 @@
+export interface IBunk {
+	id: string;
+	createdAt: Date;
+	updatedAt: Date;
+	name: string;
+	roomId: string;
+	employeeId: string;
+}

package/dist/types/call-log.d.ts

@@ -0,0 +1,36 @@
+export interface ICallLog {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	type: "BUILDING" | "CLIENT" | "EMPLOYEE" | "OTHER" | null;
+
+	direction: "INCOMING" | "OUTGOING";
+
+	status: "MISSED" | "ANSWERED" | "REJECTED" | "FAILED" | "NO_ANSWER";
+
+	employeeContactId?: string;
+	clientContactId?: string;
+
+	otherCaller?: string;
+
+	userId?: string;
+
+	startedAt: string;
+	endedAt: string;
+
+	number: string;
+
+	duration: number;
+	talkTime: number;
+	ringTime: number;
+	holdTime: number;
+
+	referenceId?: string;
+
+	recordingId?: string;
+	reportId?: string;
+
+	regionId: string;
+}

package/dist/types/ceiling.d.ts

@@ -0,0 +1,9 @@
+export interface ICeiling {
+	createdAt: Date;
+	id: string;
+	updatedAt: Date;
+
+	companyId: string;
+
+	limit: number;
+}

package/dist/types/client-class.d.ts

@@ -0,0 +1,9 @@
+export interface IClientClass {
+	id: string;
+	name: string;
+	type: "CLIENT" | "SITE";
+	description?: string;
+	regionId: string;
+	createdAt: string;
+	updatedAt: string;
+}

package/dist/types/client-contact.d.ts

@@ -0,0 +1,13 @@
+import { IClient } from "./client";
+
+export interface IClientContact {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	number: string;
+	email?: string;
+	notes?: string;
+	client: IClient;
+	clientId: string;
+}

package/dist/types/client-site.d.ts

@@ -0,0 +1,18 @@
+import { IClient, IClientClass, IClientContact, IScheduleSite } from ".";
+
+export interface IClientSite {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	address?: string;
+	geolocation?: { lat: number; lng: number };
+	class: IClientClass;
+	classId: string;
+	client: IClient;
+	clientId: string;
+	contact?: IClientContact;
+	contactId?: string;
+	scheduleSite?: IScheduleSite;
+	// Add Zones later
+}

package/dist/types/client.d.ts

@@ -0,0 +1,17 @@
+import { IClientClass, IClientContact, ICompany, IFile } from ".";
+
+export interface IClient {
+	id: string;
+	name: string;
+	status: "ACTIVE" | "INACTIVE";
+	createdAt: string;
+	updatedAt: string;
+	deletedAt: string;
+	logo: IFile;
+	logoId: string;
+	folderKey: string;
+	class: IClientClass;
+	classId: string;
+	companies?: ICompany[];
+	contacts?: IClientContact[];
+}

package/dist/types/company.d.ts

@@ -0,0 +1,13 @@
+export interface ICompany {
+	createdAt: Date;
+	id: string;
+	name: string;
+	abbreviation: string;
+	registrationNumber: string;
+	primaryKey: string;
+	updatedAt: Date;
+	folderKey: string;
+	parentCompanyId?: string;
+	logoId?: string;
+	stampId?: string;
+}

package/dist/types/config.d.ts

@@ -0,0 +1,11 @@
+export interface IConfig {
+	id: string;
+	createdAt: string;
+	updatedAt?: string;
+	name: string;
+	value: any;
+	type: "DEFAULT" | "TEAM" | "REGION" | "COMPANY";
+	teamId?: string;
+	regionId?: string;
+	companyId?: string;
+}

package/dist/types/contact.d.ts

@@ -0,0 +1,9 @@
+export interface IContact {
+	createdAt: Date;
+	id: string;
+	updatedAt: Date;
+
+	type: "EMAIL" | "PHONE";
+	value: string;
+	verified: boolean;
+}

package/dist/types/contract-allowance.d.ts

@@ -0,0 +1,17 @@
+export interface IContractAllowance {
+	id: string;
+	createdAt: Date;
+	updatedAt: Date;
+	name: string;
+	type:
+		| "BASE_PERCENTAGE"
+		| "FIXED"
+		| "BASE_PERCENTAGE_TIMES_DAYS_OFF"
+		| "BASE_PERCENTAGE_TIMES_DAILY_HOURS"
+		| "RAMADAN";
+	value: number;
+	contractual: boolean;
+	regionId: string;
+	companyId?: string;
+	computedValue: number;
+}

package/dist/types/contract-benefit.d.ts

@@ -0,0 +1,8 @@
+export interface IContractBenefit {
+	id: string;
+	createdAt: Date;
+	updatedAt: Date;
+	name: string;
+	regionId: string;
+	companyId?: string;
+}

package/dist/types/contract-deduction.d.ts

@@ -0,0 +1,12 @@
+export interface IContractDeduction {
+	id: string;
+	createdAt: Date;
+	updatedAt: Date;
+	name: string;
+	type: "PERCENTAGE" | "FIXED";
+	value: number;
+	contractual: boolean;
+	regionId: string;
+	companyId?: string;
+	computedValue: number;
+}

package/dist/types/contract.d.ts

@@ -0,0 +1,17 @@
+export interface IContract {
+	basicSalary: number;
+	companyId: string;
+	createdAt: Date;
+	id: string;
+	type: "FULL_TIME" | "PART_TIME" | "FREELANCE";
+	roleId: string;
+	primaryKey: string;
+	totalSalary: number;
+	updatedAt: Date;
+	dailyHours: number;
+	monthlyDaysOff: number;
+	contractDuration: number;
+	overtimeRate: number;
+	contractualAllowancesProvided: boolean;
+	paymentType: "TRANSFER" | "CASH" | "CHECK" | "UNPAID" | "FORSA" | "OTHER";
+}

package/dist/types/coords.d.ts

@@ -0,0 +1,4 @@
+export interface ICoords {
+	lat: number;
+	lng: number;
+}

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

@@ -0,0 +1,10 @@
+export interface IDispatchAttendance {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt: string;
+	type: "DROP_OFF" | "PICK_UP" | "INSPECTION";
+	checked: boolean | null;
+	dispatchId: string;
+	attendanceId: string;
+}

package/dist/types/dispatch-count.d.ts

@@ -0,0 +1,9 @@
+export interface IDispatchCount {
+	PENDING: number;
+	FLEET_CHECK: number;
+	FLEET_CHECK_COMPLETE: number;
+	IN_PROGRESS: number;
+	COMPLETE: number;
+	INTERRUPTED: number;
+	NOT_SET: number;
+}

package/dist/types/dispatch.d.ts

@@ -0,0 +1,13 @@
+export interface IDispatch {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt: string;
+	status: "PENDING" | "FLEET_CHECK" | "FLEET_CHECK_COMPLETE" | "IN_PROGRESS" | "COMPLETE" | "INTERRUPTED" | "NOT_SET";
+	statusUpdatedAt: string;
+	date: string;
+	verified: boolean;
+	// timeOnSite: number;
+	zoneId: string;
+	primaryKey: string;
+}

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

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

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

@@ -0,0 +1,10 @@
+export interface IEmployeeComment {
+	createdAt: Date;
+	updatedAt: Date;
+	deletedAt: Date;
+
+	id: string;
+	userId: string;
+	employeeId: string;
+	comment: string;
+}

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

@@ -0,0 +1,6 @@
+export interface IEmployeeStatus {
+	createdAt: Date;
+	id: string;
+	name: string;
+	updatedAt: Date;
+}

package/dist/types/employee.d.ts

@@ -0,0 +1,40 @@
+import { IFile } from ".";
+
+export interface IEmployee {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	primaryKey: string;
+	companyId: string;
+	contractId: string;
+	dateOfBirth: string;
+	firstName: string;
+	fullName: string;
+	gender: string;
+	lastName: string;
+	middleNames: string;
+	name: string;
+	nationality: string;
+	nationalNumber: string;
+	passportId: string;
+	password: string;
+	placeOfBirth: string;
+	profilePicture?: IFile;
+	statusId: string;
+	folderKey: string;
+	recruitmentId?: string;
+
+	primaryId?: string;
+	secondaryId?: string;
+
+	documents: Array<{
+		file: IFile;
+		name: string;
+	}>;
+
+	fields: {
+		[key: string]: {
+			[key: string]: string;
+		};
+	};
+}

package/dist/types/file.d.ts

@@ -0,0 +1,18 @@
+import { ITag } from ".";
+
+export interface IFile {
+	id: string;
+	updatedAt: Date;
+	createdAt: Date;
+
+	name: string;
+	slug: string;
+	type: string;
+	size: number;
+	url: string;
+	region: string;
+
+	thumbnail?: IFile;
+
+	tags?: ITag[];
+}

package/dist/types/gender.d.ts

@@ -0,0 +1 @@
+export type IGender = "MALE" | "FEMALE";