@automateinc/fleet-types 1.0.0

package/dist/types/report.d.ts

@@ -0,0 +1,23 @@
+export interface IReport {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	title: string;
+	content: string;
+
+	typeId: string;
+	categoryId: string;
+
+	createdByUserId?: string;
+	createdByEmployeeId?: string;
+
+	userId?: string;
+	employeeId?: string;
+	vehicleId?: string;
+	clientId?: string;
+	siteId?: string;
+	zoneId?: string;
+	buildingId?: string;
+}

package/dist/types/request-action-execution.d.ts

@@ -0,0 +1,11 @@
+export interface IRequestActionExecution {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	actionId: string;
+	status: "PENDING" | "COMPLETED" | "PROCESSING" | "FAILED" | "SKIPPED";
+	startedAt: string | null;
+	endedAt: string | null;
+	failureReason?: string;
+}

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

@@ -0,0 +1,13 @@
+import { IRequestCategoryField } from ".";
+
+export interface IRequestAction {
+	createdAt: string;
+	updatedAt: string;
+	id: string;
+	categoryId: string;
+	name: string;
+	type: "VERIFICATION" | "APPROVAL" | "REJECTION" | "CREATION";
+	operation: "HTTP";
+	config: Record<string, any>;
+	fields: IRequestCategoryField[];
+}

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

@@ -0,0 +1,26 @@
+import { IModel } from "./models";
+
+export interface IRequestCategoryField {
+	name: string;
+	required: boolean;
+	type:
+		| "STRING"
+		| "NUMBER"
+		| "BOOLEAN"
+		| "DATE"
+		| "DATETIME"
+		| "TIME"
+		| "UPLOAD"
+		| "RELATION"
+		| "SINGLE_SELECT"
+		| "SIGNATURE";
+	model?: IModel;
+	config: {
+		options: any[];
+		optionsUrl: string;
+		uploadCategory?: string;
+		dependencies?: string[];
+		hasDependency?: boolean;
+		variant?: string;
+	};
+}

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

@@ -0,0 +1,12 @@
+import { IRequestCategoryField } from "./request-category-field";
+
+export interface IRequestCategory {
+	id: string;
+	name: string;
+	typeId: string;
+	fields: IRequestCategoryField[];
+	requiresVerification: boolean;
+	requiresApproval: boolean;
+	createdAt: string;
+	updatedAt: string;
+}

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

@@ -0,0 +1,10 @@
+import { IRequestCategory } from ".";
+
+export interface IRequestType {
+	id: string;
+	name: string;
+	createdAt: string;
+	updatedAt: string;
+	categories: IRequestCategory[];
+	visible: boolean;
+}

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

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

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

@@ -0,0 +1,13 @@
+import { IEmployee } from ".";
+
+export interface IRequestVerification {
+	createdAt: string;
+	updatedAt: string;
+	id: string;
+
+	status: "APPROVED" | "REJECTED" | "PENDING";
+	verifiedById: string;
+	verifiedBy: IEmployee;
+
+	rejectionReason?: string;
+}

package/dist/types/request.d.ts

@@ -0,0 +1,22 @@
+import { IRequestCategory, IRequestType, IRequestValue } from ".";
+
+export interface IRequest {
+	approvedAt: Date;
+	createdAt: string;
+	updatedAt: string;
+	id: string;
+	category: IRequestCategory;
+	categoryId: string;
+	createdById: string;
+	rejectionReason: null;
+	requestForId: string;
+	type: IRequestType;
+	typeId: string;
+	values: IRequestValue[];
+	verifiedAt: Date;
+	verifiedById?: string;
+	rejectedById?: string;
+	withdrawnAt?: string;
+	status: "PENDING_APPROVAL" | "APPROVED" | "REJECTED" | "WITHDRAWN" | "PENDING_VERIFICATION" | "ARCHIVED";
+	actionsExecutionStatus: "PENDING" | "COMPLETED" | "PROCESSING" | "FAILED" | "SKIPPED";
+}

package/dist/types/restriction.d.ts

