Move custom text in README.md, bug fixes

Author: faisalnjs

README.md

@@ -60,70 +60,7 @@ commtrackr.init({ // Initialize CommTracker with configurations
     },
     stylesheets: [], // Additional stylesheets to include
     scripts: [], // Additional scripts to include
-    customText: { // Custom text overrides for the tenant
-      userWelcomeBefore: 'Welcome, ',
-      userWelcomeAfter: '!',
-      activationTitle: 'Activation',
-      sessionTitle: 'Session',
-      tenantTitle: 'Configuration',
-      authTitle: 'Authenticate',
-      adminTitle: 'Admin View',
-      adminDescription: 'Manage commissions created on your platform.',
-      devTitle: 'Developer View',
-      devDescription: 'Manage commissions assigned to you.',
-      userTitle: 'Commissions',
-      userDescription: 'View and manage your past commissions.',
-      newCommissionTitle: 'New Commission',
-      newTaskLabel: 'New Task',
-      notFoundTitle: 'Not Found',
-      forbiddenTitle: 'Forbidden',
-      errorTitle: 'Error',
-      labelStatus: 'Status',
-      labelOwner: 'Owner',
-      labelAmount: 'Amount',
-      labelDate: 'Date',
-      labelAssignedTo: 'Assigned To',
-      labelCurrency: 'Currency',
-      labelLocked: 'Locked',
-      labelTasks: 'Tasks',
-      labelSendEmail: 'Send Email',
-      labelRequired: 'Required',
-      labelOptional: 'Optional',
-      youLabel: '(you)',
-      noneLabel: 'None',
-      backLabel: 'Back',
-      nextLabel: 'Next',
-      startLabel: 'Start',
-      createLabel: 'Create',
-      returnLabel: 'Return',
-      restartLabel: 'Restart',
-      saveLabel: 'Save',
-      syncLabel: 'Sync',
-      backToLabel: 'Back to ',
-      changesSaved: 'Changes saved',
-      changesRestored: 'Changes restored',
-      clearChanges: 'Clear changes',
-      brandName: 'CommTrackr',
-      createEstimatedTime: 'Estimated time to complete: 2 minutes',
-      commissionNotFound: 'The requested commission was not found.',
-      commissionLocked: 'This commission is locked from user editing.',
-      forbiddenMessage: 'You do not have permission to edit this commission.',
-      resourceNotFound: 'The requested resource was not found.',
-      offTitle: 'CommTrackr Disabled',
-      offDescription: 'Enable CommTrackr for your app using <code>commtrackr.on();</code>',
-      tenantMisconfiguredTitle: 'Tenant Misconfigured',
-      tenantMisconfiguredDescription: 'Configure your CommTrackr tenant using <code>commtrackr.init({ tenant: { ... } });</code>',
-      serviceOffline: 'Service is currently offline.',
-      noSession: 'No session found. Please enable cookies and try again.',
-      userNotAuthenticated: 'User not authenticated. Please log in and try again.',
-      serviceNotConfigured: 'Service is not properly configured. Please contact the administrator.',
-      noFieldsConfigured: 'No fields configured for commission creation. Please contact the administrator.',
-      createSuccess: 'Your commission was created successfully.',
-      syncSuccess: 'Your commissions were synchronized successfully.',
-      updateSuccess: 'Your commission was updated successfully.',
-      commissionNotFoundJson: 'The requested commission was not found.',
-      forbiddenJson: 'You do not have permission to edit this commission.'
-    },
+    customText: {} // Custom text overrides for the tenant; see "Custom Text" section below
   },
   vars: {
     userId: 'username', // req.session object variable for unique user identification
@@ -342,3 +279,87 @@ Default:
 Type: `Array`
 
 Default: `'users'`
+
+## Custom Text
+
+The tenant `customText` configuration allows you to override default text strings used throughout the CommTrackr interface. This is useful for localization or customizing the user experience. The available text strings are as follows:
+
+```json
+{
+  userWelcomeBefore: 'Welcome, ',
+  userWelcomeAfter: '!',
+  activationTitle: 'Activation',
+  sessionTitle: 'Session',
+  tenantTitle: 'Configuration',
+  authTitle: 'Authentication Required',
+  authDescriptionBefore: 'You\'ll need to log into your ',
+  authDescriptionAfter: ' account before managing your commissions.',
+  authContinueLabel: 'Continue',
+  adminTitle: 'Commission Management',
+  adminDescription: 'Manage commissions created on your platform.',
+  devTitle: 'Commission Management',
+  devDescription: 'Manage commissions assigned to you.',
+  userTitle: 'Commissions',
+  userDescription: 'View and manage your past commissions.',
+  newCommissionTitle: 'New Commission',
+  newTaskLabel: 'New Task',
+  notFoundTitle: 'Not Found',
+  forbiddenTitle: 'Forbidden',
+  errorTitle: 'Error',
+  errorMessage: 'An unexpected error occurred. Please try again later.',
+  labelStatus: 'Status',
+  labelStatusDescription: 'Required: Commission status.',
+  labelOwner: 'Owner',
+  labelOwnerDescription: 'Required: Commission owner.',
+  labelAmount: 'Amount',
+  labelAmountDescription: 'Optional: Commission amount.',
+  labelDate: 'Date',
+  labelDateDescription: 'Optional: Commission creation date.',
+  labelAssignedTo: 'Assigned To',
+  labelAssignedToDescription: 'Optional: The developer to assign this commission to.',
+  labelCurrency: 'Currency',
+  labelCurrencyDescription: 'Optional: Commission currency.',
+  labelLocked: 'Locked',
+  labelLockedDescription: 'Optional: Whether or not the commission is locked from user editing.',
+  labelTasks: 'Tasks',
+  labelSendEmail: 'Send Email',
+  labelSendEmailDescription: 'Optional: Send an email to the user regarding this update.',
+  labelRequired: 'Required',
+  labelOptional: 'Optional',
+  youLabel: '(you)',
+  noneLabel: 'None',
+  backLabel: 'Back',
+  backLabelWithArrow: '← Back',
+  nextLabel: 'Next',
+  startLabel: 'Start',
+  createLabel: 'Create',
+  returnLabel: 'Return',
+  restartLabel: 'Restart',
+  saveLabel: 'Save',
+  syncLabel: 'Sync',
+  backToLabel: 'Back to ',
+  changesSaved: 'Changes saved',
+  changesRestored: 'Changes restored',
+  clearChanges: 'Clear changes',
+  brandName: 'CommTrackr',
+  createEstimatedTime: 'Estimated time to complete: 2 minutes',
+  commissionNotFound: 'The requested commission was not found.',
+  commissionLocked: 'This commission is locked from user editing.',
+  forbiddenMessage: 'You do not have permission to edit this commission.',
+  resourceNotFound: 'The requested resource was not found.',
+  offTitle: 'CommTrackr Disabled',
+  offDescription: 'Enable CommTrackr for your app using <code>commtrackr.on();</code>',
+  tenantMisconfiguredTitle: 'Tenant Misconfigured',
+  tenantMisconfiguredDescription: 'Configure your CommTrackr tenant using <code>commtrackr.init({ tenant: { ... } });</code>',
+  serviceOffline: 'Service is currently offline.',
+  noSession: 'No session found. Please enable cookies and try again.',
+  userNotAuthenticated: 'User not authenticated. Please log in and try again.',
+  serviceNotConfigured: 'Service is not properly configured. Please contact the administrator.',
+  noFieldsConfigured: 'No fields configured for commission creation. Please contact the administrator.',
+  createSuccess: 'Your commission was created successfully.',
+  syncSuccess: 'Your commissions were synchronized successfully.',
+  updateSuccess: 'Your commission was updated successfully.',
+  commissionNotFoundJson: 'The requested commission was not found.',
+  forbiddenMessage: 'You do not have permission to edit this commission.'
+}
+```

frontend/pages/auth.ejs

@@ -1,7 +1,7 @@
 <%- include('head.ejs') %>
 <img src="<%= tenant.logo %>" alt="<%= tenant.name %>">
 <h1><%= tenant.customText?.authTitle %></h1>
-<p><%= tenant.customText?.authDescription %></p>
+<p><%= tenant.customText?.authDescriptionBefore + (tenant.auth.provider || tenant.name) + tenant.customText?.authDescriptionAfter %></p>
 <% if (tenant.auth.url) { %>
 <div class="buttons">
 	<div href="<%= tenant.auth.url %>" class="button"><%= tenant.customText?.authContinueLabel %></div>

frontend/pages/foot.ejs

@@ -3,7 +3,7 @@
     <p class="fixed">© <%= new Date().getFullYear() %> <%= tenant.customText?.brandName %></p>
     <p class="fixed2"><%= tenant.customText?.changesSaved %></p>
     <p class="fixed3"><%= tenant.customText?.changesRestored %></p>
-    <p class="fixed4"><%= tenant.customText?.backArrow %></p>
+    <p class="fixed4"><%= tenant.customText?.backLabelWithArrow %></p>
     <p class="fixed5"><%= tenant.customText?.clearChanges %></p>
         <% } else { %>
         <p class="fixed">Internal error</p>

frontend/pages/user.ejs

@@ -2,18 +2,18 @@
 <img src="<%= tenant.logo %>" alt="<%= tenant.name %>">
 <h1>
 	<% if (tenant.auth && tenant.auth.enabled) { %>
-	<%= (tenant.customText && tenant.customText.userWelcomeBefore ? tenant.customText.userWelcomeBefore : 'Welcome, ') %><%= session[vars.userName] || session[vars.userId] %><%= (tenant.customText && tenant.customText.userWelcomeAfter ? tenant.customText.userWelcomeAfter : '!') %>
+	<%= tenant.customText?.userWelcomeBefore %><%= session[vars.userName] || session[vars.userId] %><%= tenant.customText?.userWelcomeAfter %>
 	<% } else { %>
-	<%= tenant.name %> <%= tenant.customText && tenant.customText.userTitle ? tenant.customText.userTitle : 'Commissions' %>
+	<%= tenant.name %> <%= tenant.customText?.userTitle %>
 	<% } %>
 </h1>
-<p><%= tenant.customText && tenant.customText.userDescription ? tenant.customText.userDescription : 'View and manage your past commissions.' %></p>
+<p><%= tenant.customText?.userDescription %></p>
 <div class="buttons">
-	<a class="button" href="<%= tenant.domain %><%= tenant.path %>/create"><%= tenant.customText && tenant.customText.newCommissionTitle ? tenant.customText.newCommissionTitle : 'New Commission' %></a>
+	<a class="button" href="<%= tenant.domain %><%= tenant.path %>/create"><%= tenant.customText?.newCommissionTitle %></a>
 	<div id="sync" class="button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 23 23" fill="none">
 			<path d="M18.5949 5.16663C16.8618 3.32009 14.3989 2.16663 11.6666 2.16663C6.41992 2.16663 2.16663 6.41992 2.16663 11.6666C2.16663 16.9133 6.41992 21.1666 11.6666 21.1666C14.3989 21.1666 16.8618 20.0132 18.5949 18.1666M17.3236 7.98035L20.9804 7.98035L20.9804 4.3235" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" />
-		</svg> <%= tenant.customText && tenant.customText.syncLabel ? tenant.customText.syncLabel : 'Sync' %></div>
-	<a class="button" href="<%= tenant.domain %>"><%= (tenant.customText && tenant.customText.backToLabel ? tenant.customText.backToLabel : 'Back to ') + tenant.name %></a>
+		</svg> <%= tenant.customText?.syncLabel %></div>
+	<a class="button" href="<%= tenant.domain %>"><%= tenant.customText?.backToLabel + tenant.name %></a>
 </div>
 <div class="commissions">
 	<% session[vars.commissions].forEach(commission => { %>

index.js

@@ -36,6 +36,9 @@ const customText = {
   sessionTitle: 'Session',
   tenantTitle: 'Configuration',
   authTitle: 'Authentication Required',
+  authDescriptionBefore: 'You\'ll need to log into your ',
+  authDescriptionAfter: ' account before managing your commissions.',
+  authContinueLabel: 'Continue',
   adminTitle: 'Commission Management',
   adminDescription: 'Manage commissions created on your platform.',
   devTitle: 'Commission Management',
@@ -47,20 +50,30 @@ const customText = {
   notFoundTitle: 'Not Found',
   forbiddenTitle: 'Forbidden',
   errorTitle: 'Error',
+  errorMessage: 'An unexpected error occurred. Please try again later.',
   labelStatus: 'Status',
+  labelStatusDescription: 'Required: Commission status.',
   labelOwner: 'Owner',
+  labelOwnerDescription: 'Required: Commission owner.',
   labelAmount: 'Amount',
+  labelAmountDescription: 'Optional: Commission amount.',
   labelDate: 'Date',
+  labelDateDescription: 'Optional: Commission creation date.',
   labelAssignedTo: 'Assigned To',
+  labelAssignedToDescription: 'Optional: The developer to assign this commission to.',
   labelCurrency: 'Currency',
+  labelCurrencyDescription: 'Optional: Commission currency.',
   labelLocked: 'Locked',
+  labelLockedDescription: 'Optional: Whether or not the commission is locked from user editing.',
   labelTasks: 'Tasks',
   labelSendEmail: 'Send Email',
+  labelSendEmailDescription: 'Optional: Send an email to the user regarding this update.',
   labelRequired: 'Required',
   labelOptional: 'Optional',
   youLabel: '(you)',
   noneLabel: 'None',
   backLabel: 'Back',
+  backLabelWithArrow: '← Back',
   nextLabel: 'Next',
   startLabel: 'Start',
   createLabel: 'Create',
@@ -91,7 +104,7 @@ const customText = {
   syncSuccess: 'Your commissions were synchronized successfully.',
   updateSuccess: 'Your commission was updated successfully.',
   commissionNotFoundJson: 'The requested commission was not found.',
-  forbiddenJson: 'You do not have permission to edit this commission.'
+  forbiddenMessage: 'You do not have permission to edit this commission.'
 };
 
 
@@ -365,7 +378,7 @@ app.post('/:id/edit', async (req, res) => {
   const commissionIndex = (req.session[vars.commissions] || []).findIndex(commission => String(commission.id) === String(req.params.id));
   if (commissionIndex === -1) return res.status(404).json({ status: 'error', message: getCustomText('commissionNotFoundJson') });
   const commission = req.session[vars.commissions][commissionIndex];
-  if (commission.locked && (getUserRole(req.session) === 'user')) return res.status(403).json({ status: 'error', message: getCustomText('forbiddenJson') });
+  if (commission.locked && (getUserRole(req.session) === 'user')) return res.status(403).json({ status: 'error', message: getCustomText('forbiddenMessage') });
   const data = {};
   fields.forEach(field => {
     if (field.id) data[field.id] = req.body[field.id] || null;