@updraft-solutions/mcrit-sdk 0.3.1 → 0.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@updraft-solutions/mcrit-sdk",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "Shared TypeScript types, Zod schemas, and pure helpers for the MCRIT aviation fleet management platform",
   "homepage": "https://github.com/updraft-solutions/mcrit-sdk#readme",
   "bugs": {

package/src/format/index.ts

@@ -3,10 +3,11 @@ import moment from "moment-timezone";
 const DEFAULT_TZ = "UTC";
 
 /**
- * Note on German locale: the SDK does not eagerly load `moment/locale/de`.
- * Consumers that want German formatting should import it once at their
- * app entry: `import "moment/locale/de"`. Otherwise `timeUntil` and other
- * locale-dependent functions will fall back to English.
+ * Locale note: `timeUntil` uses `Intl.RelativeTimeFormat` — natively
+ * localized, no moment locale files required. The moment-based formatters
+ * below are locale-INdependent except for the `MMM` token
+ * (`DATE_FORMATS.MONTH_SHORT`), which renders English month abbreviations
+ * unless a consumer registers moment locale data itself.
  */
 
 /** Predefined moment format strings, frozen so callers can reference them safely. */
@@ -195,6 +196,25 @@ export function timeString(
   return formatted;
 }
 
+const RELATIVE_TIME_UNITS: Array<{
+  unit: Intl.RelativeTimeFormatUnit;
+  ms: number;
+}> = [
+  { unit: "year", ms: 365 * 24 * 60 * 60 * 1000 },
+  { unit: "month", ms: 30 * 24 * 60 * 60 * 1000 },
+  { unit: "day", ms: 24 * 60 * 60 * 1000 },
+  { unit: "hour", ms: 60 * 60 * 1000 },
+  { unit: "minute", ms: 60 * 1000 },
+];
+
+/**
+ * Relative time ("vor 3 Tagen" / "in 2 Stunden") via the browser-native
+ * `Intl.RelativeTimeFormat` — fully localized for any BCP 47 locale with
+ * zero locale files, and immune to the moment CJS/ESM dual-instance
+ * locale-registry pitfall that used to silently produce English output.
+ * `numeric: "auto"` yields natural wording for adjacent days
+ * ("gestern" / "morgen").
+ */
 export function timeUntil(
   dateTime: string | Date | null | undefined,
   locale: string = "de",
@@ -202,7 +222,33 @@ export function timeUntil(
   if (!dateTime) {
     return "";
   }
-  return moment(dateTime).locale(locale).fromNow();
+  const target =
+    dateTime instanceof Date ? dateTime.getTime() : Date.parse(dateTime);
+  if (Number.isNaN(target)) {
+    return "";
+  }
+  const diff = target - Date.now();
+
+  // A structurally valid but unsupported tag doesn't throw — it silently
+  // uses the system default. Check actual support so unknown locales land
+  // on the SDK default (de) deterministically; malformed tags throw and
+  // take the same path.
+  let resolved = "de";
+  try {
+    if (Intl.RelativeTimeFormat.supportedLocalesOf(locale).length > 0) {
+      resolved = locale;
+    }
+  } catch {
+    // malformed tag — keep the default
+  }
+  const formatter = new Intl.RelativeTimeFormat(resolved, { numeric: "auto" });
+
+  for (const { unit, ms } of RELATIVE_TIME_UNITS) {
+    if (Math.abs(diff) >= ms) {
+      return formatter.format(Math.round(diff / ms), unit);
+    }
+  }
+  return formatter.format(Math.round(diff / 1000), "second");
 }
 
 export function minutesFormatted(minutes: number | null | undefined): string {

package/src/index.ts

@@ -11,6 +11,9 @@ export {
   type AirplanePermission,
   type AirplaneShareInvite,
   type LandingFee,
+  type Fee,
+  type FeeCategoryOptions,
+  type Tag,
   type AircraftRating,
   type UserAircraftRating,
   type UserQualification,
@@ -48,6 +51,12 @@ export {
   type Event,
   type Ticket,
   type Post,
+  type CreatePostInput,
+  type UpdatePostInput,
+  type CreateAirplaneIssueInput,
+  type UpdateAirplaneIssueInput,
+  type ResolveAirplaneIssueInput,
+  type DeferAirplaneIssueInput,
   type Comment,
   type CreateCommentInput,
   type UpdateCommentInput,
@@ -57,6 +66,7 @@ export {
   type Setting,
   // types/api.ts
   type DataWrappedResponse,
+  type ApiResponse,
   type PaginatedResponse,
   type Resource,
   type ToggleFavoriteResponse,
@@ -64,9 +74,38 @@ export {
   type ComplianceRequirement,
   type ComplianceRequirementGroup,
   type ComplianceGroup,
+  type ComplianceGroupSource,
   type ComplianceSummary,
   type ComplianceData,
   type ComplianceResponse,
+  // types/aircraft-block.ts
+  type AircraftBlock,
+  type AircraftBlockReason,
+  // types/background-task.ts
+  type BackgroundTask,
+  type BackgroundTaskStatus,
+  // types/ai.ts
+  type AiSuggestion,
+  type AiSuggestionStatus,
+  type AiSuggestedMilestone,
+  type CourseDescriptionSuggestionPayload,
+  type LogbookFlightLogPayload,
+  type LogbookSuggestionMeta,
+  type LogbookSuggestion,
+  type DiscardedRow,
+  type LogbookStageResult,
+  // types/roles.ts
+  type RoleListItem,
+  type PermissionItem,
+  type RoleDetail,
+  type GroupedPermissions,
+  // types/landing-fee.ts
+  type LandingFeeTemplateParams,
+  type LandingFeeImportResult,
+  type LandingFeeInvoicePreviewRow,
+  type LandingFeeInvoicePreview,
+  type LandingFeeInvoiceApplyPayload,
+  type LandingFeeInvoiceApplyResult,
 } from "./types/index.js";
 
 export * from "./money/index.js";

package/src/schemas/common.ts

@@ -57,12 +57,41 @@ export const mediaCollection = z
   .optional();
 
 // User & Company
+/** Minimal participant shape used in the impersonation payload. */
+export const impersonationParticipantSchema = z.object({
+  id: z.number(),
+  name: z.string(),
+  email: z.string(),
+});
+export type ImpersonationParticipant = z.infer<
+  typeof impersonationParticipantSchema
+>;
+
+/**
+ * Impersonation state. Rides along on the authenticated user payload
+ * (`/auth/user` → `user.impersonation`), so it is the single source of
+ * truth — no polling required. The backend's `HandleImpersonation`
+ * middleware also stamps an `X-Impersonating` header on every non-admin
+ * response, which clients use to detect a session that ended server-side.
+ */
+export const impersonationStateSchema = z.object({
+  is_impersonating: z.boolean(),
+  impersonator: impersonationParticipantSchema.optional(),
+  impersonated: impersonationParticipantSchema.optional(),
+  started_at: z.string().optional(),
+  expires_at: z.string().optional(),
+});
+export type ImpersonationState = z.infer<typeof impersonationStateSchema>;
+
 export const userSchema = z.object({
   type: z.literal("user"),
   id: z.number(),
   name: z.string(),
   email: z.string().optional(),
   mobile: z.string().optional(),
+  // Present only on the authenticated-user payload while an admin
+  // impersonation session is active.
+  impersonation: impersonationStateSchema.optional(),
 });
 
 export const companySchema = z.object({
@@ -72,5 +101,13 @@ export const companySchema = z.object({
   media: mediaCollection,
   can: z.record(z.string(), z.boolean().nullable()).optional(),
   permissions: z.array(z.string()).optional(),
+  // Company display timezone (companies.timezone, default Europe/Berlin
+  // server-side); booking/event surfaces render in this zone. Optional:
+  // slim company payloads may omit it.
+  timezone: z.string().optional(),
   ai_landing_fee_invoices_enabled: z.boolean().optional(),
+  // Active AI-feature entitlement keys (per-company subscription gating,
+  // e.g. "ai.logbook_import"). Serialized by CompanyResource alongside
+  // `permissions[]`; slim payloads may omit it.
+  entitlements: z.array(z.string()).optional(),
 });

package/src/schemas/course-milestone.ts

@@ -0,0 +1,78 @@
+import { z } from "zod";
+
+export const CourseMilestoneKindEnum = z.enum([
+  "progress",
+  "solo",
+  "cross_country",
+  "theory",
+  "practical",
+  "prerequisite",
+  "custom",
+]);
+export type CourseMilestoneKind = z.infer<typeof CourseMilestoneKindEnum>;
+
+export const courseMilestoneSchema = z.object({
+  type: z.literal("courseMilestone").optional(),
+  id: z.number(),
+  course_id: z.number(),
+  name: z.string(),
+  description: z.string().nullable().optional(),
+  kind: z.string(),
+  is_prerequisite: z.boolean(),
+  requires_form_template_id: z.number().nullable().optional(),
+  required_form_template: z
+    .object({ id: z.number(), name: z.string().optional() })
+    .nullable()
+    .optional(),
+  completion_rule: z.record(z.string(), z.unknown()).nullable().optional(),
+  sort_order: z.number(),
+  created_at: z.string().optional(),
+  updated_at: z.string().optional(),
+  can: z
+    .object({
+      update: z.boolean().nullable().optional(),
+      delete: z.boolean().nullable().optional(),
+    })
+    .optional(),
+});
+export type CourseMilestone = z.infer<typeof courseMilestoneSchema>;
+
+export const CourseMilestoneFormSchema = z.object({
+  name: z.string().min(2).max(191),
+  description: z.string().nullable().optional(),
+  kind: z.string().max(64).default("progress"),
+  is_prerequisite: z.boolean().default(false),
+  requires_form_template_id: z.number().nullable().optional(),
+  completion_rule: z.record(z.string(), z.unknown()).nullable().optional(),
+  sort_order: z.number().int().min(0).optional(),
+});
+export type CourseMilestoneForm = z.infer<typeof CourseMilestoneFormSchema>;
+
+export const courseEnrollmentMilestoneSchema = z.object({
+  type: z.literal("courseEnrollmentMilestone").optional(),
+  id: z.number(),
+  course_enrollment_id: z.number(),
+  course_milestone_id: z.number(),
+  milestone: courseMilestoneSchema.optional(),
+  achieved_at: z.string().nullable().optional(),
+  achieved_by_membership_id: z.number().nullable().optional(),
+  achieved_by: z
+    .object({
+      id: z.number(),
+      user: z.object({ name: z.string().optional() }).optional(),
+    })
+    .nullable()
+    .optional(),
+  notes: z.string().nullable().optional(),
+  is_achieved: z.boolean(),
+  can_be_achieved: z.boolean(),
+  can: z
+    .object({
+      achieve: z.boolean().nullable().optional(),
+      revoke: z.boolean().nullable().optional(),
+    })
+    .optional(),
+});
+export type CourseEnrollmentMilestone = z.infer<
+  typeof courseEnrollmentMilestoneSchema
+>;

package/src/schemas/equipment.ts

@@ -0,0 +1,27 @@
+import { z } from "zod";
+
+/**
+ * Company-scoped equipment catalog entry (m-crit-api
+ * docs/features/airplane-equipment.md). Assigned to airplanes via the
+ * airplane PATCH `equipment` array.
+ */
+export const equipmentSchema = z.object({
+  type: z.literal("equipment").optional(),
+  id: z.number(),
+  name: z.string(),
+  description: z.string().nullable().optional(),
+  manual_url: z.string().nullable().optional(),
+});
+export type Equipment = z.infer<typeof equipmentSchema>;
+
+/**
+ * Write shape for the airplane PATCH: existing entries carry their id
+ * (description/manual_url on an id entry UPDATE the catalog entry);
+ * id-less entries are created on the fly by name.
+ */
+export interface EquipmentEntry {
+  id?: number;
+  name: string;
+  description?: string | null;
+  manual_url?: string | null;
+}