diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 000000000..3e8df19a9 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,22 @@ +{ + parser: "babel-eslint", + extends: "airbnb", + settings: { + 'import/resolver': { + webpack: {} + } + }, + env: { + browser: true + }, + rules: { + "react/jsx-filename-extension":"off", + "import/extensions": [ 1, "never" ], + "no-console": "off", + "react/forbid-prop-types": [ 1, { 'forbid' : [ 'any', 'array' ] } ], + "no-unused-vars": [ 1, { argsIgnorePattern: "^_" } ], + "max-len": "off", + "no-restricted-syntax": ["error", "LabeledStatement", "WithStatement"], + "no-plusplus": "off" + } +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..239ecff13 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +yarn.lock diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..7dd531d83 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +# Change history for stripes-util-notes + +## 0.0.1 (IN PROGRESS) + +* First version to have a documented change-log. Each subsequent version will + describe its differences from the previous one. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c386f2886 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +# Contribution guidelines + +Guidelines for Contributing Code: +[dev.folio.org/community/contrib-code](http://dev.folio.org/community/contrib-code) diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..8dada3eda --- /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/NotesPane.js b/NotesPane.js new file mode 100644 index 000000000..4dbf7a6f9 --- /dev/null +++ b/NotesPane.js @@ -0,0 +1,96 @@ +import React from 'react'; +import PropTypes from 'prop-types'; +import Notes from '@folio/stripes-components/lib/structures/Notes'; + +class NotesPane extends React.Component { + static propTypes = { + stripes: PropTypes.object.isRequired, + onToggle: PropTypes.func, + mutator: PropTypes.shape({ + notes: PropTypes.shape({ + POST: PropTypes.func, + DELETE: PropTypes.func, + PUT: PropTypes.func, + }), + }).isRequired, + resources: PropTypes.shape({ + notes: PropTypes.shape({ + records: PropTypes.arrayOf(PropTypes.object), + }), + }), + match: PropTypes.shape({ + params: PropTypes.shape({ + id: PropTypes.string.isRequired, + }), + }).isRequired, + link: PropTypes.string, + } + + static manifest = Object.freeze({ + notes: { + type: 'okapi', + path: 'notes', + records: 'notes', + clear: false, + GET: { + params: { + query: 'link=:{id}', + }, + }, + }, + }); + + constructor(props) { + super(props); + + this.state = { + updating: false, + }; + + this.handleDelete = this.handleDelete.bind(this); + this.handleSubmit = this.handleSubmit.bind(this); + this.handleUpdate = this.handleUpdate.bind(this); + } + + handleSubmit(note) { + this.setState({ updating: true }); + this.props.mutator.notes.POST(note) + .then(() => { + this.setState({ updating: false }); + }); + } + + handleUpdate(note) { + this.setState({ updating: true }); + this.props.mutator.notes.PUT({ + id: note.id, + link: note.link, + text: note.text, + }) + .then(() => { + this.setState({ updating: false }); + }); + } + + handleDelete(id) { + this.setState({ updating: true }); + this.props.mutator.notes.DELETE({ id }) + .then(() => { + this.setState({ updating: false }); + }); + } + + render() { + return (); + } +} + +export default NotesPane; diff --git a/README.md b/README.md index e3568ea70..402496cfc 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# stripes-util-notes \ No newline at end of file +# stripes-util-notes +Copyright (C) 2017 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 is a [Stripes](https://github.com/folio-org/stripes-core/) utility module +for attaching notes to entities such as users and items. + +## Additional information + +Other [modules](http://dev.folio.org/source-code/#client-side). + +See project [STUTILNOTE](https://issues.folio.org/browse/STUTILNOTE/) +at the [FOLIO issue tracker](http://dev.folio.org/community/guide-issues). + +Other FOLIO Developer documentation is at [dev.folio.org](http://dev.folio.org/) diff --git a/package.json b/package.json new file mode 100644 index 000000000..2f3340d0d --- /dev/null +++ b/package.json @@ -0,0 +1,112 @@ +{ + "name": "@folio/util-notes", + "version": "0.1.0", + "description": "Notes management", + "repository": "folio-org/stripes-util-notes", + "publishConfig": { + "registry": "https://repository.folio.org/repository/npm-folio/" + }, + "license": "Apache-2.0", + "engines": { + "node": ">=6.0.0" + }, + "main": "NotesPane.js", + "stripes": { + "type": "app", + "displayName": "Notes", + "okapiInterfaces": { + "notes": "1.0" + }, + "permissionSets": [ + { + "permissionName": "module.notes.enabled", + "displayName": "UI: Notes module is enabled" + }, + { + "permissionName": "stripes-util-notes.all", + "displayName": "Notes: All permissions", + "description": "Entire set of permissions needed to use the notes module", + "subPermissions": [ + "notes.all" + ], + "visible": true + }, + { + "permissionName": "stripes-util-notes.view", + "displayName": "Notes: Can view notes", + "description": "Can view notes", + "subPermissions": [ + "notes.collection.get", + "notes.item.get" + ], + "visible": true + }, + { + "permissionName": "stripes-util-notes.edit", + "displayName": "Notes: Can update notes", + "description": "Can update notes", + "subPermissions": [ + "stripes-util-notes.view", + "notes.item.put" + ], + "visible": true + }, + { + "permissionName": "stripes-util-notes.create", + "displayName": "Notes: Can create notes", + "description": "Can create notes", + "subPermissions": [ + "stripes-util-notes.view", + "notes.item.post" + ], + "visible": true + }, + { + "permissionName": "stripes-util-notes.delete", + "displayName": "Notes: Can delete notes", + "description": "Can delete notes", + "subPermissions": [ + "stripes-util-notes.view", + "notes.item.post" + ], + "visible": true + } + ] + }, + "scripts": { + "lint": "eslint *.js lib settings || true" + }, + "devDependencies": { + "babel-core": "^6.17.0", + "babel-eslint": "^7.0.0", + "babel-preset-es2015": "^6.18.0", + "babel-preset-react": "^6.16.0", + "babel-preset-stage-0": "^6.16.0", + "babel-register": "^6.18.0", + "eslint": "^3.8.0", + "eslint-config-airbnb": "^13.0.0", + "eslint-import-resolver-webpack": "0.7.1", + "eslint-plugin-babel": "^3.3.0", + "eslint-plugin-import": "^2.0.1", + "eslint-plugin-jsx-a11y": "^2.2.3", + "eslint-plugin-react": "^6.4.1", + "webpack": "1.11.0" + }, + "dependencies": { + "@folio/stripes-components": "^1.7.0", + "@folio/stripes-form": "^0.8.0", + "@folio/stripes-logger": "^0.0.2", + "lodash": "^4.17.4", + "prop-types": "^15.5.10", + "query-string": "^5.0.0", + "react": "^15.4.2", + "react-bootstrap": "^0.31.1", + "react-flexbox-grid": "^1.1.3", + "react-router-dom": "^4.0.0", + "redux-form": "^7.0.3" + }, + "peerDependencies": { + "@folio/stripes-connect": "^2.3.0", + "@folio/stripes-core": "^1.13.0" + } +}