@updraft-solutions/mcrit-sdk 0.10.0 → 0.11.1

package/src/schemas/models.ts

@@ -9,7 +9,7 @@ import {
   zContactDTO,
   zNullableBool,
   zNetGross,
-  zPhpMoneyObject,
+  zMoneyObject,
 } from "./common";
 import { equipmentSchema } from "./equipment";
 import { courseCheckSyllabusSchema } from "./training";
@@ -75,8 +75,8 @@ export const documentType = z.object({
 
 export const priceSchema = z.object({
   id: z.number(),
-  gross_total: zPhpMoneyObject,
-  net_total: zPhpMoneyObject,
+  gross_total: zMoneyObject,
+  net_total: zMoneyObject,
   tax_percentage: z.number(),
   valid_from: z.string(),
   created_at: z.string(),
@@ -149,6 +149,10 @@ export const courseFeeSchema = feeSchema.extend({
   is_initial_payment: z.boolean().optional(),
 });
 
+/** Fuel quantity unit as printed in the AFM/POH; per hour when used for `cruise_fuel_flow`. */
+export const fuelUnitSchema = z.enum(["l", "usgal", "kg", "lb"]);
+export type FuelUnit = z.infer<typeof fuelUnitSchema>;
+
 export const airplaneSchema = BaseModel.extend({
   type: z.literal("airplane"),
   id: z.number(),
@@ -189,9 +193,6 @@ export const airplaneSchema = BaseModel.extend({
     .optional(),
   is_simulator: z.boolean().optional(),
   category: z.string().nullable().optional(),
-  averageFuelConsumption: z.string().nullable().optional(),
-  weightUnitString: z.string().optional(),
-  fuelUnitString: z.string().optional(),
   isoCountryCodeFromRegistration: z.string().optional(),
   registrationWithoutSpecialChars: z.string().nullable().optional(),
   equipmentCodes: z.array(z.string()).nullable().optional(),
@@ -221,6 +222,9 @@ export const airplaneSchema = BaseModel.extend({
   max_takeoff_mass: z.string().optional(),
   max_speed: z.string().optional(),
   max_range: z.string().optional(),
+  // Cruise fuel-flow baseline (~75 % power / ISA; POH authoritative).
+  cruise_fuel_flow: z.number().nullable().optional(),
+  cruise_fuel_flow_unit: fuelUnitSchema.nullable().optional(),
   equipment: z.array(equipmentSchema).optional(),
   has_pre_paid_package: z.boolean().optional(),
   logging_required_from: z.string().optional(),
@@ -446,7 +450,7 @@ export const bookingWaypointSchema = z.object({
 });
 
 /**
- * Spatie activity-log row (ActivityResource) — audit trail entries loaded on
+ * Activity-log row (ActivityResource) — audit trail entries loaded on
  * booking/invoice/event show payloads (`activities` relation).
  */
 export const activitySchema = z.object({
@@ -736,7 +740,7 @@ export const allowedDocumentTypeSchema = z.object({
 });
 
 // Billing recipient (formerly "Address"; the `addresses` table was renamed
-// to `billing_profiles` — see BillingProfileResource.php). A membership/user
+// to `billing_profiles` — see BillingProfileResource). A membership/user
 // can own several profiles (e.g. private vs. "Firma"); invoices, flight logs
 // and expense items each point at one via `billing_profile_id`.
 export const billingProfileSchema = z.object({
@@ -821,8 +825,8 @@ export const flightLogSchema = z.object({
   arr_airport: airportSchema.optional(),
   from: z.string().nullable().optional(),
   to: z.string().nullable().optional(),
-  costs: zPhpMoneyObject.nullable().optional(),
-  charge: zPhpMoneyObject.nullable().optional(),
+  costs: zMoneyObject.nullable().optional(),
+  charge: zMoneyObject.nullable().optional(),
   remarks: z.string().nullable().optional(),
   created_at: z.string(),
   updated_at: z.string(),
@@ -840,7 +844,7 @@ export const invoiceSchema = z.object({
   title: z.string(),
   membership_id: z.number(),
   membership: baseMembershipSchema.optional(),
-  // InvoiceResource.php always emits `billing_profile_id` (non-optional key,
+  // 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
   // commit, InvoiceResource hadn't gained `billing_profile_id` yet — it was
@@ -856,10 +860,10 @@ export const invoiceSchema = z.object({
   due_date: z.string().nullable().optional(),
   status: z.string().nullable().optional(),
   paid_status: z.string().nullable().optional(),
-  total: zPhpMoneyObject.nullable().optional(),
-  subtotal: zPhpMoneyObject.nullable().optional(),
-  tax_amount: zPhpMoneyObject.nullable().optional(),
-  discount_amount: zPhpMoneyObject.nullable().optional(),
+  total: zMoneyObject.nullable().optional(),
+  subtotal: zMoneyObject.nullable().optional(),
+  tax_amount: zMoneyObject.nullable().optional(),
+  discount_amount: zMoneyObject.nullable().optional(),
   paid_at: z.string().nullable().optional(),
   released_at: z.string().nullable().optional(),
   sent: z.number().default(0),
@@ -892,8 +896,8 @@ export const invoiceSchema = z.object({
   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(),
+  gross_total: zMoneyObject.nullable().optional(),
+  net_total: zMoneyObject.nullable().optional(),
   // InvoiceResource media envelope: only the generated PDF.
   media: z
     .object({
@@ -945,7 +949,7 @@ export const expenseSchema = z.object({
   membership: baseMembershipSchema.optional(),
   title: z.string(),
   description: z.string().nullable().optional(),
-  amount: zPhpMoneyObject,
+  amount: zMoneyObject,
   status: z.string().nullable().optional(),
   expense_date: z.string().nullable().optional(),
   invoice_id: z.number().nullable().optional(),
@@ -960,8 +964,7 @@ export const expenseSchema = z.object({
     .optional(),
 });
 
-// Company-scoped tag (shared pool across taggable models — see
-// m-crit-api docs/features/tags.md).
+// Company-scoped tag (shared pool across taggable models).
 export const tagSchema = z.object({
   type: z.literal("tag").optional(),
   id: z.number(),
@@ -979,7 +982,7 @@ export const courseSchema = z.object({
   start_date: z.string().nullable().optional(),
   end_date: z.string().nullable().optional(),
   max_participants: z.number().nullable().optional(),
-  price: zPhpMoneyObject.nullable().optional(),
+  price: zMoneyObject.nullable().optional(),
   instructor_id: z.number().nullable().optional(),
   instructor: userSchema.optional(),
   aircraft_required: z.boolean().default(false),
@@ -1016,7 +1019,7 @@ export const courseSchema = z.object({
 
 /**
  * Materialized, admin-only metrics for an enrollment — recomputed server-side
- * (see m-crit-api course_enrollment_metrics). `flags` is an extensible bag of
+ * (see the course_enrollment_metrics snapshot). `flags` is an extensible bag of
  * computed booleans (e.g. `has_solo`).
  */
 export const courseEnrollmentMetricsSchema = z.object({
@@ -1044,8 +1047,7 @@ export const courseEnrollmentSchema = z.object({
   comments: z.string().nullable().optional(),
   initial_payment_generated: z.boolean().optional(),
   initial_payment_removable: z.boolean().optional(),
-  // Element-driven training progress (see m-crit-api
-  // docs/features/training-tracking.md).
+  // Element-driven training progress.
   tracked_training_elements_count: z.number().optional(),
   progress_source: z.enum(["training_elements", "milestones"]).optional(),
   metrics: courseEnrollmentMetricsSchema.optional(),
@@ -1151,7 +1153,7 @@ export const landingSchema = z.object({
   airport: airportSchema.optional(),
   landing_fee_id: z.number().nullable().optional(),
   landing_time: z.string(),
-  price: zPhpMoneyObject.nullable().optional(),
+  price: zMoneyObject.nullable().optional(),
   created_at: z.string(),
   updated_at: z.string(),
 });
@@ -1209,12 +1211,24 @@ export const settingSchema = z.object({
   updated_at: z.string(),
 });
 
+/**
+ * The model a post is *about* (its optional subject). Scope is always the
+ * company; the subject only adds a second listing place (the model's own
+ * page). `label` is display-ready (registration / course name).
+ */
+export const postSubjectSchema = z.object({
+  type: z.enum(["airplane", "course"]),
+  id: z.number(),
+  label: z.string(),
+});
+
 export const postSchema = z.object({
   type: z.literal("post"),
   id: z.number(),
   company_id: z.number(),
   postable_type: z.string().nullable().optional(),
   postable_id: z.number().nullable().optional(),
+  postable: postSubjectSchema.nullable().optional(),
   author_id: z.number(),
   author: userSchema.optional(),
   title: z.string().nullable().optional(),
@@ -1222,6 +1236,8 @@ export const postSchema = z.object({
   sticky: z.boolean().default(false),
   public: z.boolean().default(false),
   comments_disabled: z.boolean().default(false),
+  /** Present when the endpoint counts comments (listings + show). */
+  comments_count: z.number().nullable().optional(),
   tags: z.array(tagSchema).optional(),
   media: mediaCollection.optional(),
   created_at: z.string(),
@@ -1229,6 +1245,8 @@ export const postSchema = z.object({
   can: z
     .object({
       view: zNullableBool,
+      viewComments: zNullableBool,
+      createComments: zNullableBool,
       update: zNullableBool,
       delete: zNullableBool,
       setFlags: zNullableBool,
@@ -1323,8 +1341,8 @@ export const prePaidPackageSchema = z.object({
   company: companySchema.optional(),
   name: z.string(),
   description: z.string().nullable().optional(),
-  balance: zPhpMoneyObject,
-  initial_amount: zPhpMoneyObject,
+  balance: zMoneyObject,
+  initial_amount: zMoneyObject,
   discount_percentage: z.number().nullable().optional(),
   valid_until: z.string().nullable().optional(),
   created_at: z.string(),
@@ -1341,7 +1359,7 @@ export const prePaidPackageSchema = z.object({
 // A billing line-item (flight charge, landing fee, membership fee, refund,
 // …) attached to a flight log / booking / membership via the polymorphic
 // (model_type, model_id) pair, and to an invoice once released. NOT a
-// catalog entry — rebuilt field-by-field against ExpenseItemResource.php;
+// catalog entry — rebuilt field-by-field against ExpenseItemResource;
 // the previous shape (name/category/active) modeled a company catalog row,
 // which ExpenseItem has never had.
 export const prePaidPackageAssignmentSchema = z.object({
@@ -1349,7 +1367,7 @@ export const prePaidPackageAssignmentSchema = z.object({
   flight_log_id: z.number().nullable().optional(),
   expense_item_id: z.number().nullable().optional(),
   pre_paid_package_id: z.number().nullable().optional(),
-  gross_total: zPhpMoneyObject.nullable().optional(),
+  gross_total: zMoneyObject.nullable().optional(),
   created_at: z.string().nullable().optional(),
   updated_at: z.string().nullable().optional(),
 });
@@ -1384,10 +1402,10 @@ export const expenseItemSchema = z.object({
   membership_id: z.number(),
   billing_profile_id: z.number().nullable(),
 
-  gross_total_before_vouchers: zPhpMoneyObject,
-  gross_total: zPhpMoneyObject,
-  net_total: zPhpMoneyObject,
-  tax_total: zPhpMoneyObject,
+  gross_total_before_vouchers: zMoneyObject,
+  gross_total: zMoneyObject,
+  net_total: zMoneyObject,
+  tax_total: zMoneyObject,
   // number_format(…, 2) string, not a number.
   tax_percentage: z.string(),
   billable: z.boolean(),

package/src/schemas/training.ts

@@ -359,7 +359,7 @@ export type TrainingRecordEntryInput = z.infer<
   typeof trainingRecordEntryInputSchema
 >;
 
-// Mirrors the generic `SignatureResource` (App\Http\Resources\Form) — the
+// Mirrors the generic `SignatureResource` — the
 // same polymorphic `Signature` model backs both form submissions and
 // training records. Kept self-contained here (not imported from
 // @schemas/FormTemplateSchema) to match this file's own alias root and the
@@ -504,7 +504,7 @@ export type CreateSyllabusFromTemplateForm = z.infer<
   typeof CreateSyllabusFromTemplateFormSchema
 >;
 
-// Mirrors `CreateSyllabusFromTemplate::run()`'s return shape (m-crit-api),
+// Mirrors `CreateSyllabusFromTemplate::run()`'s return shape,
 // as wrapped by `SyllabusController::fromTemplate`.
 export const createSyllabusFromTemplateResultSchema = z.object({
   catalog: z.object({

package/src/types/compliance.ts

@@ -7,7 +7,7 @@ export interface ComplianceRequirement {
   logical_group: string;
   is_satisfied: boolean;
   // True when the member has already signed the satisfying submission and
-  // only the company's counter-signature is outstanding (e.g. the INflight
+  // only the company's counter-signature is outstanding (e.g. the
   // Chartervertrag). The requirement is still unsatisfied, but the member
   // isn't the blocker — consumers refine this into an `awaiting_countersign`
   // display state.

package/src/types/index.ts

@@ -6,3 +6,4 @@ export * from "./background-task";
 export * from "./ai";
 export * from "./roles";
 export * from "./landing-fee";
+export * from "./operating-hours";

package/src/types/models.ts

@@ -128,6 +128,7 @@ export type AirplaneIssueStatus = z.infer<
 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 PostSubject = z.infer<typeof ModelSchemas.postSubjectSchema>;
 
 /**
  * Full-replacement tag sync entry — `id` marks an existing tag (wins over

package/src/types/operating-hours.ts

@@ -0,0 +1,163 @@
+/**
+ * Operating hours — an organization defines several independent groups (its
+ * own office hours, a military field it flies from, the tower, an FBO). Each
+ * group is self-contained (own IANA timezone + optional airport) and is
+ * materialised server-side into merged, half-open UTC windows; status is
+ * answered per group as open / partial / closed / unknown.
+ */
+
+export type OperatingHourKind =
+  | "company" | "airport" | "atc" | "fbo" | "military"
+  | "fuel" | "customs" | "handling" | "maintenance" | "other";
+
+export type TimeAnchor = "fixed" | "sunrise" | "sunset";
+
+export type OperatingStatusValue = "open" | "partial" | "closed" | "unknown";
+
+/**
+ * One open block. Each bound is a fixed local time, or sunrise/sunset with a
+ * signed offset and an optional cap ("SR-30 aber nicht vor 07:00"). An end at
+ * or before its start crosses midnight.
+ */
+export type OperatingHourInterval = {
+  id?: number;
+  sort: number;
+  start_kind: TimeAnchor;
+  start_time: string | null;
+  start_offset_minutes: number | null;
+  start_not_before: string | null;
+  end_kind: TimeAnchor;
+  end_time: string | null;
+  end_offset_minutes: number | null;
+  end_not_after: string | null;
+};
+
+/** One weekday. ISO: 1 = Monday .. 7 = Sunday. */
+export type OperatingHourDay = {
+  id?: number;
+  schedule_id?: number;
+  day_of_week: number;
+  is_closed: boolean;
+  is_24_hours: boolean;
+  notes: string | null;
+  intervals: OperatingHourInterval[];
+};
+
+/** A hand-entered override for a date range. No recurrence, by design. */
+export type OperatingHourException = {
+  id: number;
+  schedule_id: number;
+  starts_on: string;
+  ends_on: string;
+  is_closed: boolean;
+  is_24_hours: boolean;
+  reason: string;
+  intervals: OperatingHourInterval[];
+};
+
+/**
+ * What the client composes before an exception exists — no id, no owner yet.
+ * The read type above is what comes back; keeping the two apart lets the
+ * dialog's `createItem` seed a blank without lying about an id.
+ */
+export type OperatingHourExceptionInput = Omit<
+  OperatingHourException,
+  "id" | "schedule_id"
+>;
+
+/** A concrete, merged, half-open UTC window. Derived — read-only. */
+export type OperatingHourWindow = {
+  starts_at: string;
+  ends_at: string;
+};
+
+/**
+ * A group. Self-contained: carries its own timezone and airport, resolved
+ * from nowhere else. `materialized_from`/`materialized_through` bound the
+ * range in which "no window" genuinely means closed rather than unknown.
+ */
+export type OperatingHourSchedule = {
+  id: number;
+  company_id: number;
+  airport_id: number | null;
+  airport?: { id: number; ident: string; name: string } | null;
+  kind: OperatingHourKind;
+  name: string;
+  description: string | null;
+  timezone: string;
+  valid_from: string;
+  valid_until: string | null;
+  is_active: boolean;
+  sort_order: number;
+  source: string | null;
+  verified_at: string | null;
+  materialized_from: string | null;
+  materialized_through: string | null;
+  days: OperatingHourDay[];
+  exceptions: OperatingHourException[];
+  created_at?: string;
+  updated_at?: string;
+};
+
+/** The fields a client may send when creating a group. */
+export type OperatingHourScheduleInput = Partial<
+  Omit<
+    OperatingHourSchedule,
+    | "id"
+    | "company_id"
+    | "airport"
+    | "materialized_from"
+    | "materialized_through"
+    | "days"
+    | "exceptions"
+    | "created_at"
+    | "updated_at"
+  >
+>;
+
+/**
+ * What the saved rules resolve to on ONE named calendar date — used for the
+ * solstice hints. Carries its own date and status precisely so the extremes
+ * can never be merged into a weekday bucket alongside the current week, and
+ * so an `unknown` date is reported as unknown rather than as closed.
+ */
+export type OperatingHourResolvedDate = {
+  /** `Y-m-d` in the group's timezone. */
+  date: string;
+  status: OperatingStatusValue;
+  windows: OperatingHourWindow[];
+};
+
+export type OperatingHourStatusEntry = {
+  schedule_id: number;
+  kind: OperatingHourKind;
+  name: string;
+  timezone: string;
+  status: OperatingStatusValue;
+  windows: OperatingHourWindow[];
+};
+
+export type OperatingHoursStatusResponse = {
+  from: string;
+  to: string;
+  data: OperatingHourStatusEntry[];
+};
+
+export type OperatingHoursNextOpenEntry = {
+  schedule_id: number;
+  kind: OperatingHourKind;
+  name: string;
+  next_opening: string | null;
+};
+
+export type OperatingHoursNextOpenResponse = {
+  after: string;
+  data: OperatingHoursNextOpenEntry[];
+};
+
+export type OperatingHoursMeta = {
+  kinds: OperatingHourKind[];
+  anchors: TimeAnchor[];
+  statuses: OperatingStatusValue[];
+  max_status_range_days: number;
+};