feat: add useLoginSettings hook [LIBS-516]

examples/cra/package.json

@@ -16,7 +16,8 @@
         "@dhis2/app-service-alerts": "file:../../services/alerts",
         "@dhis2/app-service-config": "file:../../services/config",
         "@dhis2/app-service-data": "file:../../services/data",
-        "@dhis2/app-service-offline": "file:../../services/offline"
+        "@dhis2/app-service-offline": "file:../../services/offline",
+        "@dhis2/app-service-login-settings": "file:../../services/login-settings"
     },
     "scripts": {
         "start": "react-scripts start",

examples/cra/yarn.lock

@@ -1054,26 +1054,30 @@
   integrity sha512-ij4wRiunFfaJxjB0BdrYHIH8FxBJpOwNPhhAcunlmPdXudL1WQV1qoP9un6JsEBAgQH+7UXyyjh0g7jTxXK6tg==
 
 "@dhis2/app-runtime@file:../../runtime":
-  version "3.6.1"
+  version "3.9.4"
   dependencies:
-    "@dhis2/app-service-alerts" "3.6.1"
-    "@dhis2/app-service-config" "3.6.1"
-    "@dhis2/app-service-data" "3.6.1"
-    "@dhis2/app-service-offline" "3.6.1"
+    "@dhis2/app-service-alerts" "3.9.4"
+    "@dhis2/app-service-config" "3.9.4"
+    "@dhis2/app-service-data" "3.9.4"
+    "@dhis2/app-service-login-settings" "3.9.4"
+    "@dhis2/app-service-offline" "3.9.4"
 
-"@dhis2/app-service-alerts@3.6.1", "@dhis2/app-service-alerts@file:../../services/alerts":
-  version "3.6.1"
+"@dhis2/app-service-alerts@3.9.4", "@dhis2/app-service-alerts@file:../../services/alerts":
+  version "3.9.4"
 
-"@dhis2/app-service-config@3.6.1", "@dhis2/app-service-config@file:../../services/config":
-  version "3.6.1"
+"@dhis2/app-service-config@3.9.4", "@dhis2/app-service-config@file:../../services/config":
+  version "3.9.4"
 
-"@dhis2/app-service-data@3.6.1", "@dhis2/app-service-data@file:../../services/data":
-  version "3.6.1"
+"@dhis2/app-service-data@3.9.4", "@dhis2/app-service-data@file:../../services/data":
+  version "3.9.4"
   dependencies:
     react-query "^3.13.11"
 
-"@dhis2/[email protected]", "@dhis2/app-service-offline@file:../../services/offline":
-  version "3.6.1"
+"@dhis2/[email protected]", "@dhis2/app-service-login-settings@file:../../services/login-settings":
+  version "3.9.4"
+
+"@dhis2/[email protected]", "@dhis2/app-service-offline@file:../../services/offline":
+  version "3.9.4"
   dependencies:
     lodash "^4.17.21"
 

examples/query-playground/package.json

@@ -29,6 +29,7 @@
         "@dhis2/app-service-alerts": "file:../../services/alerts",
         "@dhis2/app-service-config": "file:../../services/config",
         "@dhis2/app-service-data": "file:../../services/data",
-        "@dhis2/app-service-offline": "file:../../services/offline"
+        "@dhis2/app-service-offline": "file:../../services/offline",
+        "@dhis2/app-service-login-settings": "file:../../services/login-settings"
     }
 }

examples/query-playground/yarn.lock

@@ -1800,26 +1800,30 @@
     "@dhis2/app-service-offline" "3.7.0"
 
 "@dhis2/app-runtime@^2.2.2", "@dhis2/app-runtime@file:../../runtime":
-  version "3.6.1"
+  version "3.9.4"
   dependencies:
