diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 00000000..0d1ae757 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,4 @@ +{ + "parser": "babel-eslint", + "extends": ["@folio/eslint-config-stripes/acquisitions"] +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..6a8c86a4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# See https://help.github.com/ignore-files/ for more about ignoring files. + +# dependencies +/node_modules +package-lock.json +yarn.lock + +# testing +/coverage + +# production +/build + +# misc +.DS_Store +.env.local +.env.development.local +.env.test.local +.env.production.local + +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Ignore +.sass-cache/* +.css.map/* +**/.sass-cache/* +**/.css.map/* +**/node_modules/* +*.idea* +*.DS_Store + +# stripes +.stripesclirc +stripes.config.js.local + +# tests +/artifacts +junit.xml diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..be2b91ee --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Change history for ui-plugin-bursar-export + +## (in progress) + +### Stories +* Project Setup: ui-plugin-bursar-export. Refs UIPBEX-1. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c6e1e054 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +# Contribution guidelines + +Guidelines for Contributing Code: +[dev.folio.org/guidelines/contributing](https://dev.folio.org/guidelines/contributing) diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..694e509c --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,73 @@ + + +## Purpose + + +## Approach + + +#### TODOS and Open Questions + + +## Learning + + +## Pre-Merge Checklist +Before merging this PR, please go through the following list and take appropriate actions. +- [ ] I've added appropriate record to the CHANGELOG.md +- Does this PR meet or exceed the expected quality standards? + - [ ] Code coverage on new code is 80% or greater + - [ ] Duplications on new code is 3% or less + - [ ] There are no major code smells or security issues +- Does this introduce breaking changes? + - [ ] If any API-related changes - okapi interfaces and permissions are reviewed/changed correspondingly + - [ ] There are no breaking changes in this PR. + +If there are breaking changes, please **STOP** and consider the following: + +- What other modules will these changes impact? +- Do JIRAs exist to update the impacted modules? + - [ ] If not, please create them + - [ ] Do they contain the appropriate level of detail? Which endpoints/schemas changed, etc. + - [ ] Do they have all they appropriate links to blocked/related issues? +- Are the JIRAs under active development? + - [ ] If not, contact the project's PO and make sure they're aware of the urgency. +- Do PRs exist for these changes? + - [ ] If so, have they been approved? + +Ideally all of the PRs involved in breaking changes would be merged in the same day to avoid breaking the folio-testing environment. Communication is paramount if that is to be achieved, especially as the number of intermodule and inter-team dependencies increase. + +While it's helpful for reviewers to help identify potential problems, ensuring that it's safe to merge is ultimately the responsibility of the PR assignee. diff --git a/README.md b/README.md index cef9ff83..cc36d2ae 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# ui-plugin-bursar-export \ No newline at end of file +# ui-plugin-bursar-export + +Copyright (C) 2021 The Open Library Foundation + +This software is distributed under the terms of the Apache License, +Version 2.0. See the file "[LICENSE](LICENSE)" for more information. + +## Introduction + +This package furnishes a single Stripes plugin of type `bursar-export`, +which can be included in Stripes modules by means of a `` element. See [the *Plugins* +section](https://github.com/folio-org/stripes-core/blob/master/doc/dev-guide.md#plugins) +of the Module Developer's Guide. + +This is a [Stripes](https://github.com/folio-org/stripes-core/) UI module to configure bursar export. + +## Additional information + +Other [modules](https://dev.folio.org/source-code/#client-side). + +See project [UIPBEX](https://issues.folio.org/browse/UIPBEX) +at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker). + +Other FOLIO Developer documentation is at [dev.folio.org](https://dev.folio.org/) diff --git a/index.js b/index.js new file mode 100644 index 00000000..59cff294 --- /dev/null +++ b/index.js @@ -0,0 +1 @@ +export { default } from './src'; diff --git a/jest.config.js b/jest.config.js new file mode 100644 index 00000000..b5647e0b --- /dev/null +++ b/jest.config.js @@ -0,0 +1,6 @@ +const commonCofig = require('@folio/stripes-acq-components/jest.config'); + +module.exports = { + ...commonCofig, + coverageDirectory: './artifacts/coverage/', +}; diff --git a/package.json b/package.json new file mode 100644 index 00000000..a7b9171c --- /dev/null +++ b/package.json @@ -0,0 +1,88 @@ +{ + "name": "@folio/plugin-bursar-export", + "version": "1.0.0", + "description": "Bursar export", + "main": "index.js", + "repository": "", + "license": "Apache-2.0", + "engines": { + "node": ">=10" + }, + "stripes": { + "actsAs": [ + "plugin" + ], + "pluginType": "bursar-export", + "displayName": "ui-plugin-bursar-export.meta.title", + "okapiInterfaces": { + }, + "stripesDeps": [ + "@folio/stripes-acq-components" + ], + "permissionSets": [ + { + "permissionName": "ui-plugin-bursar-export.bursar-exports.all", + "displayName": "Bursar exports: Bursar admin", + "subPermissions": [ + ], + "visible": true + } + ] + }, + "scripts": { + "build": "yarn stripes build --output ./output", + "lint": "eslint .", + "start": "yarn stripes serve", + "test": "jest --ci --coverage --passWithNoTests" + }, + "devDependencies": { + "@babel/core": "^7.8.0", + "@babel/plugin-proposal-class-properties": "^7.0.0", + "@babel/plugin-proposal-decorators": "^7.0.0", + "@babel/plugin-transform-runtime": "^7.0.0", + "@babel/preset-env": "^7.0.0", + "@babel/preset-react": "^7.7.4", + "@folio/eslint-config-stripes": "^5.0.0", + "@folio/stripes": "^6.0.0", + "@folio/stripes-cli": "^2.0.0", + "@testing-library/jest-dom": "^5.11.1", + "@testing-library/react": "^11.0.4", + "babel-eslint": "^10.0.0", + "babel-jest": "^26.3.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", + "jest": "^26.4.2", + "jest-css-modules": "^2.1.0", + "jest-junit": "^11.1.0", + "react": "^16.5.1", + "react-dom": "^16.5.1", + "react-intl": "^5.8.1", + "react-router": "^5.2.0", + "react-router-dom": "^5.2.0", + "regenerator-runtime": "^0.13.3" + }, + "dependencies": { + "@folio/stripes-acq-components": "^2.1.0", + "final-form": "^4.18.2", + "final-form-arrays": "^3.0.1", + "lodash": "^4.17.5", + "prop-types": "^15.5.10", + "react-final-form": "^6.3.0", + "react-final-form-arrays": "^3.1.0", + "react-final-form-listeners": "^1.0.2", + "react-hot-loader": "^4.3.12", + "react-router-prop-types": "^1.0.4", + "uuid": "^3.0.1" + }, + "peerDependencies": { + "@folio/stripes": "^6.0.0", + "react": "*", + "react-intl": "^5.8.1", + "react-router": "^5.2.0", + "react-router-dom": "^5.2.0" + } +} diff --git a/src/BursarExports.js b/src/BursarExports.js new file mode 100644 index 00000000..b8b8c719 --- /dev/null +++ b/src/BursarExports.js @@ -0,0 +1,3 @@ +export const BursarExports = () => { + return 'BursarExports'; +}; diff --git a/src/index.js b/src/index.js new file mode 100644 index 00000000..e26bb3ad --- /dev/null +++ b/src/index.js @@ -0,0 +1 @@ +export { BursarExports as default } from './BursarExports'; diff --git a/translations/ui-plugin-bursar-export/en.json b/translations/ui-plugin-bursar-export/en.json new file mode 100644 index 00000000..3b65ae67 --- /dev/null +++ b/translations/ui-plugin-bursar-export/en.json @@ -0,0 +1,5 @@ +{ + "meta.title": "Bursar exports", + + "permission.bursar-exports.all": "Bursar exports: Bursar admin" +}