Environment configuration

Author: ArtsiomTsybulko

.eslintignore

@@ -1,4 +1,3 @@
 /dist/*
 /lib/*
-/examples/*
 !.*

.eslintrc.cjs

@@ -8,4 +8,12 @@ module.exports = {
     rules: {
         '@typescript-eslint/no-explicit-any': ['warn'],
     },
+    overrides: [
+        {
+            files: ['./examples/**'],
+            rules: {
+                '@typescript-eslint/no-unused-vars': 'off',
+            }
+        },
+    ]
 };

.github/workflows/run-smoke-test.yml

@@ -16,8 +16,6 @@ jobs:
           registry-url: https://registry.npmjs.org/
       - run: npm install
       - run: npm run build
-      - run: npm install
-        working-directory: ./examples
       - run: npm install && node --unhandled-rejections=strict index.js
         working-directory: ./examples/basic/
         env:

examples/auth/client/index.js

@@ -9,35 +9,40 @@ import {
     Light,
     SecurityFeatureType,
 } from '@regulaforensics/document-reader-webclient';
-import axios from "axios";
-import qs from "qs";
+import axios from 'axios';
+import qs from 'qs';
 
-const GATEWAY_BASE_URL = "http://localhost:8080"
+const GATEWAY_BASE_URL = 'http://localhost:8080';
 
 const { PORTRAIT, DOCUMENT_FRONT } = GraphicFieldType;
 const { DOCUMENT_NUMBER } = TextFieldType;
 
 async function get_authorization_token() {
     let data = qs.stringify({
-          'grant_type': 'password',
-          'username': 'testuser1',
-          'password': 't3stP@ss',
-          'client_id': 'account',
-          'scope': 'openid'
+        grant_type: 'password',
+        username: 'testuser1',
+        password: 't3stP@ss',
+        client_id: 'account',
+        scope: 'openid',
     });
 
     let config = {
-      method: 'post',
-      maxBodyLength: Infinity,
-      url: `${GATEWAY_BASE_URL}/realms/regula/protocol/openid-connect/token`,
-      headers: {
-        'Content-Type': 'application/x-www-form-urlencoded'
-      },
-      data : data
-};
-    return axios.request(config)
-        .then((response) => {return response.data["access_token"]})
-        .catch((error) => {console.log(error)});
+        method: 'post',
+        maxBodyLength: Infinity,
+        url: `${GATEWAY_BASE_URL}/realms/regula/protocol/openid-connect/token`,
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+        },
+        data: data,
+    };
+    return axios
+        .request(config)
+        .then((response) => {
+            return response.data['access_token'];
+        })
+        .catch((error) => {
+            console.log(error);
+        });
 }
 
 (async () => {
@@ -47,9 +52,12 @@ async function get_authorization_token() {
     if (fs.existsSync('regula.license')) {
         license = fs.readFileSync('regula.license');
     }
-    const token = await get_authorization_token()
+    const token = await get_authorization_token();
 
-    const api = new DocumentReaderApi({ basePath: apiBasePath, baseOptions: {headers: {"Authorization": `Bearer ${token}`}}});
+    const api = new DocumentReaderApi({
+        basePath: apiBasePath,
+        baseOptions: { headers: { Authorization: `Bearer ${token}` } },
+    });
 
     api.setLicense(license);
 

examples/auth/client/package-lock.json

@@ -3,6 +3,7 @@
   "type": "module",
   "dependencies": {
     "@regulaforensics/document-reader-webclient": "file:../../..",
+    "axios": "^1.6.2",
     "qs": "^6.11.2"
   }
 }

examples/auth/client/package.json

@@ -1,61 +1,46 @@
-import axios from "axios";
-import jwt from "jsonwebtoken";
-import jwkToPem from "jwk-to-pem";
-import { path, find, compose, flip, curryN } from "ramda";
+import axios from 'axios';
+import jwt from 'jsonwebtoken';
+import jwkToPem from 'jwk-to-pem';
+import { path, find, compose, flip, curryN } from 'ramda';
 
 const verify = curryN(2)(jwt.verify);
-const IDP_KEYCLOAK_URL = "http://keycloak:8080";
-const IDP_KEYCLOAK_REALM = "regula";
-
-const findPublicKeyFromKid = publicKey => kid =>
-  find(isTheRightKid(kid))(publicKey);
-
-const getKid = path(["header", "kid"]);
-
-const decode = compose(
-  curryN(2),
-  flip
-)(jwt.decode);
-
-const getUserFromPublicKey = token =>
-  compose(
-    makeUser,
-    verify(token)
-  );
-
-  const makeUser = ({
-    sub,
-    preferred_username,
-    email_verified,
-    resource_access,
-    email,
-    name,
-    ...others
-  }) => ({
+const IDP_KEYCLOAK_URL = 'http://keycloak:8080';
+const IDP_KEYCLOAK_REALM = 'regula';
+
+const findPublicKeyFromKid = (publicKey) => (kid) => find(isTheRightKid(kid))(publicKey);
+
+const getKid = path(['header', 'kid']);
+
+const decode = compose(curryN(2), flip)(jwt.decode);
+
+const getUserFromPublicKey = (token) => compose(makeUser, verify(token));
+
+const makeUser = ({ sub, preferred_username, email_verified, resource_access, email, name, ...others }) => ({
     id: sub,
     userName: preferred_username,
     emailVerified: email_verified,
     resourceAccess: resource_access,
     email,
     name,
-    ...others
-  });
+    ...others,
+});
 
-const isTheRightKid = kid => publicKey => publicKey.kid === kid;
+const isTheRightKid = (kid) => (publicKey) => publicKey.kid === kid;
 
-const getUserFromJWK = token => jwk =>
-  compose(
-    getUserFromPublicKey(token),
-    jwkToPem,
-    findPublicKeyFromKid(jwk),
-    getKid,
-    decode({ complete: true })
-  )(token);
+const getUserFromJWK = (token) => (jwk) =>
+    compose(
+        getUserFromPublicKey(token),
+        jwkToPem,
+        findPublicKeyFromKid(jwk),
+        getKid,
+        decode({ complete: true }),
+    )(token);
 
 export const verifyOffline = (accessToken, options = {}) => {
-  const url = `${IDP_KEYCLOAK_URL}/realms/${IDP_KEYCLOAK_REALM}/protocol/openid-connect/certs`;
+    const url = `${IDP_KEYCLOAK_URL}/realms/${IDP_KEYCLOAK_REALM}/protocol/openid-connect/certs`;
 
-  return axios.get(url)
-    .then(path(["data", "keys"]))
-    .then(getUserFromJWK(accessToken))
-};
+    return axios
+        .get(url)
+        .then(path(['data', 'keys']))
+        .then(getUserFromJWK(accessToken));
+};