-    "@dhis2/app-service-alerts" "3.6.1"
-    "@dhis2/app-service-config" "3.6.1"
-    "@dhis2/app-service-data" "3.6.1"
-    "@dhis2/app-service-offline" "3.6.1"
+    "@dhis2/app-service-alerts" "3.9.4"
+    "@dhis2/app-service-config" "3.9.4"
+    "@dhis2/app-service-data" "3.9.4"
+    "@dhis2/app-service-login-settings" "3.9.4"
+    "@dhis2/app-service-offline" "3.9.4"
 
-"@dhis2/app-service-alerts@3.6.1", "@dhis2/app-service-alerts@3.7.0", "@dhis2/app-service-alerts@file:../../services/alerts":
-  version "3.6.1"
+"@dhis2/app-service-alerts@3.7.0", "@dhis2/app-service-alerts@3.9.4", "@dhis2/app-service-alerts@file:../../services/alerts":
+  version "3.9.4"
 
-"@dhis2/app-service-config@3.6.1", "@dhis2/app-service-config@3.7.0", "@dhis2/app-service-config@file:../../services/config":
-  version "3.6.1"
+"@dhis2/app-service-config@3.7.0", "@dhis2/app-service-config@3.9.4", "@dhis2/app-service-config@file:../../services/config":
+  version "3.9.4"
 
-"@dhis2/app-service-data@3.6.1", "@dhis2/app-service-data@3.7.0", "@dhis2/app-service-data@file:../../services/data":
-  version "3.6.1"
+"@dhis2/app-service-data@3.7.0", "@dhis2/app-service-data@3.9.4", "@dhis2/app-service-data@file:../../services/data":
+  version "3.9.4"
   dependencies:
     react-query "^3.13.11"
 
-"@dhis2/[email protected]", "@dhis2/[email protected]", "@dhis2/app-service-offline@file:../../services/offline":
-  version "3.6.1"
+"@dhis2/[email protected]", "@dhis2/app-service-login-settings@file:../../services/login-settings":
+  version "3.9.4"
+
+"@dhis2/[email protected]", "@dhis2/[email protected]", "@dhis2/app-service-offline@file:../../services/offline":
+  version "3.9.4"
   dependencies:
     lodash "^4.17.21"
 

runtime/package.json

@@ -26,7 +26,8 @@
         "@dhis2/app-service-config": "3.9.4",
         "@dhis2/app-service-data": "3.9.4",
         "@dhis2/app-service-alerts": "3.9.4",
