@updraft-solutions/mcrit-sdk 0.11.2 → 0.13.0

package/src/schemas/fbo.spec.ts

@@ -0,0 +1,49 @@
+import { describe, expect, it } from "vitest";
+import { fboDutySchema, fboFlightSchema } from "./fbo";
+
+/**
+ * Fixtures are copied from the API's FlightResource / DutyResource shapes, not
+ * invented, so a schema that drifts from the payload fails here rather than at
+ * runtime in the app.
+ */
+const flightPayload = {
+  id: 44796, type: "ppr", uuid: "0f1b3d5e-0000-4000-8000-000000000001", flight_status: "pending",
+  company_id: 34, author_id: null,
+  ac_call: "DEABC", ac_reg: null, ac_type: "C172", operator: "PrivateWings",
+  etdZ: "2026-09-01T20:00:00.000000Z", etdZ_no_time: false, etaZ: null, etaZ_no_time: false,
+  departure_airport_id: 2753, destination_airport_id: null,
+  ifr: false, wx: false, landings: 1, remarks: null,
+  contact: { name: "Erika Muster", email: "erika@example.test", phone: null, company: null, fax: null },
+  ground_services: { stairs: false, hangar: false, car_access: false, lifter: false, rental_car: false, refueling: false, gpu: false },
+  acceptance_status: {
+    fbo: { status: "pending", is_required: true, decided_by_id: null, updated_at: "2026-08-26T10:00:00.000000Z" },
+    airport: { status: "unknown", is_required: false, decided_by_id: null, updated_at: null },
+    customs: { status: "unknown", is_required: false, decided_by_id: null, updated_at: null },
+  },
+  created_at: "2026-08-26T10:00:00.000000Z", updated_at: "2026-08-26T10:00:00.000000Z",
+};
+
+describe("fboFlightSchema", () => {
+  it("parses a PPR exactly as FlightResource emits it", () => {
+    expect(fboFlightSchema.parse(flightPayload).type).toBe("ppr");
+  });
+
+  it("rejects a status outside AcceptanceStatusData's vocabulary", () => {
+    const bad = { ...flightPayload, acceptance_status: { ...flightPayload.acceptance_status, fbo: { ...flightPayload.acceptance_status.fbo, status: "idle" } } };
+    expect(() => fboFlightSchema.parse(bad)).toThrow();
+  });
+
+  it("rejects the flight-school type — the FBO domain never holds a 'booking'", () => {
+    expect(() => fboFlightSchema.parse({ ...flightPayload, type: "booking" })).toThrow();
+  });
+});
+
+describe("fboDutySchema", () => {
+  it("accepts a userless, occupation-less duty — 27% of the migrated roster has no user", () => {
+    expect(fboDutySchema.parse({
+      id: 1, company_id: 35, user_id: null, author_id: null, occupation_id: null, scheduled_flight_id: null,
+      start: "2026-09-01T18:00:00.000000Z", end: "2026-09-01T23:00:00.000000Z", all_day: false, remarks: null,
+      created_at: null, updated_at: null,
+    }).user_id).toBeNull();
+  });
+});

package/src/schemas/fbo.ts

