@designcrowd/fe-shared-lib 1.7.0 → 1.8.0

package/src/useSharedLibTranslate.js

@@ -1,131 +1,131 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-import i18next from 'i18next';
-
-const fallbackLocale = 'en-US';
-
-const relativePathsToTranslationFiles = {
-  'en-US': () => import('./bundles/bundled-translations.json'),
-  'de-DE': () => import('./bundles/bundled-translations.de-DE.json'),
-  'fr-FR': () => import('./bundles/bundled-translations.fr-FR.json'),
-  'fr-CA': () => import('./bundles/bundled-translations.fr-CA.json'),
-  'es-ES': () => import('./bundles/bundled-translations.es-ES.json'),
-  'pt-PT': () => import('./bundles/bundled-translations.pt-PT.json'),
-  'pt-BR': () => import('./bundles/bundled-translations.pt-BR.json'),
-};
-
-const setSharedLibLocaleAsync = async (locale = 'en-US') => {
-  const localeToUse = locale || 'en-US';
-
-  if (!i18next.isInitialized) {
-    await i18next.init({
-      debug: false,
-      fallbackLng: fallbackLocale,
-      lng: localeToUse,
-    });
-  }
-
-  const languageFile = (await relativePathsToTranslationFiles[localeToUse]()).default;
-
-  await i18next.addResourceBundle(localeToUse, 'fe-shared-lib', {
-    ...languageFile,
-  });
-
-  await i18next.changeLanguage(localeToUse);
-};
-
-const tr = (key, valuesToInterpolate = {}) => {
-  const translated = i18next.t(key, { ns: 'fe-shared-lib', ...valuesToInterpolate });
-
-  return translated;
-};
-
-const uploadYourLogoTr = (key, valuesToInterpolate = {}) => tr(`uploadYourLogo.${key}`, valuesToInterpolate);
-
-const publishBrandPageModalTr = (key, valuesToInterpolate = {}) =>
-  tr(`publishBrandPageModal.${key}`, valuesToInterpolate);
-
-const sellDomainNameWidgetTr = (key, valuesToInterpolate = {}) =>
-  tr(`sellDomainNameWidget.${key}`, valuesToInterpolate);
-
-const sellDomainNameListSearchResultTr = (key, valuesToInterpolate = {}) =>
-  tr(`sellDomainNameListSearchResult.${key}`, valuesToInterpolate);
-
-const sellDomainNameSearchTr = (key, valuesToInterpolate = {}) =>
-  tr(`sellDomainNameSearch.${key}`, valuesToInterpolate);
-
-const sellDomainNameModalApplicationTr = (key, valuesToInterpolate = {}) =>
-  tr(`sellDomainNameModalApplication.${key}`, valuesToInterpolate);
-
-const sellDomainNameListModalTr = (key, valuesToInterpolate = {}) =>
-  tr(`sellDomainNameListModal.${key}`, valuesToInterpolate);
-
-const sellDomainNameListTr = (key, valuesToInterpolate = {}) => tr(`sellDomainNameList.${key}`, valuesToInterpolate);
-
-const sharedPaymentConfigTr = (key, valuesToInterpolate = {}) => tr(`sharedPaymentConfig.${key}`, valuesToInterpolate);
-
-const priceTr = (key, valuesToInterpolate = {}) => tr(`price.${key}`, valuesToInterpolate);
-
-const uploadLogoSearchResultCardTr = (key, valuesToInterpolate = {}) =>
-  tr(`uploadLogoSearchResultCard.${key}`, valuesToInterpolate);
-
-const websiteContextualUpgradeModalTr = (key, valuesToInterpolate = {}) =>
-  tr(`websiteContextualUpgradeModal.${key}`, valuesToInterpolate);
-
-const getCurrentLocale = () => {
-  return i18next.language || 'en-US';
-};
-
-const formatCurrency = (amount, locale, currency, fraction = 0, showAbbreviation = false) => {
-  let localeAmount = i18next.t('{{val, currency}}', {
-    ns: 'fe-shared-lib',
-    val: amount,
-    currency: currency.iso4127Code,
-    locale: locale,
-    maximumFractionDigits: fraction,
-    useGrouping: false,
-  });
-
-  const abbreviationTrimmed = currency.abbreviation.trim();
-  const symbolTrimmed = currency.symbol.trim();
-
-  // i18next always uses iso code for some locale/currency combos like ZAR, prefer symbol over iso code
-  if (localeAmount.includes(currency.iso4127Code)) {
-    localeAmount = localeAmount.replace(currency.iso4127Code, symbolTrimmed);
-  }
-
-  // show abbreviation locale logic
-  // note: showAbbreviation is only passed as true for symbol = "$"
-  if (currency.symbol.trim() !== '$') {
-    return localeAmount;
-  }
-
-  const altAudAbbreviation = 'AU';
-  if (showAbbreviation && !localeAmount.includes(abbreviationTrimmed)) {
-    return localeAmount.replace(symbolTrimmed, `${abbreviationTrimmed}${symbolTrimmed}`);
-  } else if (!showAbbreviation && localeAmount.includes(altAudAbbreviation)) {
-    return localeAmount.replace(altAudAbbreviation, '');
-  } else if (!showAbbreviation && localeAmount.includes(abbreviationTrimmed)) {
-    return localeAmount.replace(abbreviationTrimmed, '');
-  }
-
-  return localeAmount;
-};
-
-export {
-  setSharedLibLocaleAsync,
-  getCurrentLocale,
-  tr,
-  publishBrandPageModalTr,
-  sellDomainNameWidgetTr,
-  sellDomainNameListSearchResultTr,
-  sellDomainNameSearchTr,
-  sellDomainNameModalApplicationTr,
-  sellDomainNameListModalTr,
-  sellDomainNameListTr,
-  uploadYourLogoTr,
-  sharedPaymentConfigTr,
-  priceTr,
-  uploadLogoSearchResultCardTr,
-  formatCurrency,
-  websiteContextualUpgradeModalTr,
-};
+// eslint-disable-next-line import/no-extraneous-dependencies
+import i18next from 'i18next';
+
+const fallbackLocale = 'en-US';
+
+const relativePathsToTranslationFiles = {
+  'en-US': () => import('./bundles/bundled-translations.json'),
+  'de-DE': () => import('./bundles/bundled-translations.de-DE.json'),
+  'fr-FR': () => import('./bundles/bundled-translations.fr-FR.json'),
+  'fr-CA': () => import('./bundles/bundled-translations.fr-CA.json'),
+  'es-ES': () => import('./bundles/bundled-translations.es-ES.json'),
+  'pt-PT': () => import('./bundles/bundled-translations.pt-PT.json'),
+  'pt-BR': () => import('./bundles/bundled-translations.pt-BR.json'),
+};
+
+const setSharedLibLocaleAsync = async (locale = 'en-US') => {
+  const localeToUse = locale || 'en-US';
+
+  if (!i18next.isInitialized) {
+    await i18next.init({
+      debug: false,
+      fallbackLng: fallbackLocale,
+      lng: localeToUse,
+    });
+  }
+
+  const languageFile = (await relativePathsToTranslationFiles[localeToUse]()).default;
+
+  await i18next.addResourceBundle(localeToUse, 'fe-shared-lib', {
+    ...languageFile,
+  });
+
+  await i18next.changeLanguage(localeToUse);
+};
+
+const tr = (key, valuesToInterpolate = {}) => {
+  const translated = i18next.t(key, { ns: 'fe-shared-lib', ...valuesToInterpolate });
+
+  return translated;
+};
+
+const uploadYourLogoTr = (key, valuesToInterpolate = {}) => tr(`uploadYourLogo.${key}`, valuesToInterpolate);
+
+const publishBrandPageModalTr = (key, valuesToInterpolate = {}) =>
+  tr(`publishBrandPageModal.${key}`, valuesToInterpolate);
+
+const sellDomainNameWidgetTr = (key, valuesToInterpolate = {}) =>
+  tr(`sellDomainNameWidget.${key}`, valuesToInterpolate);
+
+const sellDomainNameListSearchResultTr = (key, valuesToInterpolate = {}) =>
+  tr(`sellDomainNameListSearchResult.${key}`, valuesToInterpolate);
+
+const sellDomainNameSearchTr = (key, valuesToInterpolate = {}) =>
+  tr(`sellDomainNameSearch.${key}`, valuesToInterpolate);
+
+const sellDomainNameModalApplicationTr = (key, valuesToInterpolate = {}) =>
+  tr(`sellDomainNameModalApplication.${key}`, valuesToInterpolate);
+
+const sellDomainNameListModalTr = (key, valuesToInterpolate = {}) =>
+  tr(`sellDomainNameListModal.${key}`, valuesToInterpolate);
+
+const sellDomainNameListTr = (key, valuesToInterpolate = {}) => tr(`sellDomainNameList.${key}`, valuesToInterpolate);
+
+const sharedPaymentConfigTr = (key, valuesToInterpolate = {}) => tr(`sharedPaymentConfig.${key}`, valuesToInterpolate);
+
+const priceTr = (key, valuesToInterpolate = {}) => tr(`price.${key}`, valuesToInterpolate);
+
+const uploadLogoSearchResultCardTr = (key, valuesToInterpolate = {}) =>
+  tr(`uploadLogoSearchResultCard.${key}`, valuesToInterpolate);
+
+const websiteContextualUpgradeModalTr = (key, valuesToInterpolate = {}) =>
+  tr(`websiteContextualUpgradeModal.${key}`, valuesToInterpolate);
+
+const getCurrentLocale = () => {
+  return i18next.language || 'en-US';
+};
+
+const formatCurrency = (amount, locale, currency, fraction = 0, showAbbreviation = false) => {
+  let localeAmount = i18next.t('{{val, currency}}', {
+    ns: 'fe-shared-lib',
+    val: amount,
+    currency: currency.iso4127Code,
+    locale: locale,
+    maximumFractionDigits: fraction,
+    useGrouping: false,
+  });
+
+  const abbreviationTrimmed = currency.abbreviation.trim();
+  const symbolTrimmed = currency.symbol.trim();
+
+  // i18next always uses iso code for some locale/currency combos like ZAR, prefer symbol over iso code
+  if (localeAmount.includes(currency.iso4127Code)) {
+    localeAmount = localeAmount.replace(currency.iso4127Code, symbolTrimmed);
+  }
+
+  // show abbreviation locale logic
+  // note: showAbbreviation is only passed as true for symbol = "$"
+  if (currency.symbol.trim() !== '$') {
+    return localeAmount;
+  }
+
+  const altAudAbbreviation = 'AU';
+  if (showAbbreviation && !localeAmount.includes(abbreviationTrimmed)) {
+    return localeAmount.replace(symbolTrimmed, `${abbreviationTrimmed}${symbolTrimmed}`);
+  } else if (!showAbbreviation && localeAmount.includes(altAudAbbreviation)) {
+    return localeAmount.replace(altAudAbbreviation, '');
+  } else if (!showAbbreviation && localeAmount.includes(abbreviationTrimmed)) {
+    return localeAmount.replace(abbreviationTrimmed, '');
+  }
+
+  return localeAmount;
+};
+
+export {
+  setSharedLibLocaleAsync,
+  getCurrentLocale,
+  tr,
+  publishBrandPageModalTr,
+  sellDomainNameWidgetTr,
+  sellDomainNameListSearchResultTr,
+  sellDomainNameSearchTr,
+  sellDomainNameModalApplicationTr,
+  sellDomainNameListModalTr,
+  sellDomainNameListTr,
+  uploadYourLogoTr,
+  sharedPaymentConfigTr,
+  priceTr,
+  uploadLogoSearchResultCardTr,
+  formatCurrency,
+  websiteContextualUpgradeModalTr,
+};

