@updraft-solutions/mcrit-sdk 0.1.0 → 0.2.0

package/src/schemas/models.ts

@@ -3,6 +3,7 @@ import {
   BaseModel,
   companySchema,
   contactAttributeSchema,
+  mediaCollection,
   mediaSchema,
   userSchema,
   zContactDTO,
@@ -19,11 +20,24 @@ export const baseMembershipSchema = z.object({
   company_id: z.number(),
   company: companySchema.nullable().optional(),
   name: z.string(),
+  phone: z.string().nullable().optional(),
   status: z.string(),
   instructor: z.boolean(),
   admin: z.boolean(),
   accountant: z.boolean(),
   student: z.boolean(),
+  content_creator: z.boolean(),
+  charter_client: z.boolean(),
+  roles: z
+    .array(
+      z
+        .object({
+          id: z.number(),
+          name: z.string(),
+        })
+        .passthrough(),
+    )
+    .optional(),
   created_at: z.string(),
   updated_at: z.string(),
   can: z
@@ -105,6 +119,7 @@ export const courseFeeSchema = feeSchema.extend({
   count: z.number().optional(),
   variant: z.string().optional(),
   is_optional: z.boolean().optional(),
+  is_initial_payment: z.boolean().optional(),
 });
 
 export const airplaneSchema = BaseModel.extend({
@@ -113,20 +128,23 @@ export const airplaneSchema = BaseModel.extend({
   company_id: z.number(),
   registration: z.string(),
   model: z.string(),
-  media: z
-    .object({
-      avatar: mediaSchema.nullable().optional(),
-      header: mediaSchema.nullable().optional(),
-      images: z.array(mediaSchema).nullable().optional(),
-      documents: z.array(mediaSchema).nullable().optional(),
-    })
-    .nullable()
-    .optional()
-    .optional(),
+  media: mediaCollection.optional(),
   fee: feeSchema.optional(),
   booking_fee: feeSchema.optional(),
   hasFavorited: z.boolean().optional(),
   homebase_id: z.number().nullable().optional(),
+  hangar_location_map_feature_id: z.number().nullable().optional(),
+  parking_lng: z.number().nullable().optional(),
+  parking_lat: z.number().nullable().optional(),
+  hangar: z
+    .object({
+      id: z.number(),
+      name: z.string().nullable(),
+      kind: z.string(),
+      location_map_id: z.number(),
+    })
+    .nullable()
+    .optional(),
   description: z.string().optional(),
   capacity: z.number().optional(),
   manufacturer: z.string().optional(),
@@ -142,7 +160,7 @@ export const airplaneSchema = BaseModel.extend({
     viewMaintenanceEvents: zNullableBool,
     createMaintenanceEvents: zNullableBool,
     createBooking: zNullableBool,
-    manageAirplanePermissions: zNullableBool,
+    createAirplanePermissions: zNullableBool,
   }),
 });
 
@@ -338,11 +356,9 @@ export const bookingSchema = BaseModel.extend({
   ifr: z.boolean().default(false),
   airplane_id: z.number(),
   author: userSchema.optional(),
-  attendants: z.array(userSchema).optional(),
   company_id: z.number(),
   company: companySchema.optional(),
   airplane: airplaneSchema.optional(),
-  attendant_ids: z.array(z.number()).optional(),
   etdZ: z.string(),
   etaZ: z.string(),
   duration_minutes: z.number().optional(),
@@ -353,6 +369,28 @@ export const bookingSchema = BaseModel.extend({
   next_booking_id: z.number().nullable().optional(),
   previous_booking_id: z.number().nullable().optional(),
   maintenance: z.number().optional(),
+  is_solo: z.boolean().optional().default(false),
+  course_enrollment_id: z.number().nullable().optional(),
+  // Minimal linked enrollment, present on booking show/store/update payloads.
+  // Used by the form prefill registry to derive the J2 Flugauftrag course.
+  course_enrollment: z
+    .object({
+      id: z.number(),
+      course_id: z.number().nullable().optional(),
+    })
+    .nullable()
+    .optional(),
+  crew_assignments: z
+    .array(
+      z.object({
+        id: z.number().optional(),
+        membership_id: z.number(),
+        role: z.string(),
+        is_pic: z.boolean().optional(),
+        membership: z.any().optional(),
+      }),
+    )
+    .optional(),
   contact: zContactDTO.optional(),
   remarks: z.string().optional(),
   can: z
@@ -400,11 +438,22 @@ export const documentSchema = z.object({
     .optional(),
 });
 
+// Post merge-phase-3a a requirement references a FormTemplate
+// (`form_template_id` + nested `form_template`) instead of a DocumentType
+// FQCN. Schema NAMES keep the `document*` prefix, matching the backend's
+// kept `documentRequirementGroups` route names (the legacy document domain
+// itself was deleted in merge Phase 4).
 export const documentRequirement = z.object({
   id: z.number(),
-  document_requirement_group_id: z.number(),
-  document_type_class: z.string(),
-  document_type: documentType.optional(),
+  form_requirement_group_id: z.number(),
+  form_template_id: z.number(),
+  form_template: z
+    .object({
+      id: z.number(),
+      name: z.string(),
+      slug: z.string().nullable().optional(),
+    })
+    .optional(),
   logical_group: z.string().nullable().optional(),
   group_operator: z.enum(["AND", "OR"]).nullable().optional(),
   metadata: z
@@ -429,10 +478,10 @@ export const documentRequirementGroup = z.object({
   company_id: z.number().nullable().optional(),
   is_default_template: z.boolean().default(false),
   is_active: z.boolean().default(true),
-  requirements: z.array(documentRequirement).optional(),
-  documentRequirements: z.array(documentRequirement).optional(),
+  requirements: z.array(documentRequirement).optional(), // Backend uses 'requirements'
+  documentRequirements: z.array(documentRequirement).optional(), // Frontend compatibility
   group_operator: z.enum(["AND", "OR"]).default("AND"),
-  requirements_count: z.number().optional(),
+  documentRequirements_count: z.number().optional(),
   assignments_count: z.number().optional(),
   created_by: z.number().nullable().optional(),
   updated_by: z.number().nullable().optional(),
@@ -451,9 +500,9 @@ export const documentRequirementGroupAssignment = z.object({
   id: z.number(),
   assignable_type: z.string(),
   assignable_id: z.number(),
-  document_requirement_group_id: z.number(),
+  requirement_group_id: z.number(),
   requirement_group: documentRequirementGroup.optional(),
-  requirementGroup: documentRequirementGroup.optional(),
+  requirementGroup: documentRequirementGroup.optional(), // Frontend compatibility
   created_at: z.string(),
   updated_at: z.string(),
 });
@@ -574,11 +623,21 @@ export const flightLogSchema = z.object({
   etdZ: z.string(),
   etaZ: z.string(),
   duration_minutes: z.number(),
-  crew: z.array(z.any()).nullable().optional(),
-  attendants: z.array(z.any()).nullable().optional(),
+  crew_assignments: z
+    .array(
+      z.object({
+        id: z.number().optional(),
+        membership_id: z.number(),
+        role: z.string(),
+        is_pic: z.boolean().optional(),
+        membership: z.any().optional(),
+      }),
+    )
+    .optional(),
   total_landings: z.number().nullable().optional(),
   full_stop_landings: z.number().nullable().optional(),
   touch_and_gos: z.number().default(0),
+  low_approaches: z.number().default(0),
   flight_rule: z.string().nullable().optional(),
   flight_time_type: z.string().nullable().optional(),
   dep_airport_id: z.number().nullable().optional(),
@@ -632,6 +691,7 @@ export const invoiceSchema = z.object({
   recipient_zip: z.string().nullable().optional(),
   recipient_state: z.string().nullable().optional(),
   recipient_country: z.string().nullable().optional(),
+  recipient_vat_id: z.string().nullable().optional(),
   issuer_name: z.string().nullable().optional(),
   issuer_address_street_1: z.string().nullable().optional(),
   issuer_address_street_2: z.string().nullable().optional(),
@@ -727,6 +787,21 @@ export const courseSchema = z.object({
     .optional(),
 });
 
+/**
+ * Materialized, admin-only metrics for an enrollment — recomputed server-side
+ * (see m-crit-api course_enrollment_metrics). `flags` is an extensible bag of
+ * computed booleans (e.g. `has_solo`).
+ */
+export const courseEnrollmentMetricsSchema = z.object({
+  last_flight_at: z.string().nullable(),
+  next_flight_at: z.string().nullable(),
+  total_flight_minutes: z.number().default(0),
+  flags: z
+    .record(z.string(), z.union([z.boolean(), z.number(), z.string()]))
+    .default({}),
+  calculated_at: z.string().nullable(),
+});
+
 export const courseEnrollmentSchema = z.object({
   type: z.literal("course_enrollment").optional(),
   id: z.number(),
@@ -738,7 +813,11 @@ export const courseEnrollmentSchema = z.object({
   enrollment_date: z.string(),
   completion_date: z.string().nullable().optional(),
   progress_percentage: z.number().default(0),
+  milestone_count: z.number().optional(),
   comments: z.string().nullable().optional(),
+  initial_payment_generated: z.boolean().optional(),
+  initial_payment_removable: z.boolean().optional(),
+  metrics: courseEnrollmentMetricsSchema.optional(),
   created_at: z.string(),
   updated_at: z.string(),
   course: courseSchema.optional(),
@@ -792,6 +871,7 @@ export const addressSchema = z.object({
   state: z.string().nullable().optional(),
   country: z.string().nullable().optional(),
   additional_info: z.string().nullable().optional(),
+  vat_id: z.string().nullable().optional(),
   created_at: z.string(),
   updated_at: z.string(),
 });
@@ -877,21 +957,26 @@ export const settingSchema = z.object({
 export const postSchema = z.object({
   type: z.literal("post"),
   id: z.number(),
-  postable_type: z.string(),
-  postable_id: z.number(),
+  company_id: z.number(),
+  postable_type: z.string().nullable().optional(),
+  postable_id: z.number().nullable().optional(),
   author_id: z.number(),
   author: userSchema.optional(),
-  title: z.string(),
+  title: z.string().nullable().optional(),
   content: z.string(),
-  published: z.boolean().default(false),
-  published_at: z.string().nullable().optional(),
+  sticky: z.boolean().default(false),
+  public: z.boolean().default(false),
+  media: mediaCollection.optional(),
   created_at: z.string(),
   updated_at: z.string(),
   can: z
     .object({
+      view: zNullableBool,
       update: zNullableBool,
       delete: zNullableBool,
-      publish: zNullableBool,
+      setFlags: zNullableBool,
+      restore: zNullableBool,
+      forceDelete: zNullableBool,
     })
     .optional(),
 });
@@ -906,7 +991,6 @@ export const commentSchema = z.object({
   body: z.string(),
   author_id: z.number().optional(),
   author: userSchema.optional(),
-  resolved_at: z.string().optional().nullable(),
   created_at: z.string(),
   updated_at: z.string().optional(),
   children: z.lazy((): z.ZodTypeAny => commentSchema.array()).optional(),
@@ -915,7 +999,6 @@ export const commentSchema = z.object({
       view: z.boolean().optional(),
       update: z.boolean().optional().nullable(),
       delete: z.boolean().optional().nullable(),
-      resolve: z.boolean().optional(),
       reply: z.boolean().optional(),
       viewComments: z.boolean().optional(),
       createComments: z.boolean().optional(),
@@ -923,6 +1006,45 @@ export const commentSchema = z.object({
     .optional(),
 });
 
+// Airplane issue (aviation defect log) — matches backend AirplaneIssueResource
+export const airplaneIssueSeverityEnum = z.enum([
+  "minor",
+  "major",
+  "grounding",
+]);
+export const airplaneIssueStatusEnum = z.enum(["open", "deferred", "resolved"]);
+
+export const airplaneIssueSchema = z.object({
+  type: z.literal("airplaneIssue"),
+  id: z.number(),
+  airplane_id: z.number(),
+  title: z.string().nullable().optional(),
+  body: z.string(),
+  severity: airplaneIssueSeverityEnum,
+  ata_chapter: z.string().nullable().optional(),
+  status: airplaneIssueStatusEnum,
+  reporter: userSchema.optional(),
+  resolver: userSchema.optional(),
+  deferred_at: z.string().nullable().optional(),
+  deferred_until: z.string().nullable().optional(),
+  deferral_notes: z.string().nullable().optional(),
+  resolved_at: z.string().nullable().optional(),
+  resolution_notes: z.string().nullable().optional(),
+  attachments: z.array(mediaSchema).optional(),
+  created_at: z.string(),
+  updated_at: z.string().optional(),
+  can: z
+    .object({
+      view: z.boolean().nullable().optional(),
+      update: z.boolean().nullable().optional(),
+      resolve: z.boolean().nullable().optional(),
+      defer: z.boolean().nullable().optional(),
+      reopen: z.boolean().nullable().optional(),
+      delete: z.boolean().nullable().optional(),
+    })
+    .optional(),
+});
+
 export const specialFlightSchema = z.object({
   type: z.literal("specialFlight"),
   id: z.number(),

package/src/types/models.ts

@@ -99,6 +99,18 @@ export type Course = z.infer<typeof ModelSchemas.courseSchema>;
 export type CourseEnrollment = z.infer<
   typeof ModelSchemas.courseEnrollmentSchema
 >;
+export type CourseEnrollmentMetrics = z.infer<
+  typeof ModelSchemas.courseEnrollmentMetricsSchema
+>;
+
+// Airplane issue (aviation defect log) Types
+export type AirplaneIssue = z.infer<typeof ModelSchemas.airplaneIssueSchema>;
+export type AirplaneIssueSeverity = z.infer<
+  typeof ModelSchemas.airplaneIssueSeverityEnum
+>;
+export type AirplaneIssueStatus = z.infer<
+  typeof ModelSchemas.airplaneIssueStatusEnum
+>;
 
 // Communication and Support Types
 export type Event = z.infer<typeof ModelSchemas.eventSchema>;