Merge branch 'develop'

Author: mark-prins

.github/workflows/client-bundle-size-diff.yaml

@@ -21,7 +21,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{secrets.TOKEN_REPO}}
 
       - name: Build
-        run: cd ./client && yarn build-dev
+        run: cd ./client && yarn build-stats
 
       - name: Upload base stats.json
         uses: actions/upload-artifact@v2
@@ -43,7 +43,7 @@ jobs:
           NODE_AUTH_TOKEN: ${{secrets.TOKEN_REPO}}
 
       - name: Build
-        run: cd ./client && yarn build-dev
+        run: cd ./client && yarn build-stats
 
       - name: Upload base stats.json
         uses: actions/upload-artifact@v2

README.md

@@ -6,12 +6,25 @@ Used in over 30 countries and for over 20 years and now becoming open source.
 The code is separated into two main areas, the client and server:
 
 ### Client
+
 Built on [React](https://reactjs.org/) - a responsive, multi-lingual, web based client, also packaged as both a desktop and android app.
 
 For more information, [read the client developer docs](client/README.md)
 
-
 ### Server
+
 Built to be fast and reliable using [Rust](https://www.rust-lang.org/) and supporting either [PostgreSQL](https://www.postgresql.org/) or [SQLite](https://www.sqlite.org/index.html) databases.
 
 For more information, [read the server developer docs](server/README.md)
+
+### Architecture
+
+The client application is a web app, which is compiled and then hosted by the server. This can also be hosted externally by any web server, though this is no longer the recommended approach. The server connects to the database and provides a graphQL API which is consumed by the client app.
+
+Users browse to the client app on the configured server port from a web browser, or the various wrappers which provide platform specific capabilities. This web app then connects to the server using graphQL in order to fetch data, and to the web server for app resources.
+
+In diagrammatic form this looks like the image below:
+
+![omSupply Architecture drawio](./architecture.drawio.svg)
+
+There are also several ancilliary applications as noted, which are available to be run (cli applications) or hosted (storybook) separately.

architecture.drawio.svg

@@ -956,8 +956,8 @@ Screen.Back();
 <Script>-- These actions are performed when the Next button is clicked.
 local sNextScreenName = "Select Install Folder";
 
-tRbSqliteProps = DlgRadioButton.GetProperties(CTRL_RADIO_BUTTON_01);
-if not tRbSqliteProps.Checked then
+tRbSqliteProps = DlgRadioButton.GetProperties(CTRL_RADIO_BUTTON_02); -- If postgres is selected as db
+if tRbSqliteProps.Checked then
 	SessionVar.Set("%omsupply_selected_db%", "postgres");
 	sNextScreenName = "Postgres Configuration";
 else
@@ -2842,7 +2842,7 @@ end
 <Visible>1</Visible>
 <Enabled>1</Enabled>
 <TabOrder>5</TabOrder>
-<Checked>1</Checked>
+<Checked>0</Checked>
 <Variable>cbStartOmSupply</Variable>
 </Control>
 <Control>
@@ -4056,25 +4056,14 @@ g_HandleSystemReboot();
 <Args/>
 <Script>-- Set window title
 local sWindowTitle = "omSupply Server Setup";
-
-hasOmsupplyInstalled = false;
-omSupplyServerDatabase = SessionVar.Get("%omsupply_selected_db%");
-
-if (omSupplyServerDatabase == "sqlite") then
-	omSupplyServerPath = SessionVar.Expand("%AppFolder%\\omSupply-sqlite.exe");
-else
-	omSupplyServerPath = SessionVar.Expand("%AppFolder%\\omSupply-postgres.exe");
-end
+local omSupplyServerPath = "";
 
 -- Check if the omSupply Server has been already installed on this machine
 if Registry.DoesKeyExist(HKEY_LOCAL_MACHINE, "Software\\omSupply Server") then
 	omSupplyServerPath = Registry.GetValue(HKEY_LOCAL_MACHINE, "Software\\omSupply Server", "Path", true);
-	omSupplyServerDatabase = Registry.GetValue(HKEY_LOCAL_MACHINE, "Software\\omSupply Server", "Database", true);
-	if File.DoesExist(omSupplyServerPath) then
-		hasOmsupplyInstalled = true;
-	end
 end
 
+hasOmsupplyInstalled = File.DoesExist(omSupplyServerPath);
 if hasOmsupplyInstalled then
 	sWindowTitle = "omSupply Server Upgrader Setup";
 end
@@ -4167,6 +4156,18 @@ end
 <Name>On Post Install</Name>
 <Args/>
 <Script>local sFileToBeDeletePath = "";
+local omSupplyServerPath = SessionVar.Expand("%AppFolder%\\omSupply-sqlite.exe");
+local omSupplyServerDatabase = SessionVar.Get("%omsupply_selected_db%");
+
+-- Get current database name from registry (if already installed)
+if hasOmsupplyInstalled then
+	omSupplyServerDatabase = Registry.GetValue(HKEY_LOCAL_MACHINE, "Software\\omSupply Server", "Database", true);
+end
+
+if (omSupplyServerDatabase == "postgres") then
+	omSupplyServerPath = SessionVar.Expand("%AppFolder%\\omSupply-postgres.exe"); 
+end
+
 if not hasOmsupplyInstalled then
 	local config = "server:\r\n"
 	config = config .. "  host: 192.168.178.68\r\n";

build/windows/omsupply_server.suf

@@ -7,7 +7,7 @@
     "start-remote": "lerna run --scope @openmsupply-client/* --parallel start-remote",
     "start": "yarn start-remote",
     "build": "lerna run --scope @openmsupply-client/* build",
-    "build-dev": "lerna run --scope @openmsupply-client/* build-dev",
+    "build-stats": "lerna run --scope @openmsupply-client/* build-stats",
     "serve": "lerna run --scope @openmsupply-client/* --parallel serve",
     "clean": "lerna run --scope @openmsupply-client/* --parallel clean",
     "compile": "lerna run --scope @openmsupply-client/* --parallel tsc --since HEAD",

client/package.json

@@ -67,7 +67,9 @@ export const useUrlQueryParams = ({
     filterBy:
       filterKey && urlQuery[filterKey]
         ? {
-            [filterKey]: { [filterCondition]: urlQuery[filterKey] ?? '' },
+            [filterKey]: {
+              [filterCondition]: String(urlQuery[filterKey]) ?? '',
+            },
           }
         : {},
   };

client/packages/common/src/hooks/useUrlQuery/useUrlQueryParams.ts

@@ -4,6 +4,8 @@ import Backend from 'i18next-chained-backend';
 import LocalStorageBackend from 'i18next-localstorage-backend';
 import HttpApi from 'i18next-http-backend';
 import { I18nextProvider, initReactI18next } from 'react-i18next';
+import LanguageDetector from 'i18next-browser-languagedetector';
+import { browserLanguageDetector } from './browserLanguageDetector';
 import { PropsWithChildrenOnly } from '@common/types';
 import { EnvUtils, Platform } from '@common/utils';
 
@@ -12,6 +14,9 @@ export const IntlProvider: FC<PropsWithChildrenOnly> = ({ children }) => {
   React.useEffect(() => {
     if (i18next.isInitialized) return;
 
+    const languageDetector = new LanguageDetector();
+    languageDetector.addDetector(browserLanguageDetector);
+
     const minuteInMilliseconds = 60 * 1000;
     const isDevelopment = process.env['NODE_ENV'] === 'development';
     const expirationTime = isDevelopment
@@ -29,6 +34,7 @@ export const IntlProvider: FC<PropsWithChildrenOnly> = ({ children }) => {
     i18next
       .use(initReactI18next) // passes i18n down to react-i18next
       .use(Backend)
+      .use(languageDetector)
       .init({
         backend: {
           backends: [

client/packages/common/src/intl/context/IntlContext.tsx

@@ -0,0 +1,37 @@
+import { CustomDetector } from 'i18next-browser-languagedetector';
+
+export const browserLanguageDetector: CustomDetector = {
+  name: 'omsBrowserLanguageDetector',
+  // the language is now supplied by the user profile
+  // and set on login, so the below code is not actually needed
+  // Implementing the language detector allows the language
+  // to be cached in the browser and retained on page refresh
+  lookup: () => {
+    const found: string[] = [];
+    const add = (languageOrLocale?: string) => {
+      if (!languageOrLocale) return;
+      const parsed = /(^[a-z]{2})(-(.*))?/.exec(languageOrLocale);
+      if (parsed) {
+        if (parsed.length > 1 && !!parsed[1]) found.push(parsed[1]);
+      } else {
+        found.push(languageOrLocale);
+      }
+    };
+    if (typeof navigator !== 'undefined') {
+      if (navigator.languages) {
+        // chrome only; not an array, so can't use .push.apply instead of iterating
+        for (let i = 0; i < navigator.languages.length; i++) {
+          const locale = navigator.languages[i];
+          add(locale);
+        }
+      }
+      if ((navigator as any).userLanguage) {
+        add((navigator as any).userLanguage);
+      }
+      if (navigator.language) {
+        add(navigator.language);
+      }
+    }
+    return found.length > 0 ? found : undefined;
+  },
+};

client/packages/common/src/intl/context/browserLanguageDetector.ts

@@ -72,7 +72,7 @@ const currencyOptions = {
     symbol: '$',
     separator: ',',
     decimal: '.',
-    precision: 10,
+    precision: 2,
     pattern: '!#',
     negativePattern: '-!#',
     format,
@@ -81,7 +81,7 @@ const currencyOptions = {
     symbol: 'XOF',
     separator: '.',
     decimal: ',',
-    precision: 10,
+    precision: 2,
     pattern: '# !',
     negativePattern: '-# !',
     format,
@@ -90,25 +90,26 @@ const currencyOptions = {
     symbol: 'ر.ق.',
     separator: ',',
     decimal: '.',
-    precision: 10,
+    precision: 2,
     pattern: '!#',
     negativePattern: '-!#',
     format,
   },
 };
 
-export const useCurrency = () => {
+export const useCurrency = (dp?: number) => {
   const language = IntlUtils.useCurrentLanguage();
   const options = currencyOptions[language];
+  const precision = dp ?? options.precision;
   return {
-    c: (value: currency.Any) => currency(value, options),
+    c: (value: currency.Any) => currency(value, { ...options, precision }),
     options,
-    language,
-  };
+    language
+  }
 };
 
-export const useFormatCurrency = () => {
-  const { c } = useCurrency();
+export const useFormatCurrency = (dp?: number) => {
+  const { c } = useCurrency(dp);
   return (value: currency.Any) => c(value).format();
 };
 

client/packages/common/src/intl/currency/currency.ts

@@ -30,6 +30,7 @@
   "description.pack-quantity": "Total quantity in number of packs",
   "description.remaining-to-supply": "The quantity remaining to be supplied, which is the Supply quantity less the quantity of this item on any linked Outbound Shipment",
   "description.requested-quantity": "Quantity requested by customer",
+  "description.soh": "Stock on Hand",
   "description.stock-on-hand": "Stock on Hand (Est. remaining)",
   "description.supply-quantity": "The quantity that will be supplied by this store",
   "description.total": "Total value",
@@ -102,6 +103,7 @@
   "label.edited-by": "Edited by",
   "label.entered": "Created",
   "label.entered-by": "Entered by",
+  "label.event": "Event",
   "label.expand": "Expand",
   "label.expand-all": "Expand all",
   "label.expiring-soon": "Expiring Soon",
@@ -154,6 +156,7 @@
   "label.settings-username": "Site name",
   "label.shipped": "Shipped",
   "label.snapshot-num-of-packs": "Snapshot # of Packs",
+  "label.soh": "SOH",
   "label.status": "Status",
   "label.stock-on-hand": "SoH (Est. remaining)",
   "label.suggested": "Suggested",
@@ -188,6 +191,13 @@
   "log.requisition-deleted": "Requisition deleted",
   "log.requisition-status-sent": "Requisition sent",
   "log.requisition-status-finalised": "Requisition finalised",
+  "log.stock-batch-change": "Batch changed",
+  "log.stock-cost-price-change": "Cost price changed",
+  "log.stock-expiry-date-change": "Expiry date changed",
+  "log.stock-location-change": "Location changed",
+  "log.stock-off-hold": "Stock off hold",
+  "log.stock-on-hold": "Stock on hold",
+  "log.stock-sell-price-change": "Sell price changed",
   "messages.ago": "{{time}} ago",
   "messages.cant-delete-generic": "You cannot delete one or more of the selected items",
   "messages.confirm-cancel-generic": "You will lose any changes you have made to this form",

client/packages/common/src/intl/locales/en/common.json

@@ -9,6 +9,8 @@
   "error.stocktake-not-found": "Stocktake not found",
   "label.add-batch": "Add batch",
   "label.add-new-line": "Add a new line",
+  "label.cost-price": "Cost price",
+  "label.sell-price": "Sell price",
   "label.counted-num-of-packs": "Counted # of Packs",
   "label.create-location": "Create Location",
   "label.edit-location": "Edit Location",
@@ -26,7 +28,6 @@
   "messages.cant-delete-stocktakes": "Can only delete stocktakes with a status of 'New'",
   "messages.select-rows-to-delete": "Select rows to delete",
   "messages.click-to-return": "Unable to find a stocktake with that ID. Click OK to return to the stocktake list",
-  "messages.click-to-view-item": "Click to view the item details for '{{itemName}}'",
   "messages.confirm-delete-stocktakes_one": "This will permanently remove 1 stocktake",
   "messages.confirm-delete-stocktakes_other": "This will permanently remove {{count}} stocktakes",
   "messages.confirm-delete-stocktake_lines_one": "This will permanently remove 1 stocktake line",
@@ -41,7 +42,9 @@
   "messages.error-deleting-locations_other": "{{count}} locations could not be deleted",
   "placeholder.enter-an-item-code-or-name": "Enter item code or name",
   "messages.deleted-lines": "Deleted {{count}} lines",
+  "messages.confirm-save-stock-line": "Do you want to save the changes to this stock line? All changes will be logged and can be reviewed later from this screen.",
   "messages.select-rows-to-delete-them": "Select rows to delete them",
   "status.new": "New",
-  "status.finalised": "Finalised"
+  "status.finalised": "Finalised",
+  "title.stock-line-details": "Stock Line Details"
 }