package/src/useVoiceToText.ts

@@ -0,0 +1,196 @@
+/* eslint-disable no-undef */
+import { ref, computed, readonly, type Ref, type ComputedRef, type DeepReadonly } from 'vue';
+
+export interface UseVoiceToTextOptions {
+  lang?: string;
+}
+
+export interface UseVoiceToTextReturn {
+  isSupported: ComputedRef<boolean>;
+  isListening: DeepReadonly<Ref<boolean>>;
+  transcript: DeepReadonly<Ref<string>>;
+  isFinal: DeepReadonly<Ref<boolean>>;
+  error: DeepReadonly<Ref<string | null>>;
+  start: () => void;
+  stop: () => void;
+  toggle: () => void;
+  // eslint-disable-next-line no-unused-vars
+  setLang: (lang: string) => void;
+}
+
+interface VoiceToTextState {
+  isListening: Ref<boolean>;
+  transcript: Ref<string>;
+  isFinal: Ref<boolean>;
+  error: Ref<string | null>;
+}
+
+// Singleton instance and state (lazily initialized)
+let recognition: SpeechRecognition | null = null;
+let isInitialized = false;
+let errorClearTimeout: ReturnType<typeof setTimeout> | null = null;
+let state: VoiceToTextState | null = null;
+
+// Error message mapping per spec
+const ERROR_MESSAGES: Record<string, string> = {
+  'not-allowed': 'Microphone permission was denied. Please allow access.',
+  'language-not-supported': 'This language is not supported.',
+  network: 'A network error occurred. Please check your connection.',
+  'audio-capture': 'No microphone was found or microphone is not working.',
+};
+
+const ERROR_CLEAR_DELAY = 5000;
+
+function getState(): VoiceToTextState {
+  if (!state) {
+    state = {
+      isListening: ref(false),
+      transcript: ref(''),
+      isFinal: ref(false),
+      error: ref<string | null>(null),
+    };
+  }
+  return state;
+}
+
+/**
+ * Singleton composable that wraps the Web Speech API (SpeechRecognition).
+ * All calls to useVoiceToText() return the same shared instance.
+ */
+export function useVoiceToText(options: UseVoiceToTextOptions = {}): UseVoiceToTextReturn {
+  const { lang = 'en-US' } = options;
+
+  // Get or create shared state
+  const { isListening, transcript, isFinal, error } = getState();
+
+  // Check for browser support
+  const SpeechRecognitionCtor: typeof SpeechRecognition | null =
+    typeof window !== 'undefined' ? window.SpeechRecognition || window.webkitSpeechRecognition : null;
+
+  const isSupported = computed(() => !!SpeechRecognitionCtor);
+
+  // Initialize singleton once
+  if (!isInitialized && SpeechRecognitionCtor) {
+    recognition = new SpeechRecognitionCtor();
+    recognition.continuous = true;
+    recognition.interimResults = true;
+
+    recognition.onresult = (event: SpeechRecognitionEvent) => {
+      let interimTranscript = '';
+      let finalTranscript = '';
+
+      for (let i = event.resultIndex; i < event.results.length; i += 1) {
+        const result = event.results[i];
+        if (result.isFinal) {
+          finalTranscript += result[0].transcript;
+        } else {
+          interimTranscript += result[0].transcript;
+        }
+      }
+
+      if (finalTranscript) {
+        transcript.value = finalTranscript;
+        isFinal.value = true;
+      } else {
+        transcript.value = interimTranscript;
+        isFinal.value = false;
+      }
+    };
+
+    recognition.onerror = (event: SpeechRecognitionErrorEvent) => {
+      // Suppress no-speech and aborted errors per spec
+      if (event.error === 'no-speech' || event.error === 'aborted') {
+        return;
+      }
+
+      const message = ERROR_MESSAGES[event.error] || 'An error occurred with speech recognition.';
+      error.value = message;
+
+      // eslint-disable-next-line no-console
+      console.warn('[useVoiceToText]', event.error, message);
+
+      // Auto-clear error after timeout
+      if (errorClearTimeout) {
+        clearTimeout(errorClearTimeout);
+      }
+      errorClearTimeout = setTimeout(() => {
+        error.value = null;
+      }, ERROR_CLEAR_DELAY);
+    };
+
+    recognition.onend = () => {
+      isListening.value = false;
+    };
+
+    isInitialized = true;
+  }
+
+  // Update language on existing instance
+  if (recognition) {
+    recognition.lang = lang;
+  }
+
+  const start = () => {
+    if (!recognition || isListening.value) return;
+
+    // Clear previous state
+    transcript.value = '';
+    isFinal.value = false;
+    error.value = null;
+    if (errorClearTimeout) {
+      clearTimeout(errorClearTimeout);
+      errorClearTimeout = null;
+    }
+
+    try {
+      recognition.start();
+      isListening.value = true;
+    } catch (e: unknown) {
+      // Handle case where recognition is already started
+      // eslint-disable-next-line no-console
+      console.warn('[useVoiceToText] Failed to start:', (e as Error).message);
+    }
+  };
+
+  const stop = () => {
+    if (!recognition || !isListening.value) return;
+
+    isListening.value = false;
+    try {
+      recognition.stop();
+    } catch (e: unknown) {
+      // Handle case where recognition is already stopped
+      // eslint-disable-next-line no-console
+      console.warn('[useVoiceToText] Failed to stop:', (e as Error).message);
+    }
+  };
+
+  const toggle = () => {
+    if (isListening.value) {
+      stop();
+    } else {
+      start();
+    }
+  };
+
+  const setLang = (newLang: string) => {
+    if (recognition) {
+      recognition.lang = newLang;
+    }
+  };
+
+  return {
+    // State (reactive, read-only)
+    isSupported,
+    isListening: readonly(isListening),
+    transcript: readonly(transcript),
+    isFinal: readonly(isFinal),
+    error: readonly(error),
+
+    // Actions
+    start,
+    stop,
+    toggle,
+    setLang,
+  };
+}

