textbrowser 0.45.2 → 0.46.1

package/resources/templates/workSelect.js

@@ -2,7 +2,7 @@
 import {jml, $} from 'jamilih';
 import {deserialize as formDeserialize} from 'form-serialization';
 
-export default ({groups, lf, getNextAlias, $p, followParams}) => {
+export default ({groups, workI18n, getNextAlias, $p, followParams}) => {
   const form = jml(
     'form',
     {id: 'workSelect', class: 'focus', $on: {
@@ -10,11 +10,11 @@ export default ({groups, lf, getNextAlias, $p, followParams}) => {
         e.preventDefault();
       }
     }},
-    groups.map((group, i) =>
-      ['div', [
+    groups.map((group, i) => {
+      return ['div', [
         i > 0 ? ['br', 'br', 'br'] : '',
         ['div', [
-          lf({key: group.directions.localeKey, fallback: true})
+          workI18n(group.directions.localeKey)
         ]],
         ['br'],
         ['select', {
@@ -40,14 +40,14 @@ export default ({groups, lf, getNextAlias, $p, followParams}) => {
           ['option', {value: ''}, ['--']],
           ...group.files.map(({name: fileName}) =>
             ['option', {
-              value: lf(['workNames', group.id, fileName])
+              value: workI18n(['workNames', group.id, fileName])
             }, [getNextAlias()]]
           )
         ]]
         // Todo: Add in Go button (with 'submitgo' localization string) to
         //    avoid need for pull-down if using first selection?
-      ]]
-    ),
+      ]];
+    }),
     $('#main')
   );
   if (history.state && typeof history.state === 'object') {

package/resources/user-sample.js

@@ -1,6 +1,5 @@
 import TextBrowser from '../node_modules/textbrowser/dist/index-es.js';
 
-(async () => {
 const tb = new TextBrowser({
   // languages: 'node_modules/textbrowser/appdata/languages.json', // Default
   // serviceWorkerPath: 'sw.js', // Default
@@ -20,4 +19,3 @@ const tb = new TextBrowser({
   // , interlinearSeparator: '<hr />' // Defaults to `<br /><br />`
 });
 await tb.init();
-})();

package/resources/user.js

@@ -1,6 +1,5 @@
 import TextBrowser from '../dist/index-es.js';
 
-(async () => {
 const tb = new TextBrowser({
   languages: 'appdata/languages.json', // Default
   // serviceWorkerPath: 'sw.js', // Default
@@ -19,4 +18,3 @@ const tb = new TextBrowser({
   // , interlinearSeparator: '<hr />' // Defaults to `<br /><br />`
 });
 await tb.init();
-})();

package/resources/utils/IntlURLSearchParams.js

@@ -2,7 +2,7 @@
  *
  * @param {string} param
  * @param {boolean} skip
- * @this IntlURLSearchParams
+ * @this {IntlURLSearchParams}
  * @returns {string}
  */
 function _prepareParam (param, skip) {

package/resources/utils/Languages.js

@@ -24,22 +24,27 @@ export class Languages {
   constructor ({langData}) {
     this.langData = langData;
   }
-  localeFromLangData (lan) {
-    return this.langData['localization-strings'][lan];
+  localeFromLangData (langCode) {
+    return this.langData['localization-strings'][langCode];
   }
   getLanguageFromCode (code) {
     return this.localeFromLangData(code).languages[code];
+    // Could add something like this in place or as fallback, though need to pass in locale
+    // || new Intl.DisplayNames([locale], {type: 'language'}).of(code);
   }
   getFieldNameFromPluginNameAndLocales ({
-    pluginName, locales, lf, targetLanguage, applicableFieldI18N, meta, metaApplicableField
+    pluginName, locales, workI18n, targetLanguage, applicableFieldI18N, meta, metaApplicableField
   }) {
-    return lf(['plugins', pluginName, 'fieldname'], {
+    return workI18n(['plugins', pluginName, 'fieldname'], {
       ...meta,
       ...metaApplicableField,
       applicableField: applicableFieldI18N,
       targetLanguage: targetLanguage
         ? this.getLanguageFromCode(targetLanguage)
         : ''
+    }, {
+      // We provide more than may be desired by the plugin
+      throwOnExtraSuppliedFormatters: false
     });
   }
   getLanguageInfo ({$p}) {

package/resources/utils/Metadata.js

@@ -64,13 +64,22 @@ export const getFieldNameAndValueAliases = function ({
   );
   const fieldSchema = schemaItems[fieldSchemaIndex];
 
+  const fieldInfo = metadataObj.fields[field];
+
   const ret = {
     // field,
-    fieldName: getFieldAliasOrName(field)
+    aliases: null,
+    fieldValueAliasMap: null,
+    rawFieldValueAliasMap: null,
+    fieldName: getFieldAliasOrName(field),
+    fieldSchema,
+    fieldSchemaIndex,
+    preferAlias: fieldInfo.prefer_alias,
+    lang: fieldInfo.lang
   };
 
-  const fieldInfo = metadataObj.fields[field];
   let fieldValueAliasMap = fieldInfo && fieldInfo['fieldvalue-aliases'];
+
   if (fieldValueAliasMap) {
     if (fieldValueAliasMap.localeKey) {
       fieldValueAliasMap = getMetaProp(
@@ -123,10 +132,6 @@ export const getFieldNameAndValueAliases = function ({
     ret.fieldValueAliasMap = JSON.parse(JSON.stringify(fieldValueAliasMap));
     // ret.aliases.sort();
   }
-  ret.fieldSchema = fieldSchema;
-  ret.fieldSchemaIndex = fieldSchemaIndex;
-  ret.preferAlias = fieldInfo.prefer_alias;
-  ret.lang = fieldInfo.lang;
   return ret;
 };
 
@@ -144,7 +149,7 @@ export const getBrowseFieldData = function ({
     const setName = browseFieldSetObject.name;
     const fieldSets = browseFieldSetObject.set;
     const {presort} = browseFieldSetObject;
-    // Todo: Deal with ['td', [['h3', [ld(browseFieldObject.name)]]]]
+    // Todo: Deal with ['td', [['h3', [lDirectional(browseFieldObject.name)]]]]
     //          as kind of fieldset
 
     const browseFields = fieldSets.map((field) =>
@@ -154,7 +159,7 @@ export const getBrowseFieldData = function ({
         getFieldAliasOrName
       })
     );
-    callback({setName, browseFields, i, presort}); // eslint-disable-line node/no-callback-literal
+    callback({setName, browseFields, i, presort}); // eslint-disable-line n/no-callback-literal
   });
 };
 

package/resources/utils/Params.js

@@ -14,8 +14,10 @@ export const getSerializeParamsAsURL = function (...args) {
   };
 };
 
-export const getParamsSetter = function ({l, il, $p}) {
-  return function ({form, random = {}, checkboxes, type, fieldAliasOrNames = [], workName}) {
+export const getParamsSetter = function ({l, lParam, $p}) {
+  return function ({form, random = {
+    checked: false
+  }, checkboxes, type, fieldAliasOrNames = [], workName}) {
     const paramsCopy = new URLSearchParams($p.params);
     const formParamsHash = formSerialize(form, {hash: true, empty: true});
 
@@ -24,8 +26,8 @@ export const getParamsSetter = function ({l, il, $p}) {
     });
 
     // Follow the same style (and order) for checkboxes
-    paramsCopy.delete(il('rand'));
-    paramsCopy.set(il('rand'), random.checked ? l('yes') : l('no'));
+    paramsCopy.delete(lParam('rand'));
+    paramsCopy.set(lParam('rand'), random.checked ? l('yes') : l('no'));
 
     // We want checkboxes to typically show by default, so we cannot use the
     //    standard serialization
@@ -60,11 +62,11 @@ export const getParamsSetter = function ({l, il, $p}) {
     case 'saveSettings': {
       // In case it was added previously on
       //    this page, let's remove it.
-      paramsCopy.delete(il('rand'));
+      paramsCopy.delete(lParam('rand'));
       break;
     }
     case 'shortcutResult': {
-      paramsCopy.delete(il('rand'));
+      paramsCopy.delete(lParam('rand'));
       let num = 1;
       while (paramsCopy.has(`anchorfield${num}`, true)) {
         paramsCopy.delete(`anchorfield${num}`, true);
@@ -100,10 +102,10 @@ export const getParamsSetter = function ({l, il, $p}) {
       // In case it was added previously on this page,
       //    let's put random again toward the end.
       if (type === 'randomResult' || random.checked) {
-        paramsCopy.delete(il('rand'));
-        paramsCopy.set(il('rand'), l('yes'));
+        paramsCopy.delete(lParam('rand'));
+        paramsCopy.set(lParam('rand'), l('yes'));
       }
-      paramsCopy.set(il('result'), l('yes'));
+      paramsCopy.set(lParam('result'), l('yes'));
       break;
     }
     default: {

package/resources/utils/Plugin.js

@@ -51,7 +51,7 @@ export class PluginsForWork {
         onByDefault: onByDefaultDefault, lang: pluginLang, meta
       }] = this.pluginsInWork[i];
       const plugin = this.getPluginObject(pluginName);
-      cb({ // eslint-disable-line node/no-callback-literal
+      cb({ // eslint-disable-line n/no-callback-literal
         plugin,
         placement,
         applicableFields,
@@ -71,11 +71,11 @@ export class PluginsForWork {
     }]) => {
       if (Array.isArray(targetLanguage)) {
         targetLanguage.forEach((targetLanguage) => {
-          cb({applicableField, targetLanguage, onByDefault, metaApplicableField}); // eslint-disable-line node/no-callback-literal
+          cb({applicableField, targetLanguage, onByDefault, metaApplicableField}); // eslint-disable-line n/no-callback-literal
         });
       } else {
-        // eslint-disable-next-line node/callback-return
-        cb({applicableField, targetLanguage, onByDefault, metaApplicableField}); // eslint-disable-line node/no-callback-literal
+        // eslint-disable-next-line n/callback-return
+        cb({applicableField, targetLanguage, onByDefault, metaApplicableField}); // eslint-disable-line n/no-callback-literal
       }
     });
     return true;

package/resources/utils/WorkInfo.js

@@ -1,5 +1,5 @@
 import {getJSON} from 'simple-get-json';
-import {IMF} from 'imf';
+import {i18n} from 'intl-dom';
 import {getMetaProp, getMetadata, Metadata} from './Metadata.js';
 import {PluginsForWork, escapePlugin} from './Plugin.js';
 
@@ -37,27 +37,42 @@ export const getWorkData = async function ({
   languages, preferredLocale
 }) {
   const filesObj = await getJSON(files);
-  const localeFromFileData = (lan) =>
-    filesObj['localization-strings'][lan];
-  const imfFile = IMF({
-    locales: lang.map(localeFromFileData),
-    fallbackLocales: fallbackLanguages.map(localeFromFileData)
+  const localizationStrings = filesObj['localization-strings'];
+
+  const workI18n = await i18n({
+    messageStyle: 'plainNested',
+    locales: lang,
+    defaultLocales: fallbackLanguages,
+    // Todo: Could at least share this with `index.js`
+    localeStringFinder ({
+      locales, defaultLocales
+    }) {
+      const locale = [...locales, ...defaultLocales].find((language) => {
+        return language in localizationStrings;
+      });
+      return {
+        locale,
+        strings: {
+          head: {},
+          body: localizationStrings[locale]
+        }
+      };
+    }
   });
-  const lf = imfFile.getFormatter();
 
   let fileData;
   const fileGroup = filesObj.groups.find((fg) => {
     fileData = fg.files.find((file) =>
-      work === lf(['workNames', fg.id, file.name])
+      work === workI18n(['workNames', fg.id, file.name])
     );
     return Boolean(fileData);
   });
     // This is not specific to the work, but we export it anyways
   const groupsToWorks = filesObj.groups.map((fg) => {
     return {
-      name: lf({key: fg.name.localeKey, fallback: true}),
+      name: workI18n(fg.name.localeKey),
       workNames: fg.files.map((file) => {
-        return lf(['workNames', fg.id, file.name]);
+        return workI18n(['workNames', fg.id, file.name]);
       }),
       shortcuts: fg.files.map((file) => file.shortcut)
     };
@@ -191,7 +206,7 @@ export const getWorkData = async function ({
         const fieldAliasOrName = plugin.getFieldAliasOrName
           ? plugin.getFieldAliasOrName({
             locales: lang,
-            lf,
+            workI18n,
             targetLanguage,
             applicableField,
             applicableFieldI18N,
@@ -202,7 +217,7 @@ export const getWorkData = async function ({
           : languages.getFieldNameFromPluginNameAndLocales({
             pluginName,
             locales: lang,
-            lf,
+            workI18n,
             targetLanguage,
             applicableFieldI18N,
             // Todo: Should have formal way to i18nize meta
@@ -239,7 +254,7 @@ export const getWorkData = async function ({
     });
   }
   return {
-    fileData, lf, getFieldAliasOrName, metadataObj,
+    fileData, workI18n, getFieldAliasOrName, metadataObj,
     schemaObj, schemaItems, fieldInfo,
     pluginsForWork, groupsToWorks, metadata
   };

package/resources/utils/dialogs.js

@@ -21,7 +21,9 @@ class Dialog {
       ...localeObject
     };
   }
-  makeDialog ({atts = {}, children = [], close, remove = true}) {
+  makeDialog ({atts = {
+    $on: null
+  }, children = [], close, remove = true}) {
     if (close) {
       if (!atts.$on) {
         atts.$on = {};
@@ -30,7 +32,7 @@ class Dialog {
         atts.$on.close = close;
       }
     }
-    const dialog = jml('dialog', atts, children, $('#main'));
+    const dialog = /** @type {HTMLDialogElement} */ (jml('dialog', atts, children, $('#main')));
     dialog.showModal();
     if (remove) {
       dialog.addEventListener('close', () => {
@@ -93,7 +95,7 @@ class Dialog {
       submitClass = 'submit'
     } = message;
     return new Promise((resolve, reject) => {
-      const dialog = jml('dialog', [
+      const dialog = /** @type {HTMLDialogElement} */ (jml('dialog', [
         msg,
         ...(includeOk
           ? ([
@@ -106,7 +108,7 @@ class Dialog {
             ]]
           ])
           : [])
-      ], $('#main'));
+      ], $('#main')));
       dialog.showModal();
     });
   }
@@ -141,7 +143,7 @@ class Dialog {
     message = typeof message === 'string' ? {message} : message;
     const {message: msg, submitClass = 'submit'} = message;
     return new Promise((resolve, reject) => {
-      const dialog = jml('dialog', [
+      const dialog = /** @type {HTMLDialogElement} */ (jml('dialog', [
         msg,
         ['br'], ['br'],
         ['div', {class: submitClass}, [
@@ -155,7 +157,7 @@ class Dialog {
             reject(new Error('cancelled'));
           }}}, [this.localeStrings.cancel]]
         ]]
-      ], $('#main'));
+      ], $('#main')));
       dialog.showModal();
     });
   }

package/resources/utils/getLocaleFallbackResults.js

@@ -0,0 +1,26 @@
+import {i18n} from 'intl-dom';
+
+export default async function getLocaleFallbackResults ({
+  $p,
+  lang, langs, langData, fallbackLanguages,
+  basePath = ''
+}) {
+  const l = await i18n({
+    messageStyle: 'plainNested',
+    locales: lang,
+    defaultLocales: fallbackLanguages,
+    localeResolver (localesBasePath, code) {
+      // Todo: For editing of locales, we might instead resolve all
+      //    `$ref` (as with <https://github.com/whitlockjc/json-refs>) and
+      //    replace `loadLocales` behavior with our own now resolved
+      //    locales; see https://github.com/jdorn/json-editor/issues/132
+      return basePath + (langData.localeFileBasePath) + langs.find((l) =>
+        l.code === code
+      ).locale.$ref;
+    }
+  });
+  if (!$p.l10n) {
+    $p.l10n = l;
+  }
+  return l;
+}