@stimulus-plumbers/controllers 0.2.7 → 0.2.9

package/src/plumbers/formatters/phone.js

@@ -0,0 +1,73 @@
+/**
+ * Map of E.164 country calling code → expected local digit count.
+ * Key: calling code string (without '+').
+ * Value: local number digit count (excluding the country code).
+ *
+ * Example: '1' → 10 means USA/Canada use a 10-digit local number
+ * (3-digit area code + 7-digit subscriber number).
+ *
+ * Extend this object to add formatting support for additional countries.
+ */
+const DIALING_CODE_LOCAL_DIGITS = {
+  1: 10, // USA, Canada, and NANP countries
+};
+
+/** Strips all non-digit characters */
+const STRIP_NON_DIGITS = /\D/g;
+
+/** Matches an E.164 international phone number: + followed by 7–15 digits */
+const E164_PATTERN = /^\+\d{7,15}$/;
+
+export const PhoneFormatter = {
+  /**
+   * Converts raw input to canonical form.
+   * If input starts with '+', produces E.164 (+digits); otherwise strips to digits only.
+   * e.g. '(555) 123-4567' → '5551234567', '+1 555 123 4567' → '+15551234567'
+   * @param {string} raw - Raw input (may contain spaces, dashes, parentheses, etc.)
+   * @returns {string} Canonical string, or '' for non-string input
+   */
+  normalize(raw) {
+    if (typeof raw !== 'string') return '';
+    const hasPlus = raw.trimStart().startsWith('+');
+    const digits = raw.replace(STRIP_NON_DIGITS, '');
+    return hasPlus ? `+${digits}` : digits;
+  },
+
+  /**
+   * Validates the canonical phone number.
+   * Accepts E.164 format or a local number whose digit count appears in DIALING_CODE_LOCAL_DIGITS.
+   * @param {string} value - Canonical value from normalize()
+   * @returns {boolean}
+   */
+  validate(value) {
+    if (typeof value !== 'string') return false;
+    if (E164_PATTERN.test(value)) return true;
+    const digits = value.replace(STRIP_NON_DIGITS, '');
+    return Object.values(DIALING_CODE_LOCAL_DIGITS).includes(digits.length);
+  },
+
+  /**
+   * Formats a canonical phone number for display.
+   * Recognises numbers matching entries in DIALING_CODE_LOCAL_DIGITS.
+   * e.g. '5551234567' → '(555) 123-4567', '+15551234567' → '+1 (555) 123-4567'
+   * Returns value unchanged for unrecognised international numbers.
+   * @param {string} value - Canonical value from normalize()
+   * @returns {string} Formatted display string, or '' for non-string input
+   */
+  format(value) {
+    if (typeof value !== 'string') return '';
+    const digits = value.replace(STRIP_NON_DIGITS, '');
+    for (const [code, localDigits] of Object.entries(DIALING_CODE_LOCAL_DIGITS)) {
+      if (digits.length === localDigits) {
+        // Local number without country code prefix
+        return `(${digits.slice(0, 3)}) ${digits.slice(3, 6)}-${digits.slice(6)}`;
+      }
+      const totalWithCode = localDigits + code.length;
+      if (digits.length === totalWithCode && digits.startsWith(code)) {
+        const local = digits.slice(code.length);
+        return `+${code} (${local.slice(0, 3)}) ${local.slice(3, 6)}-${local.slice(6)}`;
+      }
+    }
+    return value;
+  },
+};

package/src/plumbers/formatters/plain.js

@@ -0,0 +1,10 @@
+export const PlainFormatter = {
+  normalize(raw) {
+    if (typeof raw !== 'string') return '';
+    return raw;
+  },
+
+  validate() {
+    return true;
+  },
+};

package/src/plumbers/formatters/time.js

@@ -0,0 +1,62 @@
+/** Matches a 24-hour time: HH:MM */
+const H24_PATTERN = /^([01]?\d|2[0-3]):([0-5]\d)$/;
+
+export const TimeFormatter = {
+  /**
+   * Converts raw input to canonical 24-hour form: HH:MM.
+   * Accepts HH:MM (24h) and h:mm AM/PM (12h).
+   * @param {string} raw
+   * @returns {string} "HH:MM" or "" for invalid input
+   */
+  normalize(raw) {
+    if (typeof raw !== 'string') return '';
+    const trimmed = raw.trim();
+
+    if (H24_PATTERN.test(trimmed)) {
+      const [h, m] = trimmed.split(':');
+      return `${String(parseInt(h, 10)).padStart(2, '0')}:${m}`;
+    }
+
+    // h:mm AM/PM
+    const ampm = trimmed.match(/^(\d{1,2}):(\d{2})\s*(AM|PM)$/i);
+    if (ampm) {
+      let h = parseInt(ampm[1], 10);
+      const m = ampm[2];
+      const period = ampm[3].toUpperCase();
+      if (period === 'AM') h = h === 12 ? 0 : h;
+      else h = h === 12 ? 12 : h + 12;
+      if (h > 23 || parseInt(m, 10) > 59) return '';
+      return `${String(h).padStart(2, '0')}:${m}`;
+    }
+
+    return '';
+  },
+
+  /**
+   * Validates that the value is a parseable time.
+   * @param {string} value
+   * @returns {boolean}
+   */
+  validate(value) {
+    return TimeFormatter.normalize(value) !== '';
+  },
+
+  /**
+   * Formats a canonical HH:MM value for display.
+   * @param {string} value - Canonical "HH:MM" from normalize()
+   * @param {Object} [opts={}]
+   * @param {string} [opts.format='h12'] - 'h12' or 'h24'
+   * @returns {string}
+   */
+  format(value, opts = {}) {
+    if (typeof value !== 'string') return '';
+    const match = value.match(/^(\d{2}):(\d{2})$/);
+    if (!match) return value;
+    const h = parseInt(match[1], 10);
+    const m = match[2];
+    if (opts.format === 'h24') return `${String(h).padStart(2, '0')}:${m}`;
+    const period = h < 12 ? 'AM' : 'PM';
+    const displayH = h % 12 || 12;
+    return `${displayH}:${m} ${period}`;
+  },
+};

package/src/plumbers/index.js

@@ -3,8 +3,10 @@
  */
 
 export { initCalendar } from './calendar';
+export { initComboboxDropdown } from './combobox_dropdown';
 export { attachContentLoader } from './content_loader';
 export { attachDismisser } from './dismisser';
 export { attachFlipper } from './flipper';
+export { attachFormatter } from './formatter';
 export { attachShifter } from './shifter';
 export { attachVisibility } from './visibility';