UXPROD-3903: Create new UI for new bursar export feature (#107)

.eslintrc

@@ -1,4 +1,18 @@
 {
-  "parser": "babel-eslint",
-  "extends": ["@folio/eslint-config-stripes/acquisitions"]
+  "extends": ["@folio/eslint-config-stripes", "plugin:import/typescript"],
+  "env": {
+    "jest": true
+  },
+  "rules": {
+    "import/no-named-as-default": "off"
+  },
+  "overrides": [
+    {
+      "files": ["src/test/**/*", "src/**/*.test.ts", "src/**/*.test.tsx"],
+      "env": { "jest": true },
+      "rules": {
+        "@typescript-eslint/no-explicit-any": "off"
+      }
+    }
+  ]
 }

.github/workflows/build-npm-release.yml

@@ -19,9 +19,9 @@ on:
 
 jobs:
   github-actions-ci:
-    if : ${{ startsWith(github.ref, 'refs/tags/v') }}
+    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
     env:
-      YARN_TEST_OPTIONS: ''
+      YARN_TEST_OPTIONS: '--coverage'
       SQ_ROOT_DIR: './src'
       COMPILE_TRANSLATION_FILES: 'true'
       PUBLISH_MOD_DESCRIPTOR: 'true'
@@ -35,7 +35,7 @@ jobs:
       BIGTEST_COVERAGE_REPORT_DIR: 'artifacts/coverage/lcov-report/'
       OKAPI_PULL: '{ "urls" : [ "https://folio-registry.dev.folio.org" ] }'
       SQ_LCOV_REPORT: 'artifacts/coverage-jest/lcov.info'
-      SQ_EXCLUSIONS: '**/platform/alias-service.js,**/docs/**,**/node_modules/**,**/examples/**,**/artifacts/**,**/ci/**,Jenkinsfile,**/LICENSE,**/*.css,**/*.md,**/*.json,**/tests/**,**/stories/*.js,**/test/**,**/.stories.js,**/resources/bigtest/interactors/**,**/resources/bigtest/network/**,**/*-test.js,**/*.test.js,**/*-spec.js,**/karma.conf.js,**/jest.config.js'
+      SQ_EXCLUSIONS: '**/platform/alias-service.js,**/docs/**,**/node_modules/**,**/examples/**,**/artifacts/**,**/ci/**,Jenkinsfile,**/LICENSE,**/*.css,**/*.md,**/*.json,**/tests/**,**/stories/*.js,**/test/**,**/.stories.js,**/resources/bigtest/interactors/**,**/resources/bigtest/network/**,**/*-test.js,**/*.test.js,**/*.test.ts,**/*.test.tsx,**/*-spec.js,**/karma.conf.js,**/jest.config.js'
 
     runs-on: ubuntu-latest
     steps:
@@ -88,10 +88,10 @@ jobs:
         continue-on-error: true
 
       - name: Run yarn test
-        run: xvfb-run --server-args="-screen 0 1024x768x24" yarn test $YARN_TEST_OPTIONS
+        run: yarn node --expose-gc $(yarn bin jest) --runInBand --logHeapUsage $YARN_TEST_OPTIONS
 
       - name: Run yarn formatjs-compile
-        if : ${{ env.COMPILE_TRANSLATION_FILES == 'true' }}
+        if: ${{ env.COMPILE_TRANSLATION_FILES == 'true' }}
         run: yarn formatjs-compile
 
       - name: Generate FOLIO module descriptor
@@ -146,7 +146,7 @@ jobs:
         if: always()
         with:
           github_token: ${{ github.token }}
-          files: "${{ env.JEST_JUNIT_OUTPUT_DIR }}/*.xml"
+          files: '${{ env.JEST_JUNIT_OUTPUT_DIR }}/*.xml'
           check_name: Jest Unit Test Results
           comment_mode: update last
           comment_title: Jest Unit Test Statistics
@@ -164,7 +164,7 @@ jobs:
         if: always()
         with:
           github_token: ${{ github.token }}
-          files: "${{ env.BIGTEST_JUNIT_OUTPUT_DIR }}/*.xml"
+          files: '${{ env.BIGTEST_JUNIT_OUTPUT_DIR }}/*.xml'
           check_name: BigTest Unit Test Results
           comment_mode: update last
           comment_title: BigTest Unit Test Statistics
@@ -244,4 +244,3 @@ jobs:
           data: ${{ steps.moduleDescriptor.outputs.content }}
           username: ${{ secrets.FOLIO_REGISTRY_USERNAME }}
           password: ${{ secrets.FOLIO_REGISTRY_PASSWORD }}
-

.github/workflows/build-npm.yml

@@ -10,15 +10,13 @@
 #   - PUBLISH_MOD_DESCRIPTOR (boolean 'true' or 'false')
 #   - COMPILE_TRANSLATION_FILES (boolean 'true' or 'false')
 
-
-
 name: buildNPM Snapshot
 on: [push, pull_request]
 
 jobs:
   github-actions-ci:
     env:
-      YARN_TEST_OPTIONS: ''
+      YARN_TEST_OPTIONS: '--coverage'
       SQ_ROOT_DIR: './src'
       COMPILE_TRANSLATION_FILES: 'true'
       PUBLISH_MOD_DESCRIPTOR: 'true'
@@ -31,7 +29,7 @@ jobs:
       BIGTEST_JUNIT_OUTPUT_DIR: 'artifacts/runTest'
       BIGTEST_COVERAGE_REPORT_DIR: 'artifacts/coverage/lcov-report/'
       SQ_LCOV_REPORT: 'artifacts/coverage-jest/lcov.info'
-      SQ_EXCLUSIONS: '**/platform/alias-service.js,**/docs/**,**/node_modules/**,**/examples/**,**/artifacts/**,**/ci/**,Jenkinsfile,**/LICENSE,**/*.css,**/*.md,**/*.json,**/tests/**,**/stories/*.js,**/test/**,**/.stories.js,**/resources/bigtest/interactors/**,**/resources/bigtest/network/**,**/*-test.js,**/*.test.js,**/*-spec.js,**/karma.conf.js,**/jest.config.js'
+      SQ_EXCLUSIONS: '**/platform/alias-service.js,**/docs/**,**/node_modules/**,**/examples/**,**/artifacts/**,**/ci/**,Jenkinsfile,**/LICENSE,**/*.css,**/*.md,**/*.json,**/tests/**,**/stories/*.js,**/test/**,**/.stories.js,**/resources/bigtest/interactors/**,**/resources/bigtest/network/**,**/*-test.js,**/*.test.js,**/*.test.ts,**/*.test.tsx,**/*-spec.js,**/karma.conf.js,**/jest.config.js'
 
     runs-on: ubuntu-latest
     steps:
@@ -70,7 +68,7 @@ jobs:
         continue-on-error: true
 
       - name: Run yarn test
-        run: xvfb-run --server-args="-screen 0 1024x768x24" yarn test $YARN_TEST_OPTIONS
+        run: yarn node --expose-gc $(yarn bin jest) --runInBand --logHeapUsage $YARN_TEST_OPTIONS
 
       - name: Run yarn formatjs-compile
         if: ${{ env.COMPILE_TRANSLATION_FILES == 'true' }}
@@ -89,7 +87,7 @@ jobs:
         if: always()
         with:
           github_token: ${{ github.token }}
-          files: "${{ env.JEST_JUNIT_OUTPUT_DIR }}/*.xml"
+          files: '${{ env.JEST_JUNIT_OUTPUT_DIR }}/*.xml'
           check_name: Jest Unit Test Results
           comment_mode: update last
           comment_title: Jest Unit Test Statistics
@@ -107,7 +105,7 @@ jobs:
         if: always()
         with:
           github_token: ${{ github.token }}
-          files: "${{ env.BIGTEST_JUNIT_OUTPUT_DIR }}/*.xml"
+          files: '${{ env.BIGTEST_JUNIT_OUTPUT_DIR }}/*.xml'
           check_name: BigTest Unit Test Results
           comment_mode: update last
           comment_title: BigTest Unit Test Statistics
@@ -198,4 +196,3 @@ jobs:
           data: ${{ steps.moduleDescriptor.outputs.content }}
           username: ${{ secrets.FOLIO_REGISTRY_USERNAME }}
           password: ${{ secrets.FOLIO_REGISTRY_PASSWORD }}
-

.gitignore

@@ -38,3 +38,4 @@ stripes.config.js.local
 # tests
 /artifacts
 junit.xml
+

CHANGELOG.md

@@ -1,8 +1,8 @@
 # Change history for ui-plugin-bursar-export
 
-## 3.1.0 (IN PROGRESS)
+## 4.0.0 (IN PROGRESS)
+* Support the new bursar export configuration feature and revamped UI. Refs UXPROD-3603.
 * Also support `feesfines` interface version `19.0`. Refs UIPBEX-55.
-* Support `data-export-spring` interface `v2.0`. Refs UXPROD-3903.
 
 ## [3.0.0](https://github.com/folio-org/ui-plugin-bursar-export/tree/v3.0.0) (2023-10-16)
 [Full Changelog](https://github.com/folio-org/ui-plugin-bursar-export/compare/v2.4.0...v3.0.0)

index.ts

@@ -0,0 +1 @@
+export { default } from './src/index';

jest.config.js

@@ -1,12 +1,45 @@
-const path = require('path');
-const stripesConfig = require('@folio/jest-config-stripes');
-const acqConfig = require('@folio/stripes-acq-components/jest.config');
+const { join } = require('path');
+const config = require('@folio/jest-config-stripes');
 
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...stripesConfig,
+  ...config,
+
+  coverageProvider: 'v8',
+
+  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'json'],
+
+  testMatch: ['**/src/**/?(*.)test.{js,jsx,ts,tsx}'],
+
+  coverageReporters: ['lcov', 'text'],
+  collectCoverageFrom: [
+    '<rootDir>/index.ts',
+    '<rootDir>/src/**/*.{ts,tsx}',
+    '!<rootDir>/src/**/*.d.ts',
+    '!<rootDir>/src/**/*.test.{ts,tsx}',
+    '!<rootDir>/src/test/**',
+    '!**/node_modules/**',
+  ],
+
   setupFiles: [
-    ...stripesConfig.setupFiles,
-    ...acqConfig.setupFiles,
-    path.join(__dirname, './test/jest/setupFiles.js'),
+    ...config.setupFiles,
+    join(__dirname, './test/setupTests.ts')
   ],
+  setupFilesAfterEnv: [join(__dirname, './test/jest.setup.ts')],
+
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.(ts|tsx)?$': 'ts-jest',
+    ...config.transform
+  },
+
+  moduleNameMapper: {
+    '^.+\\.(css|svg)$': 'identity-obj-proxy',
+
+    // Force module uuid to resolve with the CJS entry point, because Jest does not support package.json.exports. See https://github.com/uuidjs/uuid/issues/451
+    uuid: require.resolve('uuid'),
+  },
+
+  slowTestThreshold: 10,
+  testTimeout: 20000,
 };

