@vocab/core 1.2.1 → 1.2.2

package/dist/vocab-core.cjs.dev.js

@@ -451,7 +451,7 @@ function extractHasTags(ast) {
 }
 function extractParamTypes(ast) {
   let params = {};
-  let imports = new Set();
+  let vocabTypesImports = new Set();
   for (const element of ast) {
     if (icuMessageformatParser.isArgumentElement(element)) {
       params[element.value] = 'string';
@@ -462,7 +462,7 @@ function extractParamTypes(ast) {
       const children = Object.values(element.options).map(o => o.value);
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
-        imports = new Set([...imports, ...subImports]);
+        vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
         params = {
           ...params,
           ...subParams
@@ -472,19 +472,25 @@ function extractParamTypes(ast) {
       params[element.value] = 'Date | number';
     } else if (icuMessageformatParser.isTagElement(element)) {
       params[element.value] = 'FormatXMLElementFn<T>';
-      imports.add(`import { FormatXMLElementFn } from '@vocab/types';`);
+      vocabTypesImports.add('FormatXMLElementFn');
       const [subParams, subImports] = extractParamTypes(element.children);
-      imports = new Set([...imports, ...subImports]);
+      vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
       params = {
         ...params,
         ...subParams
       };
     } else if (icuMessageformatParser.isSelectElement(element)) {
-      params[element.value] = Object.keys(element.options).map(o => `'${o}'`).join(' | ');
+      const options = Object.keys(element.options);
+
+      // `other` will always be an option as the parser enforces this by default
+      const nonOtherOptions = options.filter(o => o !== 'other');
+      const nonOtherOptionsUnion = nonOtherOptions.map(o => `'${o}'`).join(' | ');
+      params[element.value] = `StringWithSuggestions<${nonOtherOptionsUnion}>`;
+      vocabTypesImports.add('StringWithSuggestions');
       const children = Object.values(element.options).map(o => o.value);
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
-        imports = new Set([...imports, ...subImports]);
+        vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
         params = {
           ...params,
           ...subParams
@@ -492,7 +498,7 @@ function extractParamTypes(ast) {
       }
     }
   }
-  return [params, imports];
+  return [params, vocabTypesImports];
 }
 function serialiseObjectToType(v) {
   let result = '';
@@ -506,6 +512,10 @@ function serialiseObjectToType(v) {
   return `{ ${result} }`;
 }
 const banner = `// This file is automatically generated by Vocab.\n// To make changes update translation.json files directly.`;
+const serializeModuleImports = (imports, moduleName) => {
+  const importNames = Array.from(imports);
+  return `import { ${Array.from(importNames).join(', ')} } from '${moduleName}'`;
+};
 function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   trace('Serialising translations:', loadedTranslation);
   const translationsType = {};
@@ -526,7 +536,7 @@ function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   const languagesUnionAsString = Object.keys(loadedTranslation.languages).map(l => `'${l}'`).join(' | ');
   return `${banner}
 
-  ${Array.from(imports).join('\n')}
+  ${serializeModuleImports(imports, '@vocab/types')}
   import { createLanguage, createTranslationFile } from '@vocab/core/runtime';
 
   const translations = createTranslationFile<${languagesUnionAsString}, ${serialiseObjectToType(translationsType)}>({${content}});
@@ -549,8 +559,8 @@ async function generateRuntime(loadedTranslation) {
       if (translatedLanguage[key]) {
         const ast = icuMessageformatParser.parse(translatedLanguage[key].message);
         hasTags = hasTags || extractHasTags(ast);
-        const [parsedParams, parsedImports] = extractParamTypes(ast);
-        imports = new Set([...imports, ...parsedImports]);
+        const [parsedParams, vocabTypesImports] = extractParamTypes(ast);
+        imports = new Set([...imports, ...vocabTypesImports]);
         params = {
           ...params,
           ...parsedParams

package/dist/vocab-core.cjs.prod.js

@@ -451,7 +451,7 @@ function extractHasTags(ast) {
 }
 function extractParamTypes(ast) {
   let params = {};
-  let imports = new Set();
+  let vocabTypesImports = new Set();
   for (const element of ast) {
     if (icuMessageformatParser.isArgumentElement(element)) {
       params[element.value] = 'string';
@@ -462,7 +462,7 @@ function extractParamTypes(ast) {
       const children = Object.values(element.options).map(o => o.value);
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
-        imports = new Set([...imports, ...subImports]);
+        vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
         params = {
           ...params,
           ...subParams
@@ -472,19 +472,25 @@ function extractParamTypes(ast) {
       params[element.value] = 'Date | number';
     } else if (icuMessageformatParser.isTagElement(element)) {
       params[element.value] = 'FormatXMLElementFn<T>';
-      imports.add(`import { FormatXMLElementFn } from '@vocab/types';`);
+      vocabTypesImports.add('FormatXMLElementFn');
       const [subParams, subImports] = extractParamTypes(element.children);
-      imports = new Set([...imports, ...subImports]);
+      vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
       params = {
         ...params,
         ...subParams
       };
     } else if (icuMessageformatParser.isSelectElement(element)) {
-      params[element.value] = Object.keys(element.options).map(o => `'${o}'`).join(' | ');
+      const options = Object.keys(element.options);
+
+      // `other` will always be an option as the parser enforces this by default
+      const nonOtherOptions = options.filter(o => o !== 'other');
+      const nonOtherOptionsUnion = nonOtherOptions.map(o => `'${o}'`).join(' | ');
+      params[element.value] = `StringWithSuggestions<${nonOtherOptionsUnion}>`;
+      vocabTypesImports.add('StringWithSuggestions');
       const children = Object.values(element.options).map(o => o.value);
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
-        imports = new Set([...imports, ...subImports]);
+        vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
         params = {
           ...params,
           ...subParams
@@ -492,7 +498,7 @@ function extractParamTypes(ast) {
       }
     }
   }
-  return [params, imports];
+  return [params, vocabTypesImports];
 }
 function serialiseObjectToType(v) {
   let result = '';
@@ -506,6 +512,10 @@ function serialiseObjectToType(v) {
   return `{ ${result} }`;
 }
 const banner = `// This file is automatically generated by Vocab.\n// To make changes update translation.json files directly.`;
+const serializeModuleImports = (imports, moduleName) => {
+  const importNames = Array.from(imports);
+  return `import { ${Array.from(importNames).join(', ')} } from '${moduleName}'`;
+};
 function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   trace('Serialising translations:', loadedTranslation);
   const translationsType = {};
@@ -526,7 +536,7 @@ function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   const languagesUnionAsString = Object.keys(loadedTranslation.languages).map(l => `'${l}'`).join(' | ');
   return `${banner}
 
-  ${Array.from(imports).join('\n')}
+  ${serializeModuleImports(imports, '@vocab/types')}
   import { createLanguage, createTranslationFile } from '@vocab/core/runtime';
 
   const translations = createTranslationFile<${languagesUnionAsString}, ${serialiseObjectToType(translationsType)}>({${content}});
@@ -549,8 +559,8 @@ async function generateRuntime(loadedTranslation) {
       if (translatedLanguage[key]) {
         const ast = icuMessageformatParser.parse(translatedLanguage[key].message);
         hasTags = hasTags || extractHasTags(ast);
-        const [parsedParams, parsedImports] = extractParamTypes(ast);
-        imports = new Set([...imports, ...parsedImports]);
+        const [parsedParams, vocabTypesImports] = extractParamTypes(ast);
+        imports = new Set([...imports, ...vocabTypesImports]);
         params = {
           ...params,
           ...parsedParams

package/dist/vocab-core.esm.js

@@ -435,7 +435,7 @@ function extractHasTags(ast) {
 }
 function extractParamTypes(ast) {
   let params = {};
-  let imports = new Set();
+  let vocabTypesImports = new Set();
   for (const element of ast) {
     if (isArgumentElement(element)) {
       params[element.value] = 'string';
@@ -446,7 +446,7 @@ function extractParamTypes(ast) {
       const children = Object.values(element.options).map(o => o.value);
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
-        imports = new Set([...imports, ...subImports]);
+        vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
         params = {
           ...params,
           ...subParams
@@ -456,19 +456,25 @@ function extractParamTypes(ast) {
       params[element.value] = 'Date | number';
     } else if (isTagElement(element)) {
       params[element.value] = 'FormatXMLElementFn<T>';
-      imports.add(`import { FormatXMLElementFn } from '@vocab/types';`);
+      vocabTypesImports.add('FormatXMLElementFn');
       const [subParams, subImports] = extractParamTypes(element.children);
-      imports = new Set([...imports, ...subImports]);
+      vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
       params = {
         ...params,
         ...subParams
       };
     } else if (isSelectElement(element)) {
-      params[element.value] = Object.keys(element.options).map(o => `'${o}'`).join(' | ');
+      const options = Object.keys(element.options);
+
+      // `other` will always be an option as the parser enforces this by default
+      const nonOtherOptions = options.filter(o => o !== 'other');
+      const nonOtherOptionsUnion = nonOtherOptions.map(o => `'${o}'`).join(' | ');
+      params[element.value] = `StringWithSuggestions<${nonOtherOptionsUnion}>`;
+      vocabTypesImports.add('StringWithSuggestions');
       const children = Object.values(element.options).map(o => o.value);
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
-        imports = new Set([...imports, ...subImports]);
+        vocabTypesImports = new Set([...vocabTypesImports, ...subImports]);
         params = {
           ...params,
           ...subParams
@@ -476,7 +482,7 @@ function extractParamTypes(ast) {
       }
     }
   }
-  return [params, imports];
+  return [params, vocabTypesImports];
 }
 function serialiseObjectToType(v) {
   let result = '';
@@ -490,6 +496,10 @@ function serialiseObjectToType(v) {
   return `{ ${result} }`;
 }
 const banner = `// This file is automatically generated by Vocab.\n// To make changes update translation.json files directly.`;
+const serializeModuleImports = (imports, moduleName) => {
+  const importNames = Array.from(imports);
+  return `import { ${Array.from(importNames).join(', ')} } from '${moduleName}'`;
+};
 function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   trace('Serialising translations:', loadedTranslation);
   const translationsType = {};
@@ -510,7 +520,7 @@ function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   const languagesUnionAsString = Object.keys(loadedTranslation.languages).map(l => `'${l}'`).join(' | ');
   return `${banner}
 
-  ${Array.from(imports).join('\n')}
+  ${serializeModuleImports(imports, '@vocab/types')}
   import { createLanguage, createTranslationFile } from '@vocab/core/runtime';
 
   const translations = createTranslationFile<${languagesUnionAsString}, ${serialiseObjectToType(translationsType)}>({${content}});
@@ -533,8 +543,8 @@ async function generateRuntime(loadedTranslation) {
       if (translatedLanguage[key]) {
         const ast = parse(translatedLanguage[key].message);
         hasTags = hasTags || extractHasTags(ast);
-        const [parsedParams, parsedImports] = extractParamTypes(ast);
-        imports = new Set([...imports, ...parsedImports]);
+        const [parsedParams, vocabTypesImports] = extractParamTypes(ast);
+        imports = new Set([...imports, ...vocabTypesImports]);
         params = {
           ...params,
           ...parsedParams

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocab/core",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "main": "dist/vocab-core.cjs.js",
   "module": "dist/vocab-core.esm.js",
   "exports": {