@updraft-solutions/mcrit-sdk 0.1.0

package/src/schemas/report.ts

@@ -0,0 +1,306 @@
+// Report Status Types
+export type ReportStatus = "pending" | "processing" | "completed" | "failed";
+
+// Report Type Enum
+export type ReportType =
+  | "financial"
+  | "operational"
+  | "instructor_efficiency"
+  | "company_development";
+
+// Granularity Options
+export type ReportGranularity =
+  | "total"
+  | "yearly"
+  | "quarterly"
+  | "monthly"
+  | "weekly"
+  | "daily";
+
+// Media Type (matching backend MediaResource)
+export interface Media {
+  type: "media";
+  id: number;
+  description?: string;
+  url: string | null;
+  mime_type: string;
+  file_name: string;
+  size: number;
+  collection_name: string;
+  created_at: string;
+  updated_at: string;
+}
+
+// Media Collection (for reports - only PDF)
+export interface ReportMedia {
+  pdf?: Media | null;
+}
+
+// Base Report Interface
+export interface Report {
+  id: number;
+  reportable_type: string;
+  reportable_id: number;
+  report_type: ReportType;
+  parameters: ReportParameters;
+  data: ReportData;
+  metadata: ReportMetadata;
+  status: ReportStatus;
+  generated_at: string | null;
+  expires_at: string | null;
+  created_at: string;
+  updated_at: string;
+  media?: ReportMedia;
+}
+
+// Report Parameters
+export interface ReportParameters {
+  start_date?: string | null;
+  end_date?: string | null;
+  granularity: ReportGranularity;
+}
+
+// Report Generation Parameters (for API requests)
+export interface ReportGenerationParams {
+  type: ReportType;
+  start_date?: string | null;
+  end_date?: string | null;
+  granularity?: ReportGranularity;
+}
+
+// Report Metadata
+export interface ReportMetadata {
+  requested_by?: number;
+  requested_at?: string;
+  started_at?: string;
+  completed_at?: string;
+  duration_seconds?: number;
+  attempt?: number;
+  error?: string;
+  batch?: boolean;
+}
+
+// Base structure for period-based data
+export interface PeriodData<T> {
+  summary: T;
+  by_period?: Record<string, T>;
+}
+
+// Generic Report Data
+export type ReportData =
+  | FinancialReportData
+  | OperationalReportData
+  | InstructorEfficiencyReportData
+  | CompanyDevelopmentReportData;
+
+// =====================
+// Financial Report Types
+// =====================
+
+export interface FinancialReportData {
+  revenue: PeriodData<RevenueData>;
+  expenses: PeriodData<ExpenseData>;
+  invoices: PeriodData<InvoiceData>;
+  prepaid_packages: PeriodData<PrepaidPackageData>;
+  summary: PeriodData<FinancialSummaryData>;
+}
+
+export interface RevenueData {
+  total_gross: number;
+  total_net: number;
+  by_type: Record<string, number>;
+  count?: number;
+}
+
+export interface ExpenseData {
+  total_gross: number;
+  total_net: number;
+  by_category: Record<string, number>;
+  count?: number;
+}
+
+export interface InvoiceData {
+  total_count: number;
+  total_gross: number;
+  by_status: Record<string, number>;
+  by_paid_status: Record<string, number>;
+}
+
+export interface PrepaidPackageData {
+  total_packages: number;
+  total_initial_value: number;
+  total_remaining_value: number;
+  total_used_value: number;
+  usage_percentage: number;
+}
+
+export interface FinancialSummaryData {
+  total_revenue: number;
+  total_expenses: number;
+  profit: number;
+  profit_margin: number;
+}
+
+// =====================
+// Operational Report Types
+// =====================
+
+export interface OperationalReportData {
+  flight_hours: FlightHoursData;
+  bookings: BookingsData;
+  landings: LandingsData;
+  aircraft_utilization: AircraftUtilization[];
+  member_activity: MemberActivityData;
+}
+
+export interface FlightHoursData {
+  total_hours: number;
+  total_flights: number;
+  average_flight_hours: number;
+  by_month?: Record<string, number>;
+  by_period?: Record<
+    string,
+    {
+      hours: number;
+      flights: number;
+      average: number;
+    }
+  >;
+}
+
+export interface BookingsData {
+  total_bookings: number;
+  completion_rate: number;
+  average_efficiency: number;
+  by_status: Record<string, number>;
+  by_period?: Record<
+    string,
+    {
+      total: number;
+      completed: number;
+      cancelled: number;
+    }
+  >;
+}
+
+export interface LandingsData {
+  total_landings: number;
+  full_stop_landings: number;
+  touch_and_gos: number;
+  top_airports: Array<{
+    airport_code: string;
+    airport_name: string;
+    count: number;
+  }>;
+}
+
+export interface AircraftUtilization {
+  aircraft_id: number;
+  aircraft_registration: string;
+  aircraft_name: string;
+  total_hours: number;
+  total_bookings: number;
+  utilization_rate: number;
+}
+
+export interface MemberActivityData {
+  top_pilots: Array<{
+    member_id: number;
+    member_name: string;
+    flight_hours: number;
+    booking_count: number;
+  }>;
+  total_active_members: number;
+}
+
+// =====================
+// Instructor Efficiency Report Types
+// =====================
+
+export interface InstructorEfficiencyReportData {
+  instructors: InstructorData[];
+  summary: InstructorSummaryData;
+  period: {
+    start_date: string;
+    end_date: string;
+  };
+}
+
+export interface InstructorData {
+  instructor_id: number;
+  instructor_name: string;
+  instructor_email: string;
+  total_bookings: number;
+  average_efficiency: number;
+  average_delay_minutes: number;
+  total_flight_hours: number;
+  bookings_with_efficiency: number;
+  by_period?: Record<
+    string,
+    {
+      bookings: number;
+      efficiency: number;
+      delay: number;
+      hours: number;
+    }
+  >;
+}
+
+export interface InstructorSummaryData {
+  total_instructors: number;
+  average_efficiency_overall: number;
+  average_delay_overall: number;
+  total_bookings_overall: number;
+  total_flight_hours_overall: number;
+  best_performer: {
+    name: string;
+    efficiency: number;
+  };
+}
+
+// =====================
+// Company Development Report Types
+// =====================
+
+export interface CompanyDevelopmentReportData {
+  summary?: Record<string, any>;
+  metrics?: Record<string, any>;
+  by_period?: Record<string, any>;
+}
+
+// =====================
+// Helper Types
+// =====================
+
+// Report list item for display in tables/lists
+export interface ReportListItem {
+  id: number;
+  type: ReportType;
+  status: ReportStatus;
+  created_at: string;
+  generated_at: string | null;
+  parameters: ReportParameters;
+}
+
+// Report generation response
+export interface ReportGenerationResponse {
+  message: string;
+  data?: Report | Report[];
+  skipped?: Array<{
+    type: ReportType;
+    message: string;
+    report: Report;
+  }>;
+}
+
+// Report status response
+export interface ReportStatusResponse {
+  data: {
+    id: number;
+    status: ReportStatus;
+    report_type: ReportType;
+    created_at: string;
+    generated_at: string | null;
+    metadata: ReportMetadata;
+  };
+}

