@burdenoff/microfe-movethewheels 2026.1031.2 → 2026.1031.4

package/src/movethewheels/utils/moduleSettings.ts

@@ -0,0 +1,224 @@
+/**
+ * Module settings — client side of wspace-movethewheels-svc's workspace
+ * operational defaults (BOFF-10488).
+ *
+ * The service owns validation and storage; this module holds the GraphQL
+ * documents, the platform defaults (used until the settings load), the
+ * picker options and the mapping between the service's order priorities and
+ * the order form's. Kept free of React so the contract can be unit-tested.
+ */
+import type { FormatPreferences } from './formatters';
+
+export type MtwDistanceUnit = 'KM' | 'MI';
+export type MtwWeightUnit = 'KG' | 'LB';
+export type MtwOrderPriority = 'LOW' | 'MEDIUM' | 'HIGH' | 'URGENT' | 'CRITICAL';
+
+export interface MtwModuleSettings {
+  workspaceId: string;
+  defaultCurrency: string;
+  distanceUnit: MtwDistanceUnit;
+  weightUnit: MtwWeightUnit;
+  /** IANA zone; null shows each viewer their own local time. */
+  timezone: string | null;
+  defaultOrderPriority: MtwOrderPriority;
+  defaultDeliveryWindowHours: number;
+  isCustomized: boolean;
+  updatedAt: string | null;
+  updatedBy: string | null;
+}
+
+export type MtwModuleSettingsInput = Partial<
+  Pick<
+    MtwModuleSettings,
+    | 'defaultCurrency'
+    | 'distanceUnit'
+    | 'weightUnit'
+    | 'timezone'
+    | 'defaultOrderPriority'
+    | 'defaultDeliveryWindowHours'
+  >
+>;
+
+/** Mirrors the service range for the default delivery window. */
+export const DELIVERY_WINDOW_MIN_HOURS = 1;
+export const DELIVERY_WINDOW_MAX_HOURS = 720;
+
+/** The service's platform defaults, shown until the workspace's settings load. */
+export function platformDefaults(workspaceId = ''): MtwModuleSettings {
+  return {
+    workspaceId,
+    defaultCurrency: 'USD',
+    distanceUnit: 'KM',
+    weightUnit: 'KG',
+    timezone: null,
+    defaultOrderPriority: 'MEDIUM',
+    defaultDeliveryWindowHours: 24,
+    isCustomized: false,
+    updatedAt: null,
+    updatedBy: null,
+  };
+}
+
+const SETTINGS_FIELDS = `
+  workspaceId
+  defaultCurrency
+  distanceUnit
+  weightUnit
+  timezone
+  defaultOrderPriority
+  defaultDeliveryWindowHours
+  isCustomized
+  updatedAt
+  updatedBy
+`;
+
+export const MTW_MODULE_SETTINGS_QUERY = `
+  query MtwModuleSettings {
+    mtwModuleSettings {
+      ${SETTINGS_FIELDS}
+    }
+  }
+`;
+
+export const UPDATE_MTW_MODULE_SETTINGS_MUTATION = `
+  mutation UpdateMtwModuleSettings($input: UpdateMtwModuleSettingsInput!) {
+    updateMtwModuleSettings(input: $input) {
+      ${SETTINGS_FIELDS}
+    }
+  }
+`;
+
+/** What the formatters need from the settings. */
+export function toFormatPreferences(settings: MtwModuleSettings): FormatPreferences {
+  return {
+    currency: settings.defaultCurrency,
+    distanceUnit: settings.distanceUnit,
+    weightUnit: settings.weightUnit,
+    timeZone: settings.timezone,
+  };
+}
+
+export const DISTANCE_UNIT_OPTIONS: ReadonlyArray<{ value: MtwDistanceUnit; label: string }> = [
+  { value: 'KM', label: 'Kilometres (km)' },
+  { value: 'MI', label: 'Miles (mi)' },
+];
+
+export const WEIGHT_UNIT_OPTIONS: ReadonlyArray<{ value: MtwWeightUnit; label: string }> = [
+  { value: 'KG', label: 'Kilograms (kg)' },
+  { value: 'LB', label: 'Pounds (lb)' },
+];
+
+export const ORDER_PRIORITY_OPTIONS: ReadonlyArray<{ value: MtwOrderPriority; label: string }> = [
+  { value: 'LOW', label: 'Low' },
+  { value: 'MEDIUM', label: 'Normal' },
+  { value: 'HIGH', label: 'High' },
+  { value: 'URGENT', label: 'Urgent' },
+  { value: 'CRITICAL', label: 'Critical' },
+];
+
+/** The order form's four priorities for a service priority (CRITICAL shows as urgent). */
+export function orderFormPriority(
+  priority: MtwOrderPriority
+): 'low' | 'normal' | 'high' | 'urgent' {
+  switch (priority) {
+    case 'LOW':
+      return 'low';
+    case 'HIGH':
+      return 'high';
+    case 'URGENT':
+    case 'CRITICAL':
+      return 'urgent';
+    default:
+      return 'normal';
+  }
+}
+
+/** Commonly used currencies first, then every other code the browser knows. */
+const PREFERRED_CURRENCIES = ['USD', 'EUR', 'GBP', 'INR', 'AED', 'SGD', 'AUD', 'CAD', 'JPY', 'CNY'];
+
+function supportedValues(key: 'currency' | 'timeZone'): string[] {
+  // Older browsers lack Intl.supportedValuesOf; the pickers then offer the
+  // preferred list plus the saved value.
+  return typeof Intl.supportedValuesOf === 'function' ? Intl.supportedValuesOf(key) : [];
+}
+
+export function currencyOptions(current?: string): string[] {
+  const all = new Set([...PREFERRED_CURRENCIES, ...supportedValues('currency')]);
+  if (current) all.add(current);
+  const rest = [...all].filter((code) => !PREFERRED_CURRENCIES.includes(code)).sort();
+  return [...PREFERRED_CURRENCIES, ...rest];
+}
+
+export function currencyLabel(code: string): string {
+  try {
+    const name = new Intl.DisplayNames(['en'], { type: 'currency' }).of(code);
+    return name && name !== code ? `${code} — ${name}` : code;
+  } catch {
+    return code;
+  }
+}
+
+export function timeZoneOptions(current?: string | null): string[] {
+  const zones = new Set(['UTC', ...supportedValues('timeZone')]);
+  if (current) zones.add(current);
+  return [...zones].sort((a, b) => (a === 'UTC' ? -1 : b === 'UTC' ? 1 : a.localeCompare(b)));
+}
+
+/** The browser's own zone, for the "viewer's local time" option label. */
+export function browserTimeZone(): string {
+  try {
+    return Intl.DateTimeFormat().resolvedOptions().timeZone || 'UTC';
+  } catch {
+    return 'UTC';
+  }
+}
+
+/** Client-side check of the delivery window before it is sent. */
+export function deliveryWindowError(value: string): string | null {
+  const hours = Number(value);
+  if (
+    !value.trim() ||
+    !Number.isInteger(hours) ||
+    hours < DELIVERY_WINDOW_MIN_HOURS ||
+    hours > DELIVERY_WINDOW_MAX_HOURS
+  ) {
+    return `Enter a whole number of hours between ${DELIVERY_WINDOW_MIN_HOURS} and ${DELIVERY_WINDOW_MAX_HOURS}.`;
+  }
+  return null;
+}
+
+/** Only the fields that differ from the saved settings. */
+export function changedSettings(
+  saved: MtwModuleSettings,
+  draft: MtwModuleSettingsInput
+): MtwModuleSettingsInput {
+  const changes: MtwModuleSettingsInput = {};
+  if (draft.defaultCurrency !== undefined && draft.defaultCurrency !== saved.defaultCurrency)
+    changes.defaultCurrency = draft.defaultCurrency;
+  if (draft.distanceUnit !== undefined && draft.distanceUnit !== saved.distanceUnit)
+    changes.distanceUnit = draft.distanceUnit;
+  if (draft.weightUnit !== undefined && draft.weightUnit !== saved.weightUnit)
+    changes.weightUnit = draft.weightUnit;
+  if (draft.timezone !== undefined && draft.timezone !== saved.timezone)
+    changes.timezone = draft.timezone;
+  if (
+    draft.defaultOrderPriority !== undefined &&
+    draft.defaultOrderPriority !== saved.defaultOrderPriority
+  )
+    changes.defaultOrderPriority = draft.defaultOrderPriority;
+  if (
+    draft.defaultDeliveryWindowHours !== undefined &&
+    draft.defaultDeliveryWindowHours !== saved.defaultDeliveryWindowHours
+  )
+    changes.defaultDeliveryWindowHours = draft.defaultDeliveryWindowHours;
+  return changes;
+}
+
+/** A `datetime-local` value `hours` from `from`, in the viewer's clock. */
+export function deliveryWindowValue(hours: number, from: Date = new Date()): string {
+  const target = new Date(from.getTime() + hours * 3600 * 1000);
+  const pad = (value: number) => String(value).padStart(2, '0');
+  return `${target.getFullYear()}-${pad(target.getMonth() + 1)}-${pad(target.getDate())}T${pad(
+    target.getHours()
+  )}:${pad(target.getMinutes())}`;
+}