package/src/viewports.js

@@ -1,51 +1,51 @@
-module.exports = {
-  iPhone12Pro: {
-    name: "iPhone 12 Pro",
-    styles: {
-      width: "390px",
-      height: "844px",
-    },
-  },
-  iPhone12ProMax: {
-    name: "iPhone 12 Pro Max",
-    styles: {
-      width: "428px",
-      height: "926px",
-    },
-  },
-  iPhone8: {
-    name: "iPhone 8",
-    styles: {
-      width: "375px",
-      height: "667px",
-    },
-  },
-  iPhone5: {
-    name: "iPhone 5",
-    styles: {
-      width: "320px",
-      height: "568px",
-    },
-  },
-  iPadPro: {
-    name: "iPad Pro",
-    styles: {
-      width: "1024px",
-      height: "1366px",
-    },
-  },
-  iPadAir: {
-    name: "iPad Air",
-    styles: {
-      width: "820px",
-      height: "1180px",
-    },
-  },
-  fullHD: {
-    name: "Full HD",
-    styles: {
-      width: "1920px",
-      height: "1080px",
-    },
-  },
-};
+module.exports = {
+  iPhone12Pro: {
+    name: "iPhone 12 Pro",
+    styles: {
+      width: "390px",
+      height: "844px",
+    },
+  },
+  iPhone12ProMax: {
+    name: "iPhone 12 Pro Max",
+    styles: {
+      width: "428px",
+      height: "926px",
+    },
+  },
+  iPhone8: {
+    name: "iPhone 8",
+    styles: {
+      width: "375px",
+      height: "667px",
+    },
+  },
+  iPhone5: {
+    name: "iPhone 5",
+    styles: {
+      width: "320px",
+      height: "568px",
+    },
+  },
+  iPadPro: {
+    name: "iPad Pro",
+    styles: {
+      width: "1024px",
+      height: "1366px",
+    },
+  },
+  iPadAir: {
+    name: "iPad Air",
+    styles: {
+      width: "820px",
+      height: "1180px",
+    },
+  },
+  fullHD: {
+    name: "Full HD",
+    styles: {
+      width: "1920px",
+      height: "1080px",
+    },
+  },
+};

package/stylelint.config.js

@@ -1,19 +1,19 @@
-module.exports = {
-  extends: ['stylelint-config-standard'],
-  rules: {
-    'at-rule-no-unknown': [
-      true,
-      {
-        ignoreAtRules: [
-          'tailwind',
-          'apply',
-          'variants',
-          'responsive',
-          'screen',
-        ],
-      },
-    ],
-    'declaration-block-trailing-semicolon': null,
-    'no-descending-specificity': null,
-  },
-};
+module.exports = {
+  extends: ['stylelint-config-standard'],
+  rules: {
+    'at-rule-no-unknown': [
+      true,
+      {
+        ignoreAtRules: [
+          'tailwind',
+          'apply',
+          'variants',
+          'responsive',
+          'screen',
+        ],
+      },
+    ],
+    'declaration-block-trailing-semicolon': null,
+    'no-descending-specificity': null,
+  },
+};