@@ -0,0 +1,126 @@
+import { z } from "zod";
+import { zContactDTO } from "./common";
+import { airportSchema } from "./models";
+
+/**
+ * FBO domain — flights (scheduled movements and PPRs), duties, occupations and
+ * the per-company FBO profile. Shapes mirror the API's FBO resources exactly:
+ * `FlightResource`, `DutyResource`, `OccupationResource`, and the `fbo` block on
+ * `CompanyResource`.
+ *
+ * Distinct from `scheduledFlightSchema` in models.ts, which predates the FBO
+ * domain and does not describe these payloads (it has `booking_id`,
+ * `departure_time`, `flight_number` — none of which the API emits here).
+ */
+
+/** One acceptance axis. `status` mirrors `AcceptanceStatusData`'s `#[In]` rule. */
+export const fboAcceptanceAxisSchema = z.object({
+  status: z.enum(["pending", "accepted", "rejected", "unknown"]),
+  is_required: z.boolean(),
+  decided_by_id: z.number().nullable(),
+  updated_at: z.string().nullable(),
+});
+
+export const fboAcceptanceStatusSchema = z.object({
+  fbo: fboAcceptanceAxisSchema,
+  airport: fboAcceptanceAxisSchema,
+  customs: fboAcceptanceAxisSchema,
+});
+
+export const fboGroundServicesSchema = z.object({
+  stairs: z.boolean(),
+  hangar: z.boolean(),
+  car_access: z.boolean(),
+  lifter: z.boolean(),
+  rental_car: z.boolean(),
+  refueling: z.boolean(),
+  gpu: z.boolean(),
+});
+
+export const fboFlightTypeSchema = z.enum(["scheduledFlight", "ppr"]);
+export const fboFlightStatusSchema = z.enum(["active", "pending", "cancelled"]);
+
+export const fboFlightSchema = z.object({
+  id: z.number(),
+  type: fboFlightTypeSchema,
+  uuid: z.string(),
+  flight_status: fboFlightStatusSchema,
+  company_id: z.number(),
+  author_id: z.number().nullable(),
+
+  ac_call: z.string().nullable(),
+  ac_reg: z.string().nullable(),
+  ac_type: z.string().nullable(),
+  operator: z.string().nullable(),
+
+  etdZ: z.string().nullable(),
+  /** The filer gave a date but no time; `etdZ` then holds a placeholder midnight. */
+  etdZ_no_time: z.boolean(),
+  etaZ: z.string().nullable(),
+  etaZ_no_time: z.boolean(),
+
+  departure_airport_id: z.number().nullable(),
+  departure_airport: airportSchema.optional(),
+  destination_airport_id: z.number().nullable(),
+  destination_airport: airportSchema.optional(),
+
+  ifr: z.boolean(),
+  wx: z.boolean(),
+  landings: z.number().nullable(),
+  remarks: z.string().nullable(),
+
+  contact: zContactDTO,
+  ground_services: fboGroundServicesSchema,
+  acceptance_status: fboAcceptanceStatusSchema,
+
+  created_at: z.string(),
+  updated_at: z.string(),
+});
+
+export const fboOccupationSchema = z.object({
+  id: z.number(),
+  company_id: z.number(),
+  author_id: z.number().nullable(),
+  title: z.string(),
+  description: z.string().nullable(),
+  is_absence: z.boolean(),
+  created_at: z.string().nullable(),
+  updated_at: z.string().nullable(),
+});
+
+export const fboDutySchema = z.object({
+  id: z.number(),
+  company_id: z.number().nullable(),
+  user_id: z.number().nullable(),
+  author_id: z.number().nullable(),
+  occupation_id: z.number().nullable(),
+  occupation: fboOccupationSchema.optional(),
+  scheduled_flight_id: z.number().nullable(),
+  start: z.string(),
+  end: z.string(),
+  all_day: z.boolean(),
+  remarks: z.string().nullable(),
+  created_at: z.string().nullable(),
+  updated_at: z.string().nullable(),
+});
+
+/** Served by `GET companies/{id}/fbo/meta` so no client hardcodes the list. */
+export const fboRoleSchema = z.enum(["fbo", "atc", "wx", "customs", "handling", "fuel", "operator"]);
+
+/** The `fbo` block on the company payload — present iff the company holds a profile. */
+export const fboCompanyProfileSchema = z.object({
+  role: fboRoleSchema,
+  flights_require_approval: z.boolean(),
+  notify_on_movement: z.boolean(),
+  has_duties: z.boolean(),
+  has_airplanes: z.boolean(),
+});
+
+export const fboDecisionAxisSchema = z.enum(["fbo", "airport", "customs"]);
+export const fboDecisionSchema = z.enum(["accepted", "rejected"]);
+
+/** `POST companies/{id}/fbo/flights/{flight}/decision` */
+export const fboDecisionInputSchema = z.object({
+  axis: fboDecisionAxisSchema,
+  status: fboDecisionSchema,
+});

package/src/schemas/index.ts

@@ -10,3 +10,4 @@ export * from "./equipment";
 export * from "./newsletter";
 export * from "./location-map";
 export * from "./todo";
+export * from "./fbo";

package/src/schemas/models.ts

