From 1a12dce4a89de16b44cbdd9e00378bf1ac1d9945 Mon Sep 17 00:00:00 2001
From: Valentyne Stigloher <pixunil@posteo.eu>
Date: Tue, 12 Mar 2024 14:53:08 +0100
Subject: [PATCH] (ts) convert src/buildPronoun.ts

---
 components/Literature.vue                |  2 +-
 locale/pl/pronouns/EnglishTable.vue      |  2 +-
 locale/ru/pronouns/EnglishTable.vue      |  2 +-
 locale/ua/pronouns/EnglishTable.vue      |  2 +-
 plugins/mainPronoun.js                   |  2 +-
 routes/profileEditor.vue                 |  2 +-
 routes/pronoun.vue                       |  2 +-
 server/routes/banner.js                  |  2 +-
 server/routes/pronouns.js                |  2 +-
 src/{buildPronoun.js => buildPronoun.ts} | 67 ++++++++++++++----------
 src/data.js                              |  2 +-
 test/buildPronoun.test.ts                | 22 ++++----
 12 files changed, 60 insertions(+), 49 deletions(-)
 rename src/{buildPronoun.js => buildPronoun.ts} (80%)

diff --git a/components/Literature.vue b/components/Literature.vue
index 15c969a4a..a9b64d886 100644
--- a/components/Literature.vue
+++ b/components/Literature.vue
@@ -28,7 +28,7 @@
 
 <script>
 import { pronouns } from '../src/data.js';
