@updraft-solutions/mcrit-sdk 0.4.0 → 0.6.0

package/src/schemas/models.ts

@@ -11,6 +11,8 @@ import {
   zNetGross,
   zPhpMoneyObject,
 } from "./common";
+import { equipmentSchema } from "./equipment";
+import { courseCheckSyllabusSchema } from "./training";
 
 export const baseMembershipSchema = z.object({
   type: z.literal("membership"),
@@ -88,33 +90,58 @@ export const feeSchema = BaseModel.extend({
   id: z.number(),
   price: priceSchema.optional(),
   prices: z.array(priceSchema).optional(),
-  provider: z.string().optional(),
+  provider: z.string().nullable().optional(),
   company_id: z.number().optional(),
   company: companySchema.optional(),
   ident: z.string().optional(),
   category: z.string().optional(),
-  subcategory: z.string().optional(),
+  subcategory: z.string().nullable().optional(),
   title: z.string().optional(),
+  internal_title: z.string().nullable().optional(),
+  // internal_title falling back to title, resolved server-side.
+  display_title: z.string().optional(),
+  // Course-derived fees (source course + which course fee spawned them).
+  source_course_id: z.number().nullable().optional(),
+  source_key: z.string().nullable().optional(),
+  is_derived: z.boolean().optional(),
   relation: z
     .array(z.enum(["booking", "flightLog", "invoice", "instructor"]))
+    .nullable()
     .optional(),
-  payment_per: z.string().optional(),
-  can: z
-    .object({
-      update: zNullableBool,
-      delete: zNullableBool,
-    })
-    .optional(),
+  payment_per: z.string().nullable().optional(),
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
   course_count: z.number().optional(),
+  // feeables-pivot fields, present when the fee is serialized through an
+  // attachment (course/enrollment listings).
   count: z.number().optional(),
-  variant: z.string().optional(),
+  variant: z.string().nullable().optional(),
   is_optional: z.boolean().optional(),
+  sort_order: z.number().nullable().optional(),
+  is_initial_payment: z.boolean().optional(),
+  feeables: z
+    .array(
+      z.object({
+        feeable_id: z.number(),
+        feeable_type: z.string(),
+        count: z.number().nullable(),
+        variant: z.string().nullable(),
+        is_optional: z.boolean().nullable(),
+        is_initial_payment: z.boolean().nullable(),
+        sort_order: z.number().nullable(),
+      }),
+    )
+    .optional(),
   input_value: z.number().optional(),
   net_gross: zNetGross,
   tax_percentage: z.string().optional(),
   valid_from: z.string(),
 });
 
+export const feeCategoryOptionsSchema = z.object({
+  categories: z.array(z.string()),
+  subcategories: z.record(z.string(), z.array(z.string())),
+});
+
 export const courseFeeSchema = feeSchema.extend({
   count: z.number().optional(),
   variant: z.string().optional(),
@@ -175,14 +202,51 @@ export const airplaneSchema = BaseModel.extend({
   defaultFlightType: z.string().optional(),
   defaultFlightRule: z.string().optional(),
   status: z.string().optional(),
-  can: z.object({
-    view: zNullableBool,
-    update: zNullableBool,
-    viewMaintenanceEvents: zNullableBool,
-    createMaintenanceEvents: zNullableBool,
-    createBooking: zNullableBool,
-    createAirplanePermissions: zNullableBool,
-  }),
+  // Physical/capability facts — serialized by BaseAirplaneResource on EVERY
+  // airplane payload (not just the extended show shape).
+  minimumCrewCount: z.number().optional(),
+  classRating: z.string().nullable().optional(),
+  typeRating: z.string().nullable().optional(),
+  VFR: z.boolean().optional(),
+  VFRNight: z.boolean().optional(),
+  IFR: z.boolean().optional(),
+  IFRKnownIcing: z.boolean().optional(),
+  power: z.string().optional(),
+  fuel_type: z.string().optional(),
+  oil_min: z.string().optional(),
+  oil_max: z.string().optional(),
+  oil_type_winter: z.string().optional(),
+  oil_type_summer: z.string().optional(),
+  empty_weight: z.string().optional(),
+  max_takeoff_mass: z.string().optional(),
+  max_speed: z.string().optional(),
+  max_range: z.string().optional(),
+  equipment: z.array(equipmentSchema).optional(),
+  has_pre_paid_package: z.boolean().optional(),
+  logging_required_from: z.string().optional(),
+  fee_id: z.number().nullable().optional(),
+  booking_fee_id: z.number().nullable().optional(),
+  homebase: z
+    .object({
+      id: z.number(),
+      ident: z.string().optional(),
+      name: z.string().optional(),
+    })
+    .nullable()
+    .optional(),
+  // Loose record on purpose: gates are policy-reflected server-side and
+  // grow over time — same convention as companySchema.
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
+});
+
+/**
+ * Latest ADS-B position of the physical aircraft (eager-loaded relation on
+ * the company fleet-map payloads).
+ */
+export const aircraftPositionSchema = z.object({
+  lat: z.number().nullable().optional(),
+  lon: z.number().nullable().optional(),
+  timestamp: z.union([z.string(), z.number()]).nullable().optional(),
 });
 
 export const airplaneShareInviteSchema = z.object({
@@ -323,32 +387,8 @@ export const maintenanceStatusSchema = z.object({
     .optional(),
 });
 
+// AirplaneResource extras on top of the base shape (show payloads, fleet map).
 export const extendedAirplaneSchema = airplaneSchema.extend({
-  manufacturer: z.string().optional(),
-  capacity: z.number().optional(),
-  description: z.string().optional(),
-  homebase_id: z.number().optional(),
-  ato: z.boolean().optional(),
-  year_of_construction: z.string().optional(),
-  span: z.string().optional(),
-  height: z.string().optional(),
-  length: z.string().optional(),
-  empty_weight: z.string().optional(),
-  max_takeoff_mass: z.string().optional(),
-  max_speed: z.string().optional(),
-  max_range: z.string().optional(),
-  power: z.string().optional(),
-  fuel_type: z.string().optional(),
-  oil_min: z.string().optional(),
-  oil_max: z.string().optional(),
-  oil_type_winter: z.string().optional(),
-  oil_type_summer: z.string().optional(),
-  minimumCrewCount: z.number().optional(),
-  VFR: z.boolean().optional(),
-  VFRNight: z.boolean().optional(),
-  IFR: z.boolean().optional(),
-  IFRKnownIcing: z.boolean().optional(),
-  equipment: z.array(z.any()).optional(),
   contact: contactAttributeSchema.optional(),
   hints: z
     .object({
@@ -359,26 +399,16 @@ export const extendedAirplaneSchema = airplaneSchema.extend({
         .optional(),
     })
     .optional(),
-  has_pre_paid_package: z.boolean().optional(),
-  fee_id: z.number().optional(),
-  booking_fee_id: z.number().optional(),
-  logging_required_from: z.string().optional(),
   foreflight_profile_url: z.string().optional(),
-  media: z
-    .object({
-      avatar: z.any().optional(),
-      header: z.any().optional(),
-      images: z.array(z.any()).optional(),
-      documents: z.array(z.any()).optional(),
-    })
-    .optional(),
+  company: companySchema.optional(),
+  latestPosition: aircraftPositionSchema.nullable().optional(),
+  total_flight_time_minutes: z.number().nullable().optional(),
+  elapsed_time: z.number().nullable().optional(),
+  remaining_time: z.number().nullable().optional(),
+  completed_at: z.string().nullable().optional(),
+  flight_log_enabled: z.boolean().optional(),
+  latest_maintenance_event: maintenanceEventSchema.nullable().optional(),
   master_media: mediaCollection.optional(),
-  can: z
-    .object({
-      update: zNullableBool,
-      viewMaintenanceEvents: zNullableBool,
-    })
-    .optional(),
 });
 
 export const availSchema = z.object({
@@ -415,6 +445,26 @@ export const bookingWaypointSchema = z.object({
     .optional(),
 });
 
+/**
+ * Spatie activity-log row (ActivityResource) — audit trail entries loaded on
+ * booking/invoice/event show payloads (`activities` relation).
+ */
+export const activitySchema = z.object({
+  id: z.number(),
+  log_name: z.string().nullable().optional(),
+  description: z.string().optional(),
+  event: z.string().nullable().optional(),
+  subject_type: z.string().nullable().optional(),
+  subject_id: z.number().nullable().optional(),
+  causer_type: z.string().nullable().optional(),
+  causer_id: z.number().nullable().optional(),
+  causer: userSchema.nullable().optional(),
+  properties: z.record(z.string(), z.unknown()).optional(),
+  batch_uuid: z.string().nullable().optional(),
+  created_at: z.string().optional(),
+  updated_at: z.string().optional(),
+});
+
 export const bookingSchema = BaseModel.extend({
   type: z.literal("booking"),
   ifr: z.boolean().default(false),
@@ -467,11 +517,17 @@ export const bookingSchema = BaseModel.extend({
     .optional(),
   contact: zContactDTO.optional(),
   remarks: z.string().optional(),
-  can: z
-    .object({
-      update: zNullableBool,
-    })
-    .optional(),
+  ac_call: z.string().nullable().optional(),
+  ac_type: z.string().nullable().optional(),
+  // Audit trail (BookingResource `activities`, present when eager-loaded).
+  activities: z.array(activitySchema).optional(),
+  // Present when eager-loaded (BookingResource conditional appends). Lazy:
+  // both schemas are declared later in this file; there is no true cycle.
+  flight_logs: z.array(z.lazy(() => flightLogSchema)).optional(),
+  expense_items: z.array(z.lazy(() => expenseItemSchema)).optional(),
+  // Loose record on purpose: gates are policy-reflected server-side and
+  // grow over time — same convention as companySchema.
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
 });
 
 export const alertSchema = z.object({
@@ -684,6 +740,9 @@ export const flightLogSchema = z.object({
   id: z.number(),
   airplane_id: z.number(),
   airplane: airplaneSchema.optional(),
+  // Present when eager-loaded (FlightLogResource, camelCase key). Lazy:
+  // expenseItemSchema is declared later in this file; there is no true cycle.
+  expenseItems: z.array(z.lazy(() => expenseItemSchema)).optional(),
   ac_type: z.string().nullable().optional(),
   ac_reg: z.string().nullable().optional(),
   ac_call: z.string().nullable().optional(),
@@ -772,16 +831,30 @@ export const invoiceSchema = z.object({
   issuer_city: z.string().nullable().optional(),
   issuer_zip: z.string().nullable().optional(),
   issuer_state: z.string().nullable().optional(),
-  created_at: z.string(),
-  updated_at: z.string(),
-  can: z
+  issuer_bank_name: z.string().nullable().optional(),
+  issuer_bic: z.string().nullable().optional(),
+  issuer_iban: z.string().nullable().optional(),
+  issuer_email: z.string().nullable().optional(),
+  issuer_phone: z.string().nullable().optional(),
+  issuer_vat_id: z.string().nullable().optional(),
+  issuer_register_court: z.string().nullable().optional(),
+  issuer_register_number: z.string().nullable().optional(),
+  gross_total: zPhpMoneyObject.nullable().optional(),
+  net_total: zPhpMoneyObject.nullable().optional(),
+  // InvoiceResource media envelope: only the generated PDF.
+  media: z
     .object({
-      update: zNullableBool,
-      delete: zNullableBool,
-      release: zNullableBool,
-      view: zNullableBool,
+      pdf: mediaSchema.nullable().optional(),
     })
     .optional(),
+  pdf: z.string().nullable().optional(),
+  // Audit trail (InvoiceResource `activities`, present when eager-loaded).
+  activities: z.array(activitySchema).optional(),
+  created_at: z.string(),
+  updated_at: z.string(),
+  // Loose record on purpose: gates are policy-reflected server-side and
+  // grow over time — same convention as companySchema.
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
 });
 
 export const scheduledFlightSchema = z.object({
@@ -843,15 +916,6 @@ export const tagSchema = z.object({
   color: z.string().nullable().optional(),
 });
 
-// Slim attached progress-check sheet (course_check_syllabi pivot),
-// serialized on course show/update payloads.
-export const courseCheckSyllabusSchema = z.object({
-  id: z.number(),
-  name: z.string(),
-  version: z.number(),
-  kind: z.enum(["regular", "progress_check"]).default("regular"),
-});
-
 export const courseSchema = z.object({
   type: z.literal("course"),
   id: z.number(),
@@ -882,11 +946,19 @@ export const courseSchema = z.object({
   // Present only when the backend eager-loaded `checkSyllabi`.
   check_syllabi: z.array(courseCheckSyllabusSchema).optional(),
   tags: z.array(tagSchema).optional(),
+  // Attached fees (feeables pivot) + fees derived from them, when loaded.
+  fees: z.array(courseFeeSchema).optional(),
+  derived_fees: z.array(feeSchema).optional(),
+  fees_count: z.number().optional(),
+  is_public: z.boolean().optional(),
+  kind: z.string().optional(),
+  version: z.number().optional(),
+  media: mediaCollection,
   created_at: z.string(),
   updated_at: z.string(),
   // Loose record on purpose: gates are policy-reflected server-side and
   // grow over time (useAssistant, …) — same convention as companySchema.
-  can: z.record(z.string(), zNullableBool).optional(),
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
 });
 
 /**
@@ -929,11 +1001,44 @@ export const courseEnrollmentSchema = z.object({
   course: courseSchema.optional(),
   membership: membershipSchema.optional(),
   mentor: userSchema.optional(),
+  // Present when eager-loaded (BaseCourseEnrollmentResource). Lazy: both
+  // schemas are declared later in this file; there is no true cycle.
+  expense_items: z.array(z.lazy(() => expenseItemSchema)).optional(),
+  bookings: z.array(bookingSchema).optional(),
   // Loose record on purpose: gates are policy-reflected server-side and
   // grow over time (updateTraining, manageInitialPayment, …).
-  can: z.record(z.string(), zNullableBool).optional(),
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
+});
+
+/**
+ * Attendee row on an event (MembershipSignupResource — `event.signups`,
+ * present when the relation is eager-loaded).
+ */
+export const membershipSignupSchema = z.object({
+  id: z.number(),
+  membership_id: z.number(),
+  created_at: z.string().optional(),
+  membership: z
+    .object({
+      id: z.number(),
+      user_id: z.number().nullable().optional(),
+      name: z.string(),
+      user: z
+        .object({
+          name: z.string(),
+          firstname: z.string().nullable().optional(),
+          lastname: z.string().nullable().optional(),
+          email: z.string().nullable().optional(),
+        })
+        .nullable()
+        .optional(),
+    })
+    .nullable()
+    .optional(),
 });
 
+// Mirrors EventResource — company events with signups, media, and a contact
+// block; times render in the company timezone (UTC fallback).
 export const eventSchema = z.object({
   type: z.literal("event"),
   id: z.number(),
@@ -941,22 +1046,18 @@ export const eventSchema = z.object({
   company: companySchema.optional(),
   title: z.string(),
   description: z.string().nullable().optional(),
-  start_date: z.string(),
-  end_date: z.string().nullable().optional(),
-  all_day: z.boolean().default(false),
-  location: z.string().nullable().optional(),
-  category: z.string().nullable().optional(),
-  created_by: z.number(),
-  creator: userSchema.optional(),
-  created_at: z.string(),
-  updated_at: z.string(),
-  can: z
-    .object({
-      update: zNullableBool,
-      delete: zNullableBool,
-      attend: zNullableBool,
-    })
-    .optional(),
+  media: mediaCollection,
+  signups: z.array(membershipSignupSchema).optional(),
+  signups_count: z.number().optional(),
+  is_public: z.boolean(),
+  contact: zContactDTO.nullable().optional(),
+  start: z.string(),
+  end: z.string().nullable().optional(),
+  registrationDeadline: z.string().nullable().optional(),
+  registrationIsBinding: z.boolean(),
+  // Loose record on purpose: gates are policy-reflected server-side and
+  // grow over time — same convention as companySchema.
+  can: z.record(z.string(), z.boolean().nullable()).optional(),
 });
 
 export const addressSchema = z.object({