@@ -1,6 +1,7 @@
 import { z } from "zod";
 import {
   BaseModel,
+  companyIdentitySchema,
   companySchema,
   contactAttributeSchema,
   mediaCollection,
@@ -14,14 +15,32 @@ import {
 import { equipmentSchema } from "./equipment";
 import { courseCheckSyllabusSchema } from "./training";
 
-export const baseMembershipSchema = z.object({
+/**
+ * Identity-only membership — the shape nested in list rows (server:
+ * `MembershipIdentityResource`). It answers "who is this" and nothing else:
+ * the full nesting carries the company payload, i.e. the requesting user's
+ * whole permission list, repeated on every row.
+ */
+export const membershipIdentitySchema = z.object({
   type: z.literal("membership"),
   id: z.number(),
   user_id: z.number(),
   user: userSchema.optional(),
   company_id: z.number(),
-  company: companySchema.nullable().optional(),
   name: z.string(),
+});
+
+/**
+ * The membership as nested in another model's payload: identity, plus the
+ * identity-only company for the surfaces that list rows across companies
+ * (pre-paid packages, course enrollments).
+ */
+export const nestedMembershipSchema = membershipIdentitySchema.extend({
+  company: companyIdentitySchema.nullable().optional(),
+});
+
+export const baseMembershipSchema = membershipIdentitySchema.extend({
+  company: companyIdentitySchema.nullable().optional(),
   phone: z.string().nullable().optional(),
   status: z.string(),
   instructor: z.boolean(),
@@ -92,7 +111,7 @@ export const feeSchema = BaseModel.extend({
   prices: z.array(priceSchema).optional(),
   provider: z.string().nullable().optional(),
   company_id: z.number().optional(),
-  company: companySchema.optional(),
+  company: companyIdentitySchema.optional(),
   ident: z.string().optional(),
   category: z.string().optional(),
   subcategory: z.string().nullable().optional(),
@@ -273,7 +292,7 @@ export const airplanePermissionSchema = z.object({
   airplane_id: z.number(),
   airplane: airplaneSchema.optional(),
   membership_id: z.number(),
-  membership: baseMembershipSchema.optional(),
+  membership: nestedMembershipSchema.optional(),
   notes: z.string().nullable().optional(),
   conditions: z.string().nullable().optional(),
   expires_at: z.string().nullable().optional(),
@@ -404,7 +423,7 @@ export const extendedAirplaneSchema = airplaneSchema.extend({
     })
     .optional(),
   foreflight_profile_url: z.string().optional(),
-  company: companySchema.optional(),
+  company: companyIdentitySchema.optional(),
   latestPosition: aircraftPositionSchema.nullable().optional(),
   total_flight_time_minutes: z.number().nullable().optional(),
   elapsed_time: z.number().nullable().optional(),
@@ -476,6 +495,9 @@ export const bookingSchema = BaseModel.extend({
   author: userSchema.optional(),
   company_id: z.number(),
   company_name: z.string().nullable().optional(),
+  // Single-booking payloads only (BookingDetailResource): the dialog gates
+  // on this company, which a shared aircraft can make a partner company.
+  // List rows never carry it.
   company: companySchema.optional(),
   airplane: airplaneSchema.optional(),
   etdZ: z.string(),
@@ -494,6 +516,9 @@ export const bookingSchema = BaseModel.extend({
     .enum(["draft", "awaiting_signatures", "signed"])
     .nullable()
     .optional(),
+  // Single-booking payloads only (BookingDetailResource): neighbour lookups
+  // cost two queries per booking and only the dialog's prev/next navigation
+  // uses them.
   next_booking_id: z.number().nullable().optional(),
   previous_booking_id: z.number().nullable().optional(),
   maintenance: z.number().optional(),
@@ -793,7 +818,7 @@ export const flightLogSchema = z.object({
   ac_call: z.string().nullable().optional(),
   booking_id: z.number().nullable().optional(),
   membership_id: z.number().nullable().optional(),
-  membership: baseMembershipSchema.optional(),
+  membership: nestedMembershipSchema.optional(),
   billing_profile_id: z.number().nullable().optional(),
   author_id: z.number(),
   author: userSchema.optional(),
@@ -843,7 +868,10 @@ export const invoiceSchema = z.object({
   id: z.number(),
   title: z.string(),
   membership_id: z.number(),
-  membership: baseMembershipSchema.optional(),
+  // List rows (InvoiceListResource) carry the identity-only membership; the
+  // single-invoice payload carries the full one. Typed as the identity shape —
+  // the guaranteed part — with the rest passed through.
+  membership: nestedMembershipSchema.optional(),
   // InvoiceResource always emits `billing_profile_id` (non-optional key,
   // nullable FK value). `billingProfile` is a `whenLoaded('billingProfile')`
   // relation, so it stays optional. (Fix round 1: as of the original Task 16
@@ -854,7 +882,12 @@ export const invoiceSchema = z.object({
   billingProfile: billingProfileSchema.optional(),
   company_id: z.number().optional(),
   company: companySchema.optional(),
+  // Numbering: invoices are numbered in `sequence_number`, receipts in
+  // `receipt_number`. `document_number` is whichever applies — render that.
+  document_type: z.string().nullable().optional(),
   sequence_number: z.string().nullable().optional(),
+  receipt_number: z.string().nullable().optional(),
+  document_number: z.string().nullable().optional(),
   order_number: z.string().nullable().optional(),
   invoice_date: z.string().nullable().optional(),
   due_date: z.string().nullable().optional(),
@@ -1054,7 +1087,7 @@ export const courseEnrollmentSchema = z.object({
   created_at: z.string(),
   updated_at: z.string(),
   course: courseSchema.optional(),
-  membership: membershipSchema.optional(),
+  membership: nestedMembershipSchema.optional(),
   mentor: userSchema.optional(),
   // Present when eager-loaded (BaseCourseEnrollmentResource). Lazy: both
   // schemas are declared later in this file; there is no true cycle.
@@ -1098,7 +1131,7 @@ export const eventSchema = z.object({
   type: z.literal("event"),
   id: z.number(),
   company_id: z.number(),
-  company: companySchema.optional(),
+  company: companyIdentitySchema.optional(),
   title: z.string(),
   description: z.string().nullable().optional(),
   media: mediaCollection,
@@ -1427,7 +1460,7 @@ export const expenseItemSchema = z.object({
   // maximum length"). No true cycle: invoiceSchema does not reference
   // expenseItemSchema back.
   invoice: z.lazy((): z.ZodTypeAny => invoiceSchema).optional(),
-  membership: baseMembershipSchema.optional(),
+  membership: nestedMembershipSchema.optional(),
   prePaidPackageAssignments: z
     .array(prePaidPackageAssignmentSchema)
     .optional(),

package/src/types/fbo.ts

@@ -0,0 +1,16 @@
+import type { z } from "zod";
+import type * as Fbo from "../schemas/fbo";
+
+export type FboAcceptanceAxis = z.infer<typeof Fbo.fboAcceptanceAxisSchema>;
+export type FboAcceptanceStatus = z.infer<typeof Fbo.fboAcceptanceStatusSchema>;
+export type FboGroundServices = z.infer<typeof Fbo.fboGroundServicesSchema>;
+export type FboFlightType = z.infer<typeof Fbo.fboFlightTypeSchema>;
+export type FboFlightStatus = z.infer<typeof Fbo.fboFlightStatusSchema>;
+export type FboFlight = z.infer<typeof Fbo.fboFlightSchema>;
+export type FboOccupation = z.infer<typeof Fbo.fboOccupationSchema>;
+export type FboDuty = z.infer<typeof Fbo.fboDutySchema>;
+export type FboRole = z.infer<typeof Fbo.fboRoleSchema>;
+export type FboCompanyProfile = z.infer<typeof Fbo.fboCompanyProfileSchema>;
+export type FboDecisionAxis = z.infer<typeof Fbo.fboDecisionAxisSchema>;
+export type FboDecision = z.infer<typeof Fbo.fboDecisionSchema>;
+export type FboDecisionInput = z.infer<typeof Fbo.fboDecisionInputSchema>;

package/src/types/index.ts

@@ -7,3 +7,4 @@ export * from "./ai";
 export * from "./roles";
 export * from "./landing-fee";
 export * from "./operating-hours";
+export * from "./fbo";