-import { getPronoun } from '../src/buildPronoun.js';
+import { getPronoun } from '../src/buildPronoun.ts';
 
 export default {
     props: {
diff --git a/locale/pl/pronouns/EnglishTable.vue b/locale/pl/pronouns/EnglishTable.vue
index 60691186b..45f8699d7 100644
--- a/locale/pl/pronouns/EnglishTable.vue
+++ b/locale/pl/pronouns/EnglishTable.vue
@@ -48,7 +48,7 @@
 
 <script>
 import { pronouns } from '../../../src/data.js';
-import { getPronoun } from '../../../src/buildPronoun.js';
+import { getPronoun } from '../../../src/buildPronoun.ts';
 import { buildDict } from '../../../src/helpers.ts';
 
 export default {
diff --git a/locale/ru/pronouns/EnglishTable.vue b/locale/ru/pronouns/EnglishTable.vue
index 53209ba60..006001c21 100644
--- a/locale/ru/pronouns/EnglishTable.vue
+++ b/locale/ru/pronouns/EnglishTable.vue
@@ -55,7 +55,7 @@
 
 <script>
 import { pronouns } from '../../../src/data.js';
-import { getPronoun } from '../../../src/buildPronoun.js';
+import { getPronoun } from '../../../src/buildPronoun.ts';
 import { buildDict } from '../../../src/helpers.ts';
 
 export default {
diff --git a/locale/ua/pronouns/EnglishTable.vue b/locale/ua/pronouns/EnglishTable.vue
index 53209ba60..006001c21 100644
--- a/locale/ua/pronouns/EnglishTable.vue
+++ b/locale/ua/pronouns/EnglishTable.vue
@@ -55,7 +55,7 @@
 
 <script>
 import { pronouns } from '../../../src/data.js';
-import { getPronoun } from '../../../src/buildPronoun.js';
+import { getPronoun } from '../../../src/buildPronoun.ts';
 import { buildDict } from '../../../src/helpers.ts';
 
 export default {
diff --git a/plugins/mainPronoun.js b/plugins/mainPronoun.js
index ab0c3e074..7bc566454 100644
--- a/plugins/mainPronoun.js
+++ b/plugins/mainPronoun.js
@@ -1,5 +1,5 @@
 import { pronounLibrary, pronouns } from '../src/data.js';
-import { buildPronoun } from '../src/buildPronoun.js';
+import { buildPronoun } from '../src/buildPronoun.ts';
 import opinions from '../src/opinions.js';
 
 export default {
diff --git a/routes/profileEditor.vue b/routes/profileEditor.vue
index be3416bf5..b3020469a 100644
--- a/routes/profileEditor.vue
+++ b/routes/profileEditor.vue
@@ -354,7 +354,7 @@
 <script>
 import { head, buildList, buildDict, isValidLink } from '../src/helpers.ts';
 import { pronouns, pronounLibrary } from '../src/data.js';
-import { buildPronoun } from '../src/buildPronoun.js';
+import { buildPronoun } from '../src/buildPronoun.ts';
 import link from '../plugins/link.js';
 import { minBirthdate, maxBirthdate, formatDate, parseDate } from '../src/birthdate.js';
 import opinions from '../src/opinions.js';
diff --git a/routes/pronoun.vue b/routes/pronoun.vue
index b82fbea4f..2353d63a8 100644
--- a/routes/pronoun.vue
+++ b/routes/pronoun.vue
@@ -116,7 +116,7 @@
 
 <script>
 import { examples, pronouns, pronounLibrary } from '../src/data.js';
-import { buildPronoun } from '../src/buildPronoun.js';
+import { buildPronoun } from '../src/buildPronoun.ts';
 import { head } from '../src/helpers.ts';
 import GrammarTables from '../data/pronouns/GrammarTables.vue';
 import LinkedText from '../components/LinkedText.vue';
diff --git a/server/routes/banner.js b/server/routes/banner.js
index 533aa42e5..fb1dad33a 100644
--- a/server/routes/banner.js
+++ b/server/routes/banner.js
@@ -3,7 +3,7 @@ import SQL from 'sql-template-strings';
 import { createCanvas, loadImage } from 'canvas';
 import { loadSuml, loadSumlFromBase } from '../loader.ts';
 import avatar from '../avatar.ts';
-import { buildPronoun, parsePronouns } from '../../src/buildPronoun.js';
+import { buildPronoun, parsePronouns } from '../../src/buildPronoun.ts';
 import { loadTsv } from '../../src/tsv.js';
 import { handleErrorAsync } from '../../src/helpers.ts';
 import { Translator } from '../../src/translator.js';
diff --git a/server/routes/pronouns.js b/server/routes/pronouns.js
index 4cce98500..82ccb97b5 100644
--- a/server/routes/pronouns.js
+++ b/server/routes/pronouns.js
@@ -1,6 +1,6 @@
 import { Router } from 'express';
 import { loadSuml, loadSumlFromBase, loadTsv } from '../loader.ts';
-import { buildPronoun, parsePronouns } from '../../src/buildPronoun.js';
+import { buildPronoun, parsePronouns } from '../../src/buildPronoun.ts';
 import { buildList, handleErrorAsync } from '../../src/helpers.ts';
 import { Example } from '../../src/classes.ts';
 import { caches } from '../../src/cache.js';
diff --git a/src/buildPronoun.js b/src/buildPronoun.ts
similarity index 80%
rename from src/buildPronoun.js
rename to src/buildPronoun.ts
index f58bf169b..cdbfd7781 100644
--- a/src/buildPronoun.js
+++ b/src/buildPronoun.ts
@@ -2,29 +2,28 @@ import { Pronoun } from './classes.ts';
 import Compressor from './compressor.js';
 import { buildDict, isEmoji, unescapeControlSymbols } from './helpers.ts';
 import MORPHEMES from '../data/pronouns/morphemes.js';
+import type { Config, NullPronounsConfig } from '../locale/config.ts';
+import type { Translator } from './translator.js';
 
-export const addAliasesToPronouns = (pronouns) => {
-    const pronounsWithAliases = {};
-    for (const base in pronouns) {
-        if (pronouns.hasOwnProperty(base)) {
-            const pronoun = pronouns[base];
-            pronounsWithAliases[base] = pronoun;
-            for (const alias of pronoun.aliases) {
-                pronounsWithAliases[alias] = pronoun;
-            }
+export const addAliasesToPronouns = (pronouns: Record<string, Pronoun>): Record<string, Pronoun> => {
+    const pronounsWithAliases: Record<string, Pronoun> = {};
+    for (const [base, pronoun] of Object.entries(pronouns)) {
+        pronounsWithAliases[base] = pronoun;
+        for (const alias of pronoun.aliases) {
+            pronounsWithAliases[alias] = pronoun;
         }
     }
     return pronounsWithAliases;
 };
 
-export const getPronoun = (pronouns, id) => {
+export const getPronoun = (pronouns: Record<string, Pronoun>, id: string): Pronoun | undefined => {
     return addAliasesToPronouns(pronouns)[id];
 };
 
 const conditionalKeyPlaceHolder = /#\/([^/]+)\/(\w+)?#/;
 const unconditionalKeyPlaceholder = /#/g;
 
-const buildMorphemeFromTemplate = (key, template) => {
+const buildMorphemeFromTemplate = (key: string, template: string): string => {
     const variants = template.split('|');
     for (const variant of variants) {
         const conditionalMatch = variant.match(conditionalKeyPlaceHolder);
@@ -36,9 +35,20 @@ const buildMorphemeFromTemplate = (key, template) => {
             return variant.replace(unconditionalKeyPlaceholder, key);
         }
     }
+    return template;
 };
 
-const buildPronounFromTemplate = (key, template) => {
+interface PronounTemplate {
+    description: string;
+    normative?: boolean;
+    morphemes: Record<string, string>;
+    plural?: boolean;
+    pluralHonorific?: boolean;
+    aliases?: string[];
+    history?: string;
+}
+
+const buildPronounFromTemplate = (key: string, template: PronounTemplate): Pronoun => {
     return new Pronoun(
         key,
         template.description,
@@ -56,12 +66,12 @@ const buildPronounFromTemplate = (key, template) => {
     );
 };
 
-const isModifier = (chunk, key, translator) => {
+const isModifier = (chunk: string, key: string, translator: Translator): boolean => {
     // use both locale and base translations to ensure backwards compatibility if key gets translated
     return chunk === `:${translator.translate(key)}` || chunk === `:${translator.get(key, false, true)}`;
 };
 
-const extractModifierValue = (chunk, key, translator) => {
+const extractModifierValue = (chunk: string, key: string, translator: Translator): string | null => {
     // use both locale and base translations to ensure backwards compatibility if key gets translated
     const prefixes = [`:${translator.translate(key)}=`, `:${translator.get(key, false, true)}=`];
     for (const prefix of prefixes) {
@@ -72,12 +82,12 @@ const extractModifierValue = (chunk, key, translator) => {
     return null;
 };
 
-const buildPronounFromSlashes = (config, path, translator) => {
+const buildPronounFromSlashes = (config: Config, path: string, translator: Translator): Pronoun | null => {
     const chunks = path.split(/(?<!`)\//);
     let plural = false;
     let pluralHonorific = false;
     let description = '';
-    const morphemeChunks = [];
+    const morphemeChunks: (string | null)[] = [];
     for (const chunk of chunks) {
         if (chunk.startsWith(':')) {
             if (config.pronouns.plurals && isModifier(chunk, 'pronouns.slashes.plural', translator)) {
@@ -89,7 +99,7 @@ const buildPronounFromSlashes = (config, path, translator) => {
                 const descriptionModifierValue =
                     extractModifierValue(chunk, 'pronouns.slashes.description', translator);
                 if (descriptionModifierValue) {
-                    description = unescapeControlSymbols(descriptionModifierValue);
+                    description = unescapeControlSymbols(descriptionModifierValue)!;
                 }
             }
         } else {
@@ -126,15 +136,19 @@ const buildPronounFromSlashes = (config, path, translator) => {
             false,
         );
     }
+    return null;
 };
 
-export const buildPronoun = (pronouns, path, translator) => {
-    if (!path) {
+export const buildPronoun = (
+    pronouns: Record<string, Pronoun>,
+    path: string,
+    translator: Translator,
+): Pronoun | null => {
+    const config = global.config || process.env.CONFIG;
+    if (!path || !config.pronouns.enabled) {
         return null;
     }
 
-    const config = global.config || process.env.CONFIG;
-
     for (const prefix of config.pronouns.sentence ? config.pronouns.sentence.prefixes : []) {
         if (`/${path}`.startsWith(`${prefix}/`)) {
             path = path.substring(prefix.length);
@@ -159,7 +173,7 @@ export const buildPronoun = (pronouns, path, translator) => {
     const pronounStrLen = pronounStr.map((x) => x.startsWith('!') ? parseInt(x.substring(1)) : 1).reduce((c, a) => c + a, 0);
     if (config.locale === 'pl' && baseArray && pronounStrLen < 31) {
         baseArray.splice(baseArray.length - 10, 1);
-        if (pronounStr < 30) {
+        if (pronounStrLen < 30) {
             baseArray = [
                 ...baseArray.slice(0, 4),
                 baseArray[5],
@@ -183,16 +197,13 @@ export const buildPronoun = (pronouns, path, translator) => {
         ? base
         : Pronoun.from(Compressor.uncompress(pronounStr, baseArray, config.locale));
 
-    if (!config) {
-        return pronoun;
-    }
-
     if (!pronoun && config.pronouns.emoji !== false && isEmoji(path)) {
         pronoun = buildPronounFromTemplate(path, config.pronouns.emoji);
     }
 
     if (!pronoun && config.pronouns.null && config.pronouns.null.morphemes && path.startsWith(':') && path.length < 12) {
-        pronoun = buildPronounFromTemplate(path.substring(1), config.pronouns.null);
+        const template = config.pronouns.null as NullPronounsConfig & { morphemes: Record<string, string> };
+        pronoun = buildPronounFromTemplate(path.substring(1), template);
     }
 
     if (!pronoun && config.pronouns.slashes !== false) {
@@ -202,7 +213,7 @@ export const buildPronoun = (pronouns, path, translator) => {
     return pronoun;
 };
 
-export const parsePronouns = (pronounsRaw) => {
+export const parsePronouns = (pronounsRaw: Record<string, any>[]): Record<string, Pronoun> => {
     return buildDict(function* () {
         for (const t of pronounsRaw) {
             const aliases = t.key.replace(/،/g, ',').split(',');
diff --git a/src/data.js b/src/data.js
index 860e6b2bc..caf6f11c0 100644
--- a/src/data.js
+++ b/src/data.js
@@ -1,6 +1,6 @@
 import { Example, NounTemplate, PronounGroup, PronounLibrary, Person, NounDeclension } from './classes.ts';
 import { buildDict, buildList } from './helpers.ts';
-import { parsePronouns } from './buildPronoun.js';
+import { parsePronouns } from './buildPronoun.ts';
 
 import pronounsRaw from '../data/pronouns/pronouns.tsv';
 export const pronouns = parsePronouns(pronounsRaw);
diff --git a/test/buildPronoun.test.ts b/test/buildPronoun.test.ts
index 0b41d66a9..b33bd1a33 100644
--- a/test/buildPronoun.test.ts
+++ b/test/buildPronoun.test.ts
@@ -21,7 +21,7 @@ jest.unstable_mockModule('../data/pronouns/morphemes.js', () => {
 });
 
 const { Pronoun } = await import('../src/classes.ts');
-const { buildPronoun } = await import('../src/buildPronoun.js');
+const { buildPronoun } = await import('../src/buildPronoun.ts');
 const { default: pronouns, generated: generatedPronouns } = await import('./fixtures/pronouns.ts');
 
 beforeEach(() => {
@@ -135,7 +135,7 @@ describe('when configured that null pronouns are available', () => {
         ));
     });
     test('builds nothing if name too long', () => {
-        expect(buildPronoun(pronouns, ':Abcdefghijklmnopqrstuvwxyz', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, ':Abcdefghijklmnopqrstuvwxyz', translator)).toBeNull();
     });
 
     describe('with conditional placeholders', () => {
@@ -144,10 +144,10 @@ describe('when configured that null pronouns are available', () => {
         });
 
         test.each(['S', 'Ringelnatz', 'Max', 'X'])('builds morpheme conditionally if name matches', (name) => {
-            expect(buildPronoun(pronouns, `:${name}`, translator).morphemes.possessive_pronoun).toBe(`${name}’`);
+            expect(buildPronoun(pronouns, `:${name}`, translator)!.morphemes.possessive_pronoun).toBe(`${name}’`);
         });
         test.each(['Sofi', 'Xavier'])('builds morpheme by default if name does not match', (name) => {
-            expect(buildPronoun(pronouns, `:${name}`, translator).morphemes.possessive_pronoun).toBe(`${name}s`);
+            expect(buildPronoun(pronouns, `:${name}`, translator)!.morphemes.possessive_pronoun).toBe(`${name}s`);
         });
     });
 
@@ -244,10 +244,10 @@ describe('when configured that slashes contain all morphemes', () => {
         actual.toEqual(generatedPronouns.aerWithUnsetPossessivePronoun);
     });
     test('builds nothing if morphemes are missing', () => {
-        expect(buildPronoun(pronouns, 'ae/aer/aer/aerself', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 'ae/aer/aer/aerself', translator)).toBeNull();
     });
     test('builds nothing if too many morphemes are given', () => {
-        expect(buildPronoun(pronouns, 'ae/aer/aer/aers/aerself/aer', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 'ae/aer/aer/aers/aerself/aer', translator)).toBeNull();
     });
     test('builds nothing if description too long', () => {
         expect(buildPronoun(
@@ -268,10 +268,10 @@ describe('when configured that slashes contain some morphemes', () => {
         actual.toEqual(generatedPronouns.aerWithUnsetPossessivePronoun);
     });
     test('builds nothing if morphemes are missing', () => {
-        expect(buildPronoun(pronouns, 'ae/aer/aer', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 'ae/aer/aer', translator)).toBeNull();
     });
     test('builds nothing if too many morphemes are given', () => {
-        expect(buildPronoun(pronouns, 'ae/aer/aer/aers/aerself', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 'ae/aer/aer/aers/aerself', translator)).toBeNull();
     });
 });
 describe('when configured that slashes cannot contain morphemes', () => {
@@ -321,13 +321,13 @@ describe('building generated pronouns from commas', () => {
         ));
     });
     test('fails when too few parts are given', () => {
-        expect(buildPronoun(pronouns, 'ae, translator,aer,aer,aers,aerself', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 'ae, translator,aer,aer,aers,aerself', translator)).toBeNull();
     });
     test('fails when many few parts are given', () => {
-        expect(buildPronoun(pronouns, 'ae, translator,aer,aer,aers,aerself,aersing,0,', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 'ae, translator,aer,aer,aers,aerself,aersing,0,', translator)).toBeNull();
     });
     test('fails when base pronoun is unknown', () => {
-        expect(buildPronoun(pronouns, 's/he, translator,!2,aers,!2,', translator)).toBeUndefined();
+        expect(buildPronoun(pronouns, 's/he, translator,!2,aers,!2,', translator)).toBeNull();
     });
 });