@@ -0,0 +1,14 @@
+export interface IRestriction {
+	createdAt: string;
+	updatedAt: string;
+	id: string;
+
+	label: string;
+	type: "EMPLOYEE" | "CONTRACT" | "ROLE" | "COMPANY";
+	operation: "EQUALS" | "NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS" | "EXISTS" | "NOT_EXISTS";
+	category?: string;
+	valueA: string;
+	valueB?: string;
+
+	requestCategoryId?: string;
+}

package/dist/types/role.d.ts

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

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

@@ -0,0 +1,25 @@
+//! This is a fake type definition file to fix type errors when building & retain mock data.
+//TODO: ONLY FOR SHOWCASE REMOVE LATER.
+
+export interface IScheduleAttendance {
+	id: string;
+	client?: string;
+	createdAt: string;
+	updatedAt: string;
+	date: string;
+	dispatchTime?: string;
+	endTime?: string;
+	nationality?: string;
+	overtime: boolean;
+	position?: string;
+	requiredGender: boolean;
+	requiredNationality: boolean;
+	requiredRetired: boolean;
+	roleId: string;
+	shiftDuration: number;
+	shiftName: string;
+	siteZone?: string;
+	startTime?: string;
+	siteLocation?: string;
+	siteName?: string;
+}

package/dist/types/schedule-draft.d.ts

@@ -0,0 +1,15 @@
+import { IEmployee } from ".";
+
+export interface IScheduleDraft {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	status: "DRAFT" | "PENDING" | "ACCEPTED" | "REJECTED";
+
+	dayOfWeek: "SATURDAY" | "SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY";
+	shiftId: string;
+
+	employee: IEmployee;
+	employeeId?: string;
+}

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

@@ -0,0 +1,16 @@
+import { IClientSite, IPosition, IZone } from ".";
+
+export interface IScheduleSite {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	zones?: IZone[];
+	positions?: IPosition[];
+	site: IClientSite;
+
+	shiftsCount: number;
+	positionsCount: number;
+	schedulesCount: number;
+	scheduledSchedulesCount: number;
+}

package/dist/types/schedule.d.ts

@@ -0,0 +1,13 @@
+import { IEmployee } from ".";
+
+export interface ISchedule {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	dayOfWeek: "SATURDAY" | "SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY";
+	shiftId?: string;
+
+	employee: IEmployee;
+	employeeId?: string;
+}

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

@@ -0,0 +1,8 @@
+export interface IShiftType {
+	id: string;
+	updatedAt: Date;
+	createdAt: Date;
+
+	name: string;
+	hours: number;
+}

package/dist/types/shift.d.ts

@@ -0,0 +1,24 @@
+import { IShiftType } from ".";
+
+export interface IShift {
+	id: string;
+	updatedAt: Date;
+	createdAt: Date;
+
+	class: "MAIN" | "OVERTIME";
+
+	startTime: number;
+
+	type: IShiftType;
+	typeId: string;
+
+	coversSaturday: boolean;
+	coversSunday: boolean;
+	coversMonday: boolean;
+	coversTuesday: boolean;
+	coversWednesday: boolean;
+	coversThursday: boolean;
+	coversFriday: boolean;
+
+	positionId: string;
+}

package/dist/types/signing-mode.d.ts

@@ -0,0 +1,8 @@
+export interface ISigningMode {
+	createdAt: Date;
+	id: string;
+	updatedAt: Date;
+
+	userId: string;
+	employeeId?: string;
+}

package/dist/types/standard-operating-procedure.d.ts

@@ -0,0 +1,13 @@
+export interface IStandardOperatingProcedure {
+	id: string;
+	updatedAt: Date;
+	createdAt: Date;
+
+	procedures: Array<{
+		values: string[];
+		locale: string;
+	}>;
+
+	positionId?: string;
+	siteId?: string;
+}

package/dist/types/tag.d.ts

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

package/dist/types/team.d.ts

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

package/dist/types/unit-room.d.ts

@@ -0,0 +1,8 @@
+export interface IUnitRoom {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+
+	name: string;
+	unitId: string;
+}

package/dist/types/unit.d.ts

@@ -0,0 +1,8 @@
+export interface IUnit {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	name: string;
+	buildingId: string;
+	status: "ACTIVE" | "INACTIVE";
+}

package/dist/types/user.d.ts

