Merge pull request #2797 from specify/issue-2420

Make interaction table's name dynamic

Author: grantfitzsimmons

specifyweb/frontend/js_src/lib/components/FormCommands/ShowTransactions.tsx

@@ -15,6 +15,7 @@ import { useAsyncState } from '../../hooks/useAsyncState';
 import { AnySchema } from '../DataModel/helperTypes';
 import { Preparation } from '../DataModel/types';
 import { interactionsText } from '../../localization/interactions';
+import { schema } from '../DataModel/schema';
 
 function List({
   resources,
@@ -104,27 +105,44 @@ export function ShowLoansCommand({
       header={commonText.transactions()}
       onClose={handleClose}
     >
-      <H3>{interactionsText.openLoans()}</H3>
+      <H3>
+        {interactionsText.openLoans({
+          loanTable: schema.models.Loan.label,
+        })}
+      </H3>
       <List
         displayFieldName="loanNumber"
         fieldName="loan"
         resources={data.openLoans ?? []}
       />
-      <H3>{interactionsText.resolvedLoans()}</H3>
+      <H3>
+        {interactionsText.resolvedLoans({
+          loanTable: schema.models.Loan.label,
+        })}
+      </H3>
       <List
         displayFieldName="loanNumber"
         fieldName="loan"
         resources={data.resolvedLoans ?? []}
       />
-      <H3>{interactionsText.gifts()}</H3>
+      <H3>
+        {interactionsText.gifts({
+          giftTable: schema.models.Gift.label,
+        })}
+      </H3>
       <List
         displayFieldName="giftNumber"
         fieldName="gift"
         resources={data.gifts ?? []}
       />
       {Array.isArray(data.exchanges) && data.exchanges.length > 0 && (
         <>
-          <H3>{interactionsText.exchanges()}</H3>
+          <H3>
+            {interactionsText.exchanges({
+              exhangeInTable: schema.models.ExchangeIn.label,
+              exhangeOutTable: schema.models.ExchangeOut.label,
+            })}
+          </H3>
           <List
             displayFieldName="exchangeOutNumber"
             fieldName="exchange"

specifyweb/frontend/js_src/lib/components/Interactions/InteractionDialog.tsx

@@ -49,6 +49,7 @@ import {
   resolveParser,
 } from '../../utils/parser/definitions';
 import { interactionsText } from '../../localization/interactions';
+import { schema } from '../DataModel/schema';
 
 export function InteractionDialog({
   recordSetsPromise,
@@ -197,10 +198,15 @@ export function InteractionDialog({
   return state.type === 'LoanReturnDoneState' ? (
     <Dialog
       buttons={commonText.close()}
-      header={interactionsText.returnedPreparations()}
+      header={interactionsText.returnedPreparations({
+        tablePreparation: schema.models.Preparation.label,
+      })}
       onClose={handleClose}
     >
-      {interactionsText.returnedAndSaved({ count: state.result })}
+      {interactionsText.returnedAndSaved({
+        count: state.result,
+        tablePreparation: schema.models.Preparation.label,
+      })}
     </Dialog>
   ) : state.type === 'PreparationSelectState' &&
     Object.keys(state.problems).length === 0 ? (

specifyweb/frontend/js_src/lib/components/Interactions/InteractionsDialog.tsx

@@ -88,19 +88,37 @@ const supportedActions = [
 /**
  * Remap Specify 6 UI localization strings to Specify 7 UI localization strings
  */
-const stringLocalization = {
-  RET_LOAN: interactionsText.returnLoan(),
+const stringLocalization = f.store(() => ({
+  RET_LOAN: interactionsText.returnLoan({
+    tableLoan: schema.models.Loan.label,
+  }),
   PRINT_INVOICE: interactionsText.printInvoice(),
-  LOAN_NO_PRP: interactionsText.loanWithoutPreparation(),
+  LOAN_NO_PRP: interactionsText.loanWithoutPreparation({
+    tableLoan: schema.models.Loan.label,
+    tablePreparation: schema.models.Preparation.label,
+  }),
   'InteractionsTask.LN_NO_PREP':
-    interactionsText.loanWithoutPreparationDescription(),
-  'InteractionsTask.NEW_LN': interactionsText.createLoan(),
-  'InteractionsTask.EDT_LN': interactionsText.editLoan(),
-  'InteractionsTask.NEW_GFT': interactionsText.createdGift(),
-  'InteractionsTask.EDT_GFT': interactionsText.editGift(),
-  'InteractionsTask.CRE_IR': interactionsText.createInformationRequest(),
+    interactionsText.loanWithoutPreparationDescription({
+      tableLoan: schema.models.Loan.label,
+      tablePreparation: schema.models.Preparation.label,
+    }),
+  'InteractionsTask.NEW_LN': interactionsText.createLoan({
+    tableLoan: schema.models.Loan.label,
+  }),
+  'InteractionsTask.EDT_LN': interactionsText.editLoan({
+    tableLoan: schema.models.Loan.label,
+  }),
+  'InteractionsTask.NEW_GFT': interactionsText.createdGift({
+    tableGift: schema.models.Gift.label,
+  }),
+  'InteractionsTask.EDT_GFT': interactionsText.editGift({
+    tableGift: schema.models.Gift.label,
+  }),
+  'InteractionsTask.CRE_IR': interactionsText.createInformationRequest({
+    tableInformationRequest: schema.models.InfoRequest.label,
+  }),
   'InteractionsTask.PRT_INV': interactionsText.printInvoice(),
-};
+}));
 
 export type InteractionEntry = {
   readonly action: typeof supportedActions[number] | undefined;
@@ -240,8 +258,8 @@ function Interactions({
                 key={index}
                 title={
                   typeof tooltip === 'string'
-                    ? stringLocalization[
-                        tooltip as keyof typeof stringLocalization
+                    ? stringLocalization()[
+                        tooltip as keyof ReturnType<typeof stringLocalization>
                       ] ?? tooltip
                     : undefined
                 }
@@ -265,8 +283,8 @@ function Interactions({
                     <TableIcon label={false} name={icon} />
                   ))}
                   {typeof label === 'string'
-                    ? stringLocalization[
-                        label as keyof typeof stringLocalization
+                    ? stringLocalization()[
+                        label as keyof ReturnType<typeof stringLocalization>
                       ] ?? label
                     : typeof table === 'string'
                     ? getModel(table)?.label

specifyweb/frontend/js_src/lib/components/QueryBuilder/LoanReturn.tsx

@@ -146,7 +146,9 @@ export function QueryLoanReturn({
           })
         }
       >
-        {interactionsText.returnLoan()}
+        {interactionsText.returnLoan({
+          tableLoan: schema.models.Loan.label,
+        })}
       </QueryButton>
       {state.type === 'Dialog' && Array.isArray(toReturn) ? (
         <Dialog

specifyweb/frontend/js_src/lib/localization/interactions.ts

@@ -188,39 +188,27 @@ export const interactionsText = createDictionary({
   },
   prepReturnFormatter: {
     comment: 'Used to format preparations in the prep return dialog',
-    'en-us': '{tableName:string}: {resource: string}',
-    'ru-ru': '{tableName:string}: {resource: string}',
-    'es-es': '{tableName:string}: {resource: string}',
-    'fr-fr': '{tableName : chaîne} : {ressource : chaîne}',
-    'uk-ua': '{tableName:string}: {ресурс: string}',
+    'en-us': '{tableName:string}: {resource:string}',
+    'ru-ru': '{tableName:string}: {resource:string}',
+    'es-es': '{tableName:string}: {resource:string}',
+    'fr-fr': '{tableName:chaîne}: {ressource:chaîne}',
+    'uk-ua': '{tableName:string}: {resource:string}',
   },
   resolvedLoans: {
-    'en-us': 'Resolved Loans',
-    'ru-ru': 'Решение Заемы',
-    'es-es': 'Préstamos Resueltos',
-    'fr-fr': 'Prêts résolus',
-    'uk-ua': 'Вирішені позики',
+    comment: 'Example: Resolved Loan records',
+    'en-us': 'Resolved {loanTable:string} records',
   },
   openLoans: {
-    'en-us': 'Open Loans',
-    'ru-ru': 'Открытые займы',
-    'es-es': 'Préstamos abiertos',
-    'fr-fr': 'Prêts ouverts',
-    'uk-ua': 'Відкриті кредити',
+    comment: 'Example: Open Loan records',
+    'en-us': 'Open {loanTable:string} records',
   },
   gifts: {
-    'en-us': 'Gifts',
-    'ru-ru': 'Подарки',
-    'es-es': 'Regalos',
-    'fr-fr': 'Cadeaux',
-    'uk-ua': 'Подарунки',
-  },
-  exchanges: {
-    'en-us': 'Exchanges',
-    'ru-ru': 'Обмены',
-    'es-es': 'Intercambios',
-    'fr-fr': 'Échanges',
-    'uk-ua': 'Обміни',
+    comment: 'Example: Gift records',
+    'en-us': '{giftTable:string} records',
+  },
+  exchanges: {    
+    comment: 'Example: Exchange In / Exchnage Out records',
+    'en-us': '{exhangeInTable:string} / {exhangeOutTable:string} records',
   },
   unCataloged: {
     'en-us': 'uncataloged',
@@ -230,23 +218,13 @@ export const interactionsText = createDictionary({
     'uk-ua': 'некаталогований',
   },
   returnedPreparations: {
-    'en-us': 'Returned Preparations',
-    'ru-ru': 'Возвращенные препараты',
-    'es-es': 'Preparaciones devueltas',
-    'fr-fr': 'Préparations retournées',
-    'uk-ua': 'Повернені препарати',
+    comment: 'Example: Preparation records',
+    'en-us': 'Returned {tablePreparation:string} records',
   },
   returnedAndSaved: {
+    comment: 'Example: 2 Preparation records have been returned and saved',
     'en-us':
-      '{count:number|formatted} preparations have been returned and saved.',
-    'ru-ru': '{count:number|formatted} препарата возвращены и сохранены.',
-    'es-es':
-      '{count:number|formatted} los preparativos se han devuelto y guardado.',
-    'fr-fr': `
-      Les préparations {count:number|formatted} ont été renvoyées et
-      enregistrées.
-    `,
-    'uk-ua': 'Препарати {count:number|formatted} повернуто та збережено.',
+      '{count:number|formatted} {tablePreparation:string} records have been returned and saved',
   },
   deselectAll: {
     'en-us': 'Deselect all',
@@ -270,11 +248,8 @@ export const interactionsText = createDictionary({
     'uk-ua': 'Недоступний',
   },
   returnLoan: {
-    'en-us': 'Return Loan',
-    'ru-ru': 'Возврат Заема',
-    'es-es': 'Préstamo de devolución',
-    'fr-fr': 'Prêt de retour',
-    'uk-ua': 'Повернення кредиту',
+    comment: 'Example: Return Loan records',
+    'en-us': 'Return {tableLoan:string} records',
   },
   printInvoice: {
     'en-us': 'Print Invoice',
@@ -284,52 +259,31 @@ export const interactionsText = createDictionary({
     'uk-ua': 'Роздрукувати рахунок-фактуру',
   },
   loanWithoutPreparation: {
-    'en-us': 'Loan w/o Preps',
-    'ru-ru': 'Заем без Препаратов',
-    'es-es': 'Préstamo sin preparación',
-    'fr-fr': 'Prêt sans préparation',
-    'uk-ua': 'Позика без підготовки',
+    comment: 'Example: Loan records w/o Preparation records',
+    'en-us': '{tableLoan:string} w/o {tablePreparation:string} records',
   },
   loanWithoutPreparationDescription: {
-    'en-us': 'Create a loan with no preparations',
-    'ru-ru': 'Создать Заем без препаратов',
-    'es-es': 'Crear un préstamo sin preparativos',
-    'fr-fr': 'Créer un prêt sans préparation',
-    'uk-ua': 'Оформіть позику без підготовки',
+    comment: 'Example: Create a Loan records with no Preparation records',
+    'en-us': 'Create a {tableLoan:string} with no {tablePreparation:string} records',
   },
   createLoan: {
-    'en-us': 'Create a Loan',
-    'ru-ru': 'Создать Заем',
-    'es-es': 'Crear un préstamo',
-    'fr-fr': 'Créer un prêt',
-    'uk-ua': 'Створіть позику',
+    comment: 'Example: Create a Loan',
+    'en-us': 'Create a {tableLoan:string}',
   },
   editLoan: {
-    'en-us': 'Edit Loan',
-    'ru-ru': 'Редактировать Заем',
-    'es-es': 'Editar préstamo',
-    'fr-fr': 'Modifier le prêt',
-    'uk-ua': 'Редагувати кредит',
+    comment: 'Example: Edit a Loan',
+    'en-us': 'Edit {tableLoan:string}',
   },
   createdGift: {
-    'en-us': 'Create a Gift',
-    'ru-ru': 'Создать Дар',
-    'es-es': 'Crear un regalo',
-    'fr-fr': 'Créer un cadeau',
-    'uk-ua': 'Створіть подарунок',
+    comment: 'Example: Create a Gift',
+    'en-us': 'Create a {tableGift:string}',
   },
   editGift: {
-    'en-us': 'Edit Gift',
-    'ru-ru': 'Редактировать Дар',
-    'es-es': 'Editar regalo',
-    'fr-fr': 'Modifier le cadeau',
-    'uk-ua': 'Редагувати подарунок',
+    comment: 'Example: Edit a Gift',
+    'en-us': 'Edit {tableGift:string}',
   },
   createInformationRequest: {
-    'en-us': 'Create Information Request',
-    'ru-ru': 'Создать Экспресс Запрос',
-    'es-es': 'Crear solicitud de información',
-    'fr-fr': "Créer une demande d'informations",
-    'uk-ua': 'Створити інформаційний запит',
+    comment: 'Example: Create a Infrormation Request',
+    'en-us': 'Create {tableInformationRequest:string}',
   },
 } as const);