novac 2.0.1 → 2.2.0

package/kits/kitmorse/kitdef.js

@@ -0,0 +1,229 @@
+// kitmorse — novac Morse code kit
+// Encode/decode text ↔ Morse, audio timing, visual representations,
+// multi-standard support (ITU, American, prosigns).
+
+'use strict';
+
+// ─── CODE TABLES ─────────────────────────────────────────────────────────────
+
+// ITU/International Morse Code
+const ITU = {
+  // Letters
+  'A': '.-',    'B': '-...', 'C': '-.-.',  'D': '-..',
+  'E': '.',     'F': '..-.',  'G': '--.',   'H': '....',
+  'I': '..',    'J': '.---',  'K': '-.-',   'L': '.-..',
+  'M': '--',    'N': '-.',    'O': '---',   'P': '.--.',
+  'Q': '--.-',  'R': '.-.',   'S': '...',   'T': '-',
+  'U': '..-',   'V': '...-',  'W': '.--',   'X': '-..-',
+  'Y': '-.--',  'Z': '--..',
+  // Digits
+  '0': '-----', '1': '.----', '2': '..---', '3': '...--',
+  '4': '....-', '5': '.....', '6': '-....', '7': '--...',
+  '8': '---..', '9': '----.',
+  // Punctuation
+  '.': '.-.-.-', ',': '--..--', '?': '..--..', "'": '.----.',
+  '!': '-.-.--', '/': '-..-.', '(': '-.--.',  ')': '-.--.-',
+  '&': '.-...',  ':': '---...', ';': '-.-.-.', '=': '-...-',
+  '+': '.-.-.',  '-': '-....-', '_': '..--.-', '"': '.-..-.',
+  '$': '...-..-','@': '.--.-.',
+};
+
+// American Morse Code (original Morse, used in North America historically)
+const AMERICAN = {
+  'A': '.-',    'B': '-...', 'C': '.. .', 'D': '-..',
+  'E': '.',     'F': '.-.',  'G': '--.',  'H': '....',
+  'I': '..',    'J': '-.-.',  'K': '-.-',  'L': '---',
+  'M': '--',    'N': '-.',   'O': '. .',  'P': '.....',
+  'Q': '..-.',  'R': '. ..',  'S': '...',  'T': '-',
+  'U': '..-',   'V': '...-',  'W': '.--',  'X': '.-..',
+  'Y': '.. ..',  'Z': '... .',
+  '0': '-----', '1': '.----', '2': '..---', '3': '...--',
+  '4': '....-', '5': '.....', '6': '-....', '7': '--...',
+  '8': '---..', '9': '----.',
+  '.': '.-.-.-', ',': '.-.-', '?': '-..-.',
+};
+
+// ITU Prosigns (procedural signals — sent as single characters)
+const PROSIGNS = {
+  '<AR>': '.-.-.',   // End of message
+  '<AS>': '.-...',   // Wait
+  '<BK>': '-...-.-', // Break
+  '<BT>': '-...-',   // New paragraph / separator
+  '<CL>': '-.-..-..',// Closing station
+  '<CT>': '-.-.-',   // Start copying
+  '<DO>': '-..---',  // Change to wabun code
+  '<HH>': '........',// Error
+  '<KN>': '-.--.',   // Go ahead specific station
+  '<NJ>': '--.---',  // Shift to wabun code
+  '<SK>': '...-.-',  // End of contact
+  '<SN>': '...-.',   // Understood
+  '<SOS>':'...---...', // Distress signal
+};
+
+// Reverse lookup tables
+const ITU_REV      = Object.fromEntries(Object.entries(ITU).map(([k,v]) => [v,k]));
+const AMERICAN_REV = Object.fromEntries(Object.entries(AMERICAN).map(([k,v]) => [v,k]));
+const PROSIGN_REV  = Object.fromEntries(Object.entries(PROSIGNS).map(([k,v]) => [v,k]));
+
+// Visual representations
+const VISUAL = {
+  dot:       '·',
+  dash:      '−',
+  letterSep: ' ',
+  wordSep:   '  /  ',
+};
+
+// ─── ENCODE ───────────────────────────────────────────────────────────────────
+
+function encode(text, opts = {}) {
+  const standard  = opts.standard ?? 'itu';   // 'itu' | 'american'
+  const wordSep   = opts.wordSep  ?? ' / ';
+  const letterSep = opts.letterSep ?? ' ';
+  const visual    = opts.visual   ?? false;   // use · and − instead of . and -
+  const table     = standard === 'american' ? AMERICAN : ITU;
+
+  const dot  = visual ? '·' : '.';
+  const dash = visual ? '−' : '-';
+
+  // Replace prosigns first
+  let input = text.toUpperCase();
+  const prosignMatches = [];
+  for (const ps of Object.keys(PROSIGNS)) {
+    const re = new RegExp(ps.replace(/[<>]/g,'\\$&'), 'g');
+    input = input.replace(re, (m) => { prosignMatches.push(m); return `\x00${prosignMatches.length - 1}\x00`; });
+  }
+
+  const words = input.split(' ');
+  const encodedWords = words.map(word => {
+    if (!word) return '';
+    const chars = [];
+    let i = 0;
+    while (i < word.length) {
+      // Check prosign placeholder
+      if (word[i] === '\x00') {
+        const end = word.indexOf('\x00', i + 1);
+        const idx = parseInt(word.slice(i + 1, end));
+        const ps  = prosignMatches[idx];
+        chars.push(PROSIGNS[ps].replace(/\./g, dot).replace(/-/g, dash));
+        i = end + 1;
+        continue;
+      }
+      const ch   = word[i];
+      const code = table[ch];
+      if (code) {
+        chars.push(code.replace(/\./g, dot).replace(/-/g, dash));
+      } else {
+        chars.push('?'); // unknown char
+      }
+      i++;
+    }
+    return chars.join(letterSep);
+  });
+
+  return encodedWords.filter(Boolean).join(wordSep);
+}
+
+// ─── DECODE ───────────────────────────────────────────────────────────────────
+
+function decode(morse, opts = {}) {
+  const standard  = opts.standard  ?? 'itu';
+  const wordSep   = opts.wordSep   ?? ' / ';
+  const letterSep = opts.letterSep ?? ' ';
+  const table     = standard === 'american' ? AMERICAN_REV : ITU_REV;
+
+  // Normalise visual chars
+  const normalised = morse
+    .replace(/·/g, '.')
+    .replace(/−/g, '-')
+    .replace(/\u2014/g, '-'); // em dash
+
+  const words = normalised.split(wordSep);
+  const decoded = words.map(word => {
+    const letters = word.trim().split(letterSep);
+    return letters.map(code => {
+      if (!code) return '';
+      // Check prosign
+      if (PROSIGN_REV[code]) return PROSIGN_REV[code];
+      return table[code] ?? `[${code}]`;
+    }).join('');
+  });
+
+  return decoded.join(' ');
+}
+
+// ─── TIMING ───────────────────────────────────────────────────────────────────
+
+// Returns an array of {type, duration} objects for audio/light generation
+// type: 'dot' | 'dash' | 'symbol-gap' | 'letter-gap' | 'word-gap' | 'silence'
+function timing(text, opts = {}) {
+  const wpm      = opts.wpm  ?? 20;    // words per minute (PARIS standard)
+  const standard = opts.standard ?? 'itu';
+
+  // PARIS standard: 1 dit = 1200 / wpm ms
+  const dit = 1200 / wpm;
+  const dah = dit * 3;
+  const symbolGap = dit;
+  const letterGap = dit * 3;
+  const wordGap   = dit * 7;
+
+  const morseStr = encode(text, { standard, letterSep: '|', wordSep: '||' });
+  const events   = [];
+
+  const words = morseStr.split('||');
+  for (let wi = 0; wi < words.length; wi++) {
+    const letters = words[wi].split('|');
+    for (let li = 0; li < letters.length; li++) {
+      const syms = letters[li];
+      for (let si = 0; si < syms.length; si++) {
+        const s = syms[si];
+        if (s === '.') events.push({ type: 'dot',  duration: dit, on: true });
+        else if (s === '-') events.push({ type: 'dash', duration: dah, on: true });
+        else continue;
+        if (si < syms.length - 1) events.push({ type: 'symbol-gap', duration: symbolGap, on: false });
+      }
+      if (li < letters.length - 1) events.push({ type: 'letter-gap', duration: letterGap, on: false });
+    }
+    if (wi < words.length - 1) events.push({ type: 'word-gap', duration: wordGap, on: false });
+  }
+
+  return events;
+}
+
+// ─── ANALYSIS ─────────────────────────────────────────────────────────────────
+
+function analyze(morse) {
+  const normalised = morse.replace(/·/g, '.').replace(/−/g, '-');
+  const dots  = (normalised.match(/\./g) || []).length;
+  const dashes = (normalised.match(/-/g) || []).length;
+  const chars = normalised.replace(/ \/ /g, ' ').split(' ').length;
+  const words = (normalised.match(/ \/ /g) || []).length + 1;
+  return { dots, dashes, chars, words, length: normalised.length };
+}
+
+// ─── ALPHABET ─────────────────────────────────────────────────────────────────
+
+function alphabet(opts = {}) {
+  const standard = opts.standard ?? 'itu';
+  const table    = standard === 'american' ? AMERICAN : ITU;
+  return Object.entries(table).map(([char, code]) => ({ char, code }));
+}
+
+// ─── EXPORTS ─────────────────────────────────────────────────────────────────
+
+module.exports = {
+  kitdef: {
+    encode,
+    decode,
+    timing,
+    analyze,
+    alphabet,
+    // Raw tables for advanced use
+    ITU,
+    AMERICAN,
+    PROSIGNS,
+    ITU_REV,
+    AMERICAN_REV,
+    PROSIGN_REV,
+    VISUAL,
+  }
+};