@@ -0,0 +1,20 @@
+import { IFile } from ".";
+
+export interface IUser {
+	id: string;
+	email: string;
+	password: string;
+	googleId: string;
+	role: string;
+	firstName: string;
+	lastName: string;
+	folderKey: string;
+	profilePicture?: IFile;
+	teamRole: string;
+	signature?: IFile;
+	name: string;
+	teamId: string;
+	createdAt: string;
+	updatedAt: string;
+	metadata?: { [key: PropertyKey]: any };
+}

package/dist/types/vehicle-contract-payment.d.ts

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

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

@@ -0,0 +1,17 @@
+export interface IVehicleContract {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	vehicleId: string;
+
+	startDate: string;
+	endDate: string;
+
+	status: "ACTIVE" | "INACTIVE";
+
+	vendorId: string;
+
+	active: boolean;
+}

package/dist/types/vehicle-insurance.d.ts

@@ -0,0 +1,18 @@
+export interface IVehicleInsurance {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	vehicleId: string;
+
+	company: string;
+	coverageType: string;
+	policyNumber: string;
+	amount: number;
+
+	issueDate: string;
+	expiryDate: string;
+
+	active: boolean;
+}

package/dist/types/vehicle-make.d.ts

@@ -0,0 +1,8 @@
+export interface IVehicleMake {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	name: string;
+}

package/dist/types/vehicle-model.d.ts

@@ -0,0 +1,12 @@
+export interface IVehicleModel {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	name: string;
+
+	makeId: string;
+
+	regionId: string;
+}

package/dist/types/vehicle-registration.d.ts

@@ -0,0 +1,15 @@
+export interface IVehicleRegistration {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	vehicleId: string;
+
+	amount: number;
+
+	issueDate: string;
+	expiryDate: string;
+
+	active: boolean;
+}

package/dist/types/vehicle.d.ts

@@ -0,0 +1,23 @@
+export interface IVehicle {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	makeId: string;
+	modelId: string;
+	purchaseDate?: string;
+	year: number;
+	color: string;
+	plateNumber: string;
+	vehicleIdentificationNumber: string;
+	type: string;
+
+	companyId: string;
+	employeeId?: string;
+	userId?: string;
+
+	regionId: string;
+
+	assignment: "EMPLOYEE" | "USER" | "POSITION" | "UNASSIGNED";
+}

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

@@ -0,0 +1,13 @@
+export interface IVendorContact {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	name: string;
+	number: string;
+	email?: string;
+	notes?: string;
+
+	vendorId: string;
+}

package/dist/types/vendor.d.ts

@@ -0,0 +1,13 @@
+export interface IVendor {
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	deletedAt?: string;
+
+	name: string;
+
+	logoId?: string;
+	folderKey?: string;
+
+	regionId: string;
+}

package/dist/types/zone.d.ts

@@ -0,0 +1,8 @@
+export interface IZone {
+	id: string;
+	createdAt: Date;
+	updatedAt: Date;
+
+	name: string;
+	area: string;
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@automateinc/fleet-types",
+  "private": false,
+  "version": "1.0.0",
+  "description": "Reusable TypeScript types and interfaces for Fleet API.",
+  "main": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "build": "tsc && cp -R src/types dist/",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "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": {
+    "@tanstack/react-query": "^4.36.1",
+    "axios": "^1.7.9",
+    "typescript": "5.1.6"
+  },
+  "dependencies": {
+    "asynckit": "^0.4.0",
+    "combined-stream": "^1.0.8",
+    "delayed-stream": "^1.0.0",
+    "follow-redirects": "^1.15.9",
+    "form-data": "^4.0.1",
+    "js-tokens": "^4.0.0",
+    "loose-envify": "^1.4.0",
+    "mime-db": "^1.52.0",
+    "mime-types": "^2.1.35",
+    "proxy-from-env": "^1.1.0",
+    "react": "^18.3.1",
+    "use-sync-external-store": "^1.4.0"
+  },
+  "bugs": {
+    "url": "https://github.com/automateinc/fleet-types/issues"
+  },
+  "homepage": "https://github.com/automateinc/fleet-types#readme"
+}

package/tsconfig.json

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