package/src/schemas/safety-report.ts

@@ -0,0 +1,163 @@
+import { z } from "zod";
+
+// Status Enum
+export const SafetyReportStatusEnum = z.enum([
+  "new",
+  "under_review",
+  "action_taken",
+  "closed",
+]);
+export type SafetyReportStatus = z.infer<typeof SafetyReportStatusEnum>;
+
+// Safety Report Category Schema
+export const SafetyReportCategorySchema = z.object({
+  id: z.number(),
+  name: z.string(),
+  description: z.string().nullable(),
+  color: z.string(),
+  sort_order: z.number(),
+  is_active: z.boolean(),
+  is_global: z.boolean().optional(),
+  created_at: z.string().optional(),
+  updated_at: z.string().optional(),
+});
+
+export type SafetyReportCategory = z.infer<typeof SafetyReportCategorySchema>;
+
+// Safety Report Category Form Schema (for creating/updating)
+export const SafetyReportCategoryFormSchema = z.object({
+  name: z
+    .string()
+    .min(1, "Name is required")
+    .max(100, "Name must be at most 100 characters"),
+  description: z.string().max(500).nullable().optional(),
+  color: z
+    .string()
+    .regex(/^#[0-9A-Fa-f]{6}$/, "Invalid hex color")
+    .nullable()
+    .optional(),
+  sort_order: z.number().int().min(0).optional(),
+  is_active: z.boolean().optional(),
+});
+
+export type SafetyReportCategoryForm = z.infer<
+  typeof SafetyReportCategoryFormSchema
+>;
+
+// Media Schema (for attachments)
+export const SafetyReportMediaSchema = z.object({
+  id: z.number(),
+  file_name: z.string(),
+  mime_type: z.string(),
+  size: z.number(),
+  url: z.string().nullable(),
+});
+
+export type SafetyReportMedia = z.infer<typeof SafetyReportMediaSchema>;
+
+// Safety Report Schema (from API)
+export const SafetyReportSchema = z.object({
+  id: z.number(),
+  incident_date: z.string(),
+  location: z.string().nullable(),
+  description: z.string(),
+  status: SafetyReportStatusEnum,
+  is_archived: z.boolean(),
+  category: SafetyReportCategorySchema.nullable().optional(),
+  attachments: z.array(SafetyReportMediaSchema).optional(),
+  attachments_count: z.number().optional(),
+  created_at: z.string(),
+  updated_at: z.string(),
+  can: z.record(z.string(), z.boolean()).optional(),
+});
+
+export type SafetyReport = z.infer<typeof SafetyReportSchema>;
+
+// Safety Report List Response (paginated)
+export const SafetyReportListResponseSchema = z.object({
+  data: z.array(SafetyReportSchema),
+  links: z
+    .object({
+      first: z.string().nullable().optional(),
+      last: z.string().nullable().optional(),
+      prev: z.string().nullable().optional(),
+      next: z.string().nullable().optional(),
+    })
+    .optional(),
+  meta: z
+    .object({
+      current_page: z.number(),
+      from: z.number().nullable(),
+      last_page: z.number(),
+      per_page: z.number(),
+      to: z.number().nullable(),
+      total: z.number(),
+    })
+    .optional(),
+});
+
+export type SafetyReportListResponse = z.infer<
+  typeof SafetyReportListResponseSchema
+>;
+
+// Safety Report Form Schema (for submission)
+export const SafetyReportFormSchema = z.object({
+  incident_date: z.string().min(1, "Incident date is required"),
+  location: z.string().max(255).nullable().optional(),
+  description: z
+    .string()
+    .min(10, "Description must be at least 10 characters")
+    .max(10000, "Description must be at most 10000 characters"),
+});
+
+export type SafetyReportForm = z.infer<typeof SafetyReportFormSchema>;
+
+// Safety Report Update Schema (for admin updates)
+export const SafetyReportUpdateSchema = z.object({
+  status: SafetyReportStatusEnum.optional(),
+  category_id: z.number().nullable().optional(),
+});
+
+export type SafetyReportUpdate = z.infer<typeof SafetyReportUpdateSchema>;
+
+// Filter Schema (for querying reports)
+export const SafetyReportFilterSchema = z.object({
+  status: SafetyReportStatusEnum.optional(),
+  category_id: z.number().optional(),
+  date_from: z.string().optional(),
+  date_to: z.string().optional(),
+  include_archived: z.boolean().optional(),
+  search: z.string().optional(),
+  sort: z.enum(["incident_date", "created_at", "status"]).optional(),
+  direction: z.enum(["asc", "desc"]).optional(),
+  per_page: z.number().optional(),
+  page: z.number().optional(),
+});
+
+export type SafetyReportFilter = z.infer<typeof SafetyReportFilterSchema>;
+
+// Submission Response (minimal, for anonymity)
+export const SafetyReportSubmissionResponseSchema = z.object({
+  message: z.string(),
+  submitted: z.boolean(),
+});
+
+export type SafetyReportSubmissionResponse = z.infer<
+  typeof SafetyReportSubmissionResponseSchema
+>;
+
+// Status Labels for UI
+export const SAFETY_REPORT_STATUS_LABELS: Record<SafetyReportStatus, string> = {
+  new: "New",
+  under_review: "Under Review",
+  action_taken: "Action Taken",
+  closed: "Closed",
+};
+
+// Status Colors for UI
+export const SAFETY_REPORT_STATUS_COLORS: Record<SafetyReportStatus, string> = {
+  new: "info",
+  under_review: "warning",
+  action_taken: "primary",
+  closed: "success",
+};

package/src/types/api.ts

@@ -0,0 +1,37 @@
+/**
+ * Generic response wrapper for data with optional metadata
+ * @template T - The data type
+ * @template M - The metadata type (optional)
+ */
+export interface DataWrappedResponse<T, M = undefined> {
+  data: T;
+  meta?: M;
+}
+
+export interface PaginatedResponse<T = any> {
+  data: T[];
+  meta: {
+    current_page: number;
+    from: number;
+    last_page: number;
+    per_page: number;
+    to: number;
+    total: number;
+  };
+  links?: {
+    first?: string | null;
+    last?: string | null;
+    prev?: string | null;
+    next?: string | null;
+  };
+}
+
+export interface Resource {
+  id: number;
+  type: string;
+}
+
+export interface ToggleFavoriteResponse {
+  id: number;
+  hasFavorited: boolean;
+}

package/src/types/compliance.ts

@@ -0,0 +1,44 @@
+export interface ComplianceRequirement {
+  requirement_id: number;
+  document_type_class: string;
+  document_type_label: string;
+  logical_group: string;
+  is_satisfied: boolean;
+  document: any | null;
+}
+
+export interface ComplianceRequirementGroup {
+  group_name: string;
+  group_operator: "AND" | "OR";
+  group_satisfied: boolean;
+  requirements: ComplianceRequirement[];
+}
+
+export interface ComplianceGroup {
+  group_id: number;
+  group_name: string;
+  overall_satisfied: boolean;
+  requirement_groups: ComplianceRequirementGroup[];
+}
+
+export interface ComplianceSummary {
+  total_groups: number;
+  satisfied_groups: number;
+  failed_groups: number;
+}
+
+export interface ComplianceData {
+  overall_satisfied: boolean;
+  requirement_groups: ComplianceGroup[];
+  summary: ComplianceSummary;
+}
+
+export interface ComplianceResponse {
+  data: ComplianceData;
+  meta: {
+    model_id: string;
+    model_type: string;
+    target_model_id: string;
+    target_model_type: string;
+  };
+}

package/src/types/index.ts

@@ -0,0 +1,3 @@
+export * from "./models";
+export * from "./api";
+export * from "./compliance";

package/src/types/models.ts

@@ -0,0 +1,124 @@
+import type { z } from "zod";
+import type * as Common from "../schemas/common";
+import type * as ModelSchemas from "../schemas/models";
+
+// Common types
+export type BaseModel = z.infer<typeof Common.BaseModel>;
+export type User = z.infer<typeof Common.userSchema>;
+export type Company = z.infer<typeof Common.companySchema>;
+export type Media = z.infer<typeof Common.mediaSchema>;
+export type MediaCollection = z.infer<typeof Common.mediaCollection>;
+
+// Membership types
+export type BaseMembership = z.infer<typeof ModelSchemas.baseMembershipSchema>;
+export type Membership = z.infer<typeof ModelSchemas.membershipSchema>;
+
+// Airplane types
+export type Airplane = z.infer<typeof ModelSchemas.airplaneSchema>;
+export type ExtendedAirplane = z.infer<
+  typeof ModelSchemas.extendedAirplaneSchema
+>;
+export type AirplanePermission = z.infer<
+  typeof ModelSchemas.airplanePermissionSchema
+>;
+export type LandingFee = z.infer<typeof ModelSchemas.landingFeeSchema>;
+export type AircraftRating = z.infer<typeof ModelSchemas.aircraftRatingSchema>;
+export type UserAircraftRating = z.infer<
+  typeof ModelSchemas.userAircraftRatingSchema
+>;
+export type UserQualification = z.infer<
+  typeof ModelSchemas.userQualificationSchema
+>;
+
+// Airport types
+export type Airport = z.infer<typeof ModelSchemas.airportSchema>;
+export type RecurringFlight = z.infer<
+  typeof ModelSchemas.recurringFlightSchema
+>;
+
+// Fee types
+export type Fee = z.infer<typeof ModelSchemas.feeSchema>;
+export type CourseFee = z.infer<typeof ModelSchemas.courseFeeSchema>;
+export type Price = z.infer<typeof ModelSchemas.priceSchema>;
+
+// Maintenance types
+export type MaintenanceEvent = z.infer<
+  typeof ModelSchemas.maintenanceEventSchema
+>;
+export type MaintenanceStatus = z.infer<
+  typeof ModelSchemas.maintenanceStatusSchema
+>;
+export type MaintenanceEventEstimation = z.infer<
+  typeof ModelSchemas.maintenanceEventEstimationSchema
+>;
+
+// Booking types
+export type Avail = z.infer<typeof ModelSchemas.availSchema>;
+export type Alert = z.infer<typeof ModelSchemas.alertSchema>;
+export type Booking = z.infer<typeof ModelSchemas.bookingSchema>;
+
+// Document Manager Types
+export type Document = z.infer<typeof ModelSchemas.documentSchema>;
+export type DocumentType = z.infer<typeof ModelSchemas.documentType>;
+export type DocumentRequirement = z.infer<
+  typeof ModelSchemas.documentRequirement
+>;
+export type DocumentRequirementGroup = z.infer<
+  typeof ModelSchemas.documentRequirementGroup
+>;
+export type DocumentRequirementGroupAssignment = z.infer<
+  typeof ModelSchemas.documentRequirementGroupAssignment
+>;
+export type DocumentComplianceStatus = z.infer<
+  typeof ModelSchemas.documentComplianceStatus
+>;
+export type DocumentShare = z.infer<typeof ModelSchemas.documentShareSchema>;
+export type AllowedDocumentType = z.infer<
+  typeof ModelSchemas.allowedDocumentTypeSchema
+>;
+
+// Flight and Operations Types
+export type FlightLog = z.infer<typeof ModelSchemas.flightLogSchema>;
+export type ScheduledFlight = z.infer<
+  typeof ModelSchemas.scheduledFlightSchema
+>;
+export type Landing = z.infer<typeof ModelSchemas.landingSchema>;
+export type ApproachType = z.infer<typeof ModelSchemas.approachTypeSchema>;
+export type Waypoint = z.infer<typeof ModelSchemas.waypointSchema>;
+
+// Financial Types
+export type Invoice = z.infer<typeof ModelSchemas.invoiceSchema>;
+export type Expense = z.infer<typeof ModelSchemas.expenseSchema>;
+export type ExpenseItem = z.infer<typeof ModelSchemas.expenseItemSchema>;
+export type SpecialFlight = z.infer<typeof ModelSchemas.specialFlightSchema>;
+export type PrePaidPackage = z.infer<typeof ModelSchemas.prePaidPackageSchema>;
+
+// Training and Certification Types
+export type Qualification = z.infer<typeof ModelSchemas.qualificationSchema>;
+export type Course = z.infer<typeof ModelSchemas.courseSchema>;
+export type CourseEnrollment = z.infer<
+  typeof ModelSchemas.courseEnrollmentSchema
+>;
+
+// Communication and Support Types
+export type Event = z.infer<typeof ModelSchemas.eventSchema>;
+export type Ticket = z.infer<typeof ModelSchemas.ticketSchema>;
+export type Post = z.infer<typeof ModelSchemas.postSchema>;
+export type Comment = z.infer<typeof ModelSchemas.commentSchema>;
+
+export interface CreateCommentInput {
+  body: string;
+  parent_id?: number;
+  title?: string;
+}
+
+export interface UpdateCommentInput {
+  body?: string;
+  title?: string;
+}
+
+// Infrastructure Types
+export type Address = z.infer<typeof ModelSchemas.addressSchema>;
+export type Runway = z.infer<typeof ModelSchemas.runwaySchema>;
+export type Role = z.infer<typeof ModelSchemas.roleSchema>;
+export type Setting = z.infer<typeof ModelSchemas.settingSchema>;