-        "@dhis2/app-service-offline": "3.9.4"
+        "@dhis2/app-service-offline": "3.9.4",
+        "@dhis2/app-service-login-settings": "3.9.4"
     },
     "peerDependencies": {
         "prop-types": "^15.7.2",

runtime/src/Provider.tsx

@@ -2,24 +2,34 @@ import { AlertsProvider } from '@dhis2/app-service-alerts'
 import { ConfigProvider } from '@dhis2/app-service-config'
 import { Config } from '@dhis2/app-service-config/build/types/types'
 import { DataProvider } from '@dhis2/app-service-data'
+import { LoginSettingsProvider } from '@dhis2/app-service-login-settings'
 import { OfflineProvider } from '@dhis2/app-service-offline'
 import React from 'react'
 
 type ProviderInput = {
     config: Config
     children: React.ReactNode
     offlineInterface?: any // temporary until offline service has types
+    loginApp: boolean
 }
+
 export const Provider = ({
     config,
     children,
     offlineInterface,
+    loginApp,
 }: ProviderInput) => (
     <ConfigProvider config={config}>
         <AlertsProvider>
             <DataProvider>
                 <OfflineProvider offlineInterface={offlineInterface}>
-                    {children}
+                    {loginApp ? (
+                        <LoginSettingsProvider>
+                            {children}
+                        </LoginSettingsProvider>
+                    ) : (
+                        <>{children}</>
+                    )}
                 </OfflineProvider>
             </DataProvider>
         </AlertsProvider>

runtime/src/index.ts

@@ -23,4 +23,6 @@ export {
     clearSensitiveCaches,
 } from '@dhis2/app-service-offline'
 
+export { useLoginSettings } from '@dhis2/app-service-login-settings'
+
 export { Provider } from './Provider'

services/login-settings/.gitignore

@@ -0,0 +1,5 @@
+# DHIS2 Platform
+node_modules
+.d2
+src/locales
+build

services/login-settings/README.md

@@ -0,0 +1,11 @@
+# DHIS2 App Login Settings Service
+
+This service exposes system settings needed for login applications for [DHIS2](https://dhis2.org).
+
+This library is intended for use with the [DHIS2 Application Platform](https://github.com/dhis2/app-platform).
+
+## Installation
+
+This package is internal to `@dhis2/app-runtime` and generally should not be installed independently.
+
+See [the docs](https://runtime.dhis2.nu) for more.

services/login-settings/d2.config.js

@@ -0,0 +1,9 @@
+const config = {
+    type: 'lib',
+
+    entryPoints: {
+        lib: './src/index.ts',
+    },
+}
+
+module.exports = config

services/login-settings/jest.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+    collectCoverageFrom: [
+        'src/**/*.(js|jsx|ts|tsx)',
+        '!src/index.ts',
+        '!src/**/types/*',
+        '!src/**/types.ts',
+    ],
+
+    // Setup react-testing-library
+    setupFilesAfterEnv: ['<rootDir>/src/setupRTL.ts'],
+    // Fix for Jest 27
+    // https://github.com/facebook/jest/issues/11404#issuecomment-1003328922
+    testRunner: 'jest-jasmine2',
+}

services/login-settings/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "@dhis2/app-service-login-settings",
+    "description": "A runtime service for login settings",
+    "version": "3.9.4",
+    "main": "./build/cjs/index.js",
+    "module": "./build/es/index.js",
+    "types": "build/types/index.d.ts",
+    "exports": {
+        "import": "./build/es/index.js",
+        "require": "./build/cjs/index.js"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/dhis2/app-runtime.git",
+        "directory": "services/login-settings"
+    },
+    "author": "Thomas Zemp <[email protected]>",
+    "license": "BSD-3-Clause",
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "build/**"
+    ],
+    "scripts": {
+        "build:types": "tsc --emitDeclarationOnly --outDir ./build/types",
+        "build:package": "d2-app-scripts build",
+        "build": "concurrently -n build,types \"yarn build:package\" \"yarn build:types\"",
+        "watch": "NODE_ENV=development concurrently -n build,types \"yarn build:package --watch\" \"yarn build:types --watch\"",
+        "type-check": "tsc --noEmit --allowJs --checkJs",
+        "type-check:watch": "yarn type-check --watch",
+        "test": "d2-app-scripts test",
+        "coverage": "yarn test --coverage"
+    },
+    "peerDependencies": {
+        "@dhis2/app-service-config": "3.9.4",
+        "prop-types": "^15.7.2",
+        "react": "^16.8.6",
+        "react-dom": "^16.8.6"
+    }
+}

services/login-settings/src/LoginSettingsContext.ts

@@ -0,0 +1,26 @@
+import React from 'react'
+import { LoginSettings } from './types'
+
+export const LoginSettingsContext = React.createContext<LoginSettings>({
+    applicationDescription: '',
+    applicationFooter: '',
+    applicationNotification: '',
+    allowAccountRecovery: false,
+    applicationTitle: '',
+    countryFlag: '',
+    useCountryFlag: false,
+    loginPageLogo: '',
+    useLoginPageLogo: false,
+    emailConfigured: false,
+    selfRegistrationEnabled: false,
+    selfRegistrationNoRecaptcha: false,
+    systemUiLocale: '',
+    uiLocale: '',
+    localesUI: [],
+    htmlTemplate: '',
+    refreshOnTranslation: ({ locale }) => {
+        throw new Error('This function is not implemented')
+    },
+    error: null,
+    called: false,
+})