package.json

@@ -1,8 +1,8 @@
 {
   "name": "@folio/plugin-bursar-export",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Bursar export",
-  "main": "index.js",
+  "main": "src/index.js",
   "repository": "",
   "license": "Apache-2.0",
   "engines": {
@@ -17,25 +17,47 @@
     "okapiInterfaces": {
       "users": "15.0 16.0",
       "feesfines": "16.0 17.0 18.0 19.0",
-      "data-export-spring": "1.0 2.0"
+      "data-export-spring": "2.0",
+      "service-points": "3.0",
+      "location-units": "2.0",
+      "locations": "3.0"
     },
-    "stripesDeps": [
-      "@folio/stripes-acq-components"
-    ],
     "permissionSets": [
       {
         "permissionName": "ui-plugin-bursar-export.bursar-exports.all",
-        "displayName": "Bursar exports: Bursar admin",
+        "displayName": "Transfer exports: Modify configuration and start jobs",
+        "subPermissions": [
+          "ui-plugin-bursar-export.bursar-exports.manual",
+          "data-export.config.item.post",
+          "data-export.config.item.put"
+        ],
+        "visible": true
+      },
+      {
+        "permissionName": "ui-plugin-bursar-export.bursar-exports.manual",
+        "displayName": "Transfer exports: Start manual jobs",
+        "subPermissions": [
+          "ui-plugin-bursar-export.bursar-exports.view",
+          "data-export.job.item.post"
+        ],
+        "visible": true
+      },
+      {
+        "permissionName": "ui-plugin-bursar-export.bursar-exports.view",
+        "displayName": "Transfer exports: View configuration",
         "subPermissions": [
           "settings.tenant-settings.enabled",
           "usergroups.collection.get",
           "owners.collection.get",
           "transfers.collection.get",
           "feefines.collection.get",
-          "data-export.config.collection.get",
-          "data-export.config.item.post",
-          "data-export.config.item.put",
-          "data-export.job.item.post"
+          "inventory-storage.service-points.collection.get",
+          "inventory-storage.location-units.institutions.collection.get",
+          "inventory-storage.location-units.campuses.collection.get",
+          "inventory-storage.location-units.campuses.collection.get",
+          "inventory-storage.location-units.libraries.collection.get",
+          "inventory-storage.locations.collection.get",
+          "data-export.config.collection.get"
         ],
         "visible": true
       }
@@ -47,15 +69,10 @@
     "lint": "eslint .",
     "build-mod-descriptor": "stripes mod descriptor --full --strict | jq '.[]' > module-descriptor.json ",
     "start": "yarn stripes serve",
-    "test:unit": "jest --ci --coverage && yarn run test:unit:report",
-    "test:unit:watch": "jest --ci --coverage --watch",
-    "test:unit:report": "cp -r ./artifacts/coverage-jest ./artifacts/coverage",
-    "test:e2e": "echo Not implemented",
-    "test": "yarn run test:unit && yarn run test:e2e"
+    "test": "jest",
+    "coverage": "jest --coverage"
   },
   "devDependencies": {
-    "@babel/core": "^7.8.0",
-    "@babel/eslint-parser": "^7.18.2",
     "@babel/plugin-proposal-class-properties": "^7.0.0",
     "@babel/plugin-proposal-decorators": "^7.0.0",
     "@babel/plugin-transform-runtime": "^7.0.0",
@@ -65,22 +82,24 @@
     "@folio/jest-config-stripes": "^2.0.0",
     "@folio/stripes": "^9.0.0",
     "@folio/stripes-cli": "^3.0.0",
-    "@formatjs/cli": "^6.1.3",
+    "@formatjs/cli": "^6.2.0",
+    "@types/react": "^18.2.0",
     "core-js": "^3.6.1",
-    "eslint": "^6.2.1",
     "eslint-plugin-filenames": "^1.3.2",
-    "eslint-plugin-jest": "^23.0.4",
-    "faker": "^4.1.0",
+    "identity-obj-proxy": "^3.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "react-intl": "^6.4.4",
     "react-query": "^3.6.0",
     "react-router": "^5.2.0",
     "react-router-dom": "^5.2.0",
-    "regenerator-runtime": "^0.13.3"
+    "regenerator-runtime": "^0.13.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@folio/stripes-acq-components": "~5.0.0",
+    "@ngneat/falso": "^6.4.0",
+    "classnames": "^2.3.2",
     "lodash": "^4.17.5",
     "prop-types": "^15.5.10",
     "react-final-form": "^6.3.0",
@@ -90,6 +109,7 @@
   },
   "peerDependencies": {
     "@folio/stripes": "^9.0.0",
+    "@types/react": "^18.2.0",
     "final-form": "^4.18.2",
     "final-form-arrays": "^3.0.1",
     "react": "^18.2.0",