Repository: TechniqueSoftware/react-json-schema Branch: master Commit: a2b131735caa Files: 22 Total size: 51.5 KB Directory structure: gitextract_o5ehm8il/ ├── .eslintignore ├── .eslintrc ├── .gitignore ├── CONTRIBUTE.md ├── LICENSE ├── README.md ├── demo/ │ ├── components/ │ │ ├── CheckboxField.jsx │ │ ├── ContactForm.jsx │ │ └── StringField.jsx │ ├── index.html │ ├── index.jsx │ ├── package.json │ └── webpack.config.js ├── dist/ │ └── react-json-schema.js ├── lib/ │ └── ReactJsonSchema.js ├── package.json ├── spec/ │ ├── ReactJsonSchemaSpec.js │ ├── index.html │ ├── spec.entry.js │ └── support/ │ └── jasmine.json ├── webpack.config.dist.js └── webpack.config.spec.js ================================================ FILE CONTENTS ================================================ ================================================ FILE: .eslintignore ================================================ demo spec/spec.js *.md webpack.config.spec.js ================================================ FILE: .eslintrc ================================================ { "extends": "airbnb", "rules": { "comma-dangle": 0, "object-curly-newline": ["error", { "multiline": true, "minProperties": 5 }] }, "parserOptions": { "ecmaVersion": 6, "sourceType": "module", "ecmaFeatures": { "jsx": true, "experimentalObjectRestSpread": true } } } ================================================ FILE: .gitignore ================================================ .DS_Store .idea .iml .git node_modules npm-debug.log spec/spec.js demo/build ================================================ FILE: CONTRIBUTE.md ================================================ # Contributing Code of Conduct: Don't intentionally offend others, and don't look for offense from others. [Open an issue](https://github.com/TechniqueSoftware/react-json-schema/issues/new) to start a converstation about anything related to this project. To participate by contributing, start by cloning the repo: git clone https://github.com/TechniqueSoftware/react-json-schema.git Then install the node modules: npm install Make your changes using an IDE that has a linter that recognizes ESLint enabled. Write and run tests: npm test Test your contribution using the demo as a playground (http://localhost:8080): npm run demo Consider the maintainer's commitments and expectations found below before submitting a pull request. If you submit a pull request, briefly explain your changes. If your contribution relates to an existing issue, please link the issue in the pull request. These are the maintainer's commitments to package users and contributers: * Any contribution must undergo code review before being accepted * Any contribution must have associated tests, and all tests must pass, before being accepted * Maintainers build each release; it's not necessary for you to commit a build if you do not need to use your fork immediately * Maintainers release the package using [semantic versioning](https://semver.org/) These are the maintainer's expectations: * Contributions align with the project's purpose: "This library constructs React elements from JSON by mapping JSON definitions to React components that you expose" * You have used a linter and have followed the ESLint style guide ================================================ FILE: LICENSE ================================================ 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 2015-2018 Technique Software 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. ================================================ FILE: README.md ================================================ # react-json-schema `npm install react-json-schema` Construct React elements from JSON by mapping JSON definitions to React components. Use react-json-schema for data-driven layouts, or as an abstraction layer for React components and props. Render anywhere (as long as it's DOM)! Since react-json-schema does not perform any rendering, the method in which you want to render is up to you. For example, you can use ReactDOMServer.render, ReactDOM.renderToString, etc. if you'd like. This also means JSX is not a dependency for react-json-schema. [Quick Documentation and Examples](http://techniquesoftware.github.io/react-json-schema/) ### Full Documentation * [Schema](#schema) * [Dynamic Children and Keys](#dynamic-children-and-keys) * [Component Mapping](#component-mapping) * [Complete Example](#complete-example) #### Schema The primary resource needed is a defined schema in JSON or a JavaScript object literal. It's recommended that schema attributes mainly define React component props. The parser explicitly handles the following attributes: - **component**: _MUST_ exist and be defined by a string or React component (must be a string if describing a native HTML tag) - **children**: _MAY_ exist to define sub-components - **text**: _MAY_ exist to as a string to define inner HTML text (overrides children) - **key**: _MAY_ exist to define a key for dynamic children Example JSON schema ```js const schema = { "component": "CommentList", "children": [ { "component": "Comment", "author": "Pete Hunt", "children": "This is one comment" }, { "component": "Comment", "author": "Jordan Walke", "children": "This is *another* comment" }, { "component": "a", "href": "#help", "text": "I need help" } ] }; ``` Example JS literal ```js ... { "component": Comment, "author": "Pete Hunt", "children": "This is one comment" }, ... ``` ##### Dynamic Children and Keys When arrays of components exist (like children), react-json-schema will resolve a key for the element, which follows the rules for [dynamic children](https://facebook.github.io/react/docs/multiple-components.html#dynamic-children). It will either use a custom key if defined, or resolve a numeric key based on the array index. Example of defining child keys ```js ... { "component": "Comment", "key": "0ab19f8e", // defined key "author": "Pete Hunt", "children": "This is one comment" }, ... ``` #### Component Mapping React components need to be exposed to the react-json-schema so that the parser can create React elements. If the schema contains object literals with component references, the schema is exposing the React components and no additional configuration is needed. If the schema does not contain references to components, the components can be exposed via `setComponentMap`. Example for exposing non-exposed components (ES6) ```js /* es6 object literal shorthand: { ContactForm } == { ContactForm: ContactForm } */ contactForm.setComponentMap({ ContactForm, StringField }); ``` #### Parsing Use `parseSchema` to render React elements. It returns the root node. Note that if your schema's root is an array, you'll have to wrap the schema in an element. Example (ES6) ```js ReactDOM.render(contactForm.parseSchema(schema), document.getElementById('contact-form')); ``` #### Complete Example ```js import ReactDOM from 'react-dom'; import ReactJsonSchema from 'react-json-schema'; import FormStore from 'FormStore'; import CommentList from 'CommentList'; import Comment from 'Comment'; // For this example, let's pretend I already have data and am ignorant of actions const schema = FormStore.getFormSchema(); const view = new ReactJsonSchema(); view.setComponentMap({ CommentList, Comment }); ReactDOM.render(view.parseSchema(schema), document.getElementById('content')); ``` ### Demo an Example Codebase To run the demo * `cd demo && npm install` * `npm start` * The app will be served at http://localhost:8080 ### Contribution and Code of Conduct If you'd like to ask a question, raise a concern, or contribute, please follow our [contribution guidelines](CONTRIBUTE.md). ### Alternatives * [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form): A React component for building Web forms from JSON Schema. This library further abstracts React components, making it easier to build forms. Also, it comes with components. React-json-schema is a lighter alternative that allows the use of any components. ### Roadmap * Playground on our public site for discoverability * Possibility of react-native-json-schema ================================================ FILE: demo/components/CheckboxField.jsx ================================================ import React from 'react'; import PropTypes from 'prop-types'; import { FormGroup,Radio } from 'react-bootstrap'; class CheckboxField extends React.Component { constructor(props) { super(props); } renderCheckboxes() { const checkboxes = []; this.props.checkboxes.forEach(function loop(checkbox, index) { checkboxes.push( {checkbox.label} ); }); return checkboxes; } render() { const checkboxes = this.renderCheckboxes(); return ( {checkboxes} ); } } CheckboxField.propTypes = { checkboxes: PropTypes.arrayOf( PropTypes.shape({ label: PropTypes.string.isRequired }).isRequired ).isRequired }; export default CheckboxField; ================================================ FILE: demo/components/ContactForm.jsx ================================================ import React from 'react'; import PropTypes from 'prop-types'; import { Button, Grid, Col, Row } from 'react-bootstrap'; class ContactForm extends React.Component { constructor(props) { super(props); } alertSubmit() { alert('Hey, you submitted the form!'); } render() { return (

{this.props.title}

{this.props.children}
); } } ContactForm.propTypes = { title: PropTypes.string.isRequired, children: PropTypes.arrayOf(PropTypes.element) }; export default ContactForm; ================================================ FILE: demo/components/StringField.jsx ================================================ import React from 'react'; import PropTypes from 'prop-types'; import { FormGroup, ControlLabel, FormControl, HelpBlock } from 'react-bootstrap'; const alphaRegex = /^$|[A-Z]+$/i; class StringField extends React.Component { constructor(props) { super(props); this.state = { value: '' }; } validateInput(event) { if (alphaRegex.test(event.target.value)) { this.setState({ value: event.target.value }); } } render() { const { label, name, help, ...rest } = this.props; return ( {label} {help && {help}} ); } } StringField.propTypes = { label: PropTypes.string.isRequired, name: PropTypes.string.isRequired, help: PropTypes.string }; export default StringField; ================================================ FILE: demo/index.html ================================================ Demo: react-json-schema
================================================ FILE: demo/index.jsx ================================================ import ReactDOM from 'react-dom'; import ContactForm from './components/ContactForm'; import StringField from './components/StringField'; import CheckboxField from './components/CheckboxField'; // If a package dependency: import ReactJsonSchema from 'react-json-schema'; import ReactJsonSchema from '../lib/ReactJsonSchema'; const welcomeSchema = { 'component': 'h2', 'className': 'text-center', 'text': 'Hello World!' }; const welcomeBanner = new ReactJsonSchema(); ReactDOM.render(welcomeBanner.parseSchema(welcomeSchema), document.getElementById('welcome-banner')); const formSchema = { 'component': 'ContactForm', 'title': 'Tell us a little about yourself, we\'d appreciate it', 'children': [ { 'component': 'StringField', 'label': 'What\'s your name', 'name': 'fullname', 'help': 'It\'s okay, don\'t be shy :)' }, { 'component': 'CheckboxField', 'checkboxes': [ { 'label': 'I\'m already checked!', 'defaultChecked': true, 'key': 0 }, { 'label': 'Here\'s another', 'key': 10 } ] } ] }; const componentMap = { ContactForm, StringField, CheckboxField }; const contactForm = new ReactJsonSchema(); contactForm.setComponentMap(componentMap); ReactDOM.render(contactForm.parseSchema(formSchema), document.getElementById('json-react-schema')); ================================================ FILE: demo/package.json ================================================ { "name": "react-json-schema-demo", "version": "1.0.0", "description": "Need to test ReactJsonSchema in the wild? This is where you'd do it.", "author": { "name": "A collaborative project overseen by Club OS", "url": "https://club-os.com/" }, "repository": { "type": "git", "url": "https://github.com/TechniqueSoftware/react-json-schema" }, "license": "Apache-2.0", "bugs": { "url": "https://github.com/TechniqueSoftware/react-json-schema/issues" }, "scripts": { "start": "webpack-dev-server --progress --colors --inline" }, "engines": { "node": ">=6.4.0" }, "devDependencies": { "ajv": "^6.1.1", "bootstrap": "^3.3.7", "file-loader": "^1.1.6", "path": "^0.12.7", "prop-types": "^15.6.0", "react-bootstrap": "^0.32.1", "react-dom": "^16.2.0", "webpack": "^3.11.0", "webpack-dev-server": "^2.11.1" }, "dependencies": { "react": "^16.3.2" } } ================================================ FILE: demo/webpack.config.js ================================================ const path = require('path'); module.exports = { entry: path.join(__dirname, 'index.jsx'), output: { filename: 'bundle.js', path: path.join(__dirname, 'build') }, module: { rules: [ { test: /\.(js|jsx)$/, exclude: [ path.join(__dirname, '../dist'), /node_modules/ ], use: [{ loader: 'babel-loader', options: { presets: ['react', 'env'], plugins: ['transform-es2015-destructuring', 'transform-object-rest-spread'] } }] } ] }, resolve: { modules: [ path.join(__dirname, '../lib'), path.join(__dirname, '../dist'), 'node_modules' ], extensions: ['.js', '.json', '.jsx'] } }; ================================================ FILE: dist/react-json-schema.js ================================================ (function webpackUniversalModuleDefinition(root, factory) { if(typeof exports === 'object' && typeof module === 'object') module.exports = factory(require("react")); else if(typeof define === 'function' && define.amd) define(["react"], factory); else if(typeof exports === 'object') exports["ReactJsonSchema"] = factory(require("react")); else root["ReactJsonSchema"] = factory(root["React"]); })(typeof self !== 'undefined' ? self : this, function(__WEBPACK_EXTERNAL_MODULE_0__) { return /******/ (function(modules) { // webpackBootstrap /******/ // The module cache /******/ var installedModules = {}; /******/ /******/ // The require function /******/ function __webpack_require__(moduleId) { /******/ /******/ // Check if module is in cache /******/ if(installedModules[moduleId]) { /******/ return installedModules[moduleId].exports; /******/ } /******/ // Create a new module (and put it into the cache) /******/ var module = installedModules[moduleId] = { /******/ i: moduleId, /******/ l: false, /******/ exports: {} /******/ }; /******/ /******/ // Execute the module function /******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); /******/ /******/ // Flag the module as loaded /******/ module.l = true; /******/ /******/ // Return the exports of the module /******/ return module.exports; /******/ } /******/ /******/ /******/ // expose the modules object (__webpack_modules__) /******/ __webpack_require__.m = modules; /******/ /******/ // expose the module cache /******/ __webpack_require__.c = installedModules; /******/ /******/ // define getter function for harmony exports /******/ __webpack_require__.d = function(exports, name, getter) { /******/ if(!__webpack_require__.o(exports, name)) { /******/ Object.defineProperty(exports, name, { /******/ configurable: false, /******/ enumerable: true, /******/ get: getter /******/ }); /******/ } /******/ }; /******/ /******/ // getDefaultExport function for compatibility with non-harmony modules /******/ __webpack_require__.n = function(module) { /******/ var getter = module && module.__esModule ? /******/ function getDefault() { return module['default']; } : /******/ function getModuleExports() { return module; }; /******/ __webpack_require__.d(getter, 'a', getter); /******/ return getter; /******/ }; /******/ /******/ // Object.prototype.hasOwnProperty.call /******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; /******/ /******/ // __webpack_public_path__ /******/ __webpack_require__.p = ""; /******/ /******/ // Load entry module and return exports /******/ return __webpack_require__(__webpack_require__.s = 1); /******/ }) /************************************************************************/ /******/ ([ /* 0 */ /***/ (function(module, exports) { module.exports = __WEBPACK_EXTERNAL_MODULE_0__; /***/ }), /* 1 */ /***/ (function(module, exports, __webpack_require__) { "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }(); var _react = __webpack_require__(0); var _reactDomFactories = __webpack_require__(2); var _reactDomFactories2 = _interopRequireDefault(_reactDomFactories); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _objectWithoutProperties(obj, keys) { var target = {}; for (var i in obj) { if (keys.indexOf(i) >= 0) continue; if (!Object.prototype.hasOwnProperty.call(obj, i)) continue; target[i] = obj[i]; } return target; } function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } } var componentMapCollection = new WeakMap(); var ReactJsonSchema = function () { function ReactJsonSchema() { _classCallCheck(this, ReactJsonSchema); } _createClass(ReactJsonSchema, [{ key: 'parseSchema', value: function parseSchema(schema) { var element = null; var elements = null; if (Array.isArray(schema)) { elements = this.parseSubSchemas(schema); } else if (schema) { element = this.createComponent(schema); } return element || elements; } }, { key: 'parseSubSchemas', value: function parseSubSchemas() { var _this = this; var subSchemas = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : []; var Components = []; var index = 0; Object.keys(subSchemas).forEach(function (key) { var subSchema = subSchemas[key]; subSchema.key = typeof subSchema.key !== 'undefined' ? subSchema.key : index; Components.push(_this.parseSchema(subSchema)); index += 1; }); return Components; } }, { key: 'createComponent', value: function createComponent(schema) { // eslint-disable-next-line no-unused-vars var component = schema.component, children = schema.children, text = schema.text, rest = _objectWithoutProperties(schema, ['component', 'children', 'text']); var Component = this.resolveComponent(schema); var Children = typeof text !== 'undefined' ? text : this.resolveComponentChildren(schema); return (0, _react.createElement)(Component, rest, Children); } }, { key: 'resolveComponent', value: function resolveComponent(schema) { var componentMap = this.getComponentMap(); var Component = null; if (Object.prototype.hasOwnProperty.call(schema, 'component')) { if (schema.component === Object(schema.component)) { Component = schema.component; } else if (componentMap && componentMap[schema.component]) { Component = componentMap[schema.component]; } else if (Object.prototype.hasOwnProperty.call(_reactDomFactories2.default, schema.component)) { Component = schema.component; } } else { throw new Error('ReactJsonSchema could not resolve a component due to a missing component \n attribute in the schema.'); } return Component; } }, { key: 'resolveComponentChildren', value: function resolveComponentChildren(schema) { return Object.prototype.hasOwnProperty.call(schema, 'children') ? this.parseSchema(schema.children) : undefined; } }, { key: 'getComponentMap', value: function getComponentMap() { return componentMapCollection.get(this); } }, { key: 'setComponentMap', value: function setComponentMap(componentMap) { componentMapCollection.set(this, componentMap); } }]); return ReactJsonSchema; }(); exports.default = ReactJsonSchema; /***/ }), /* 2 */ /***/ (function(module, exports, __webpack_require__) { "use strict"; /** * Copyright (c) 2015-present, Facebook, Inc. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ (function(f) { if (true) { module.exports = f(__webpack_require__(0)); /* global define */ } else if (typeof define === 'function' && define.amd) { define(['react'], f); } else { var g; if (typeof window !== 'undefined') { g = window; } else if (typeof global !== 'undefined') { g = global; } else if (typeof self !== 'undefined') { g = self; } else { g = this; } if (typeof g.React === 'undefined') { throw Error('React module should be required before ReactDOMFactories'); } g.ReactDOMFactories = f(g.React); } })(function(React) { /** * Create a factory that creates HTML tag elements. */ function createDOMFactory(type) { var factory = React.createElement.bind(null, type); // Expose the type on the factory and the prototype so that it can be // easily accessed on elements. E.g. `.type === Foo`. // This should not be named `constructor` since this may not be the function // that created the element, and it may not even be a constructor. factory.type = type; return factory; }; /** * Creates a mapping from supported HTML tags to `ReactDOMComponent` classes. */ var ReactDOMFactories = { a: createDOMFactory('a'), abbr: createDOMFactory('abbr'), address: createDOMFactory('address'), area: createDOMFactory('area'), article: createDOMFactory('article'), aside: createDOMFactory('aside'), audio: createDOMFactory('audio'), b: createDOMFactory('b'), base: createDOMFactory('base'), bdi: createDOMFactory('bdi'), bdo: createDOMFactory('bdo'), big: createDOMFactory('big'), blockquote: createDOMFactory('blockquote'), body: createDOMFactory('body'), br: createDOMFactory('br'), button: createDOMFactory('button'), canvas: createDOMFactory('canvas'), caption: createDOMFactory('caption'), cite: createDOMFactory('cite'), code: createDOMFactory('code'), col: createDOMFactory('col'), colgroup: createDOMFactory('colgroup'), data: createDOMFactory('data'), datalist: createDOMFactory('datalist'), dd: createDOMFactory('dd'), del: createDOMFactory('del'), details: createDOMFactory('details'), dfn: createDOMFactory('dfn'), dialog: createDOMFactory('dialog'), div: createDOMFactory('div'), dl: createDOMFactory('dl'), dt: createDOMFactory('dt'), em: createDOMFactory('em'), embed: createDOMFactory('embed'), fieldset: createDOMFactory('fieldset'), figcaption: createDOMFactory('figcaption'), figure: createDOMFactory('figure'), footer: createDOMFactory('footer'), form: createDOMFactory('form'), h1: createDOMFactory('h1'), h2: createDOMFactory('h2'), h3: createDOMFactory('h3'), h4: createDOMFactory('h4'), h5: createDOMFactory('h5'), h6: createDOMFactory('h6'), head: createDOMFactory('head'), header: createDOMFactory('header'), hgroup: createDOMFactory('hgroup'), hr: createDOMFactory('hr'), html: createDOMFactory('html'), i: createDOMFactory('i'), iframe: createDOMFactory('iframe'), img: createDOMFactory('img'), input: createDOMFactory('input'), ins: createDOMFactory('ins'), kbd: createDOMFactory('kbd'), keygen: createDOMFactory('keygen'), label: createDOMFactory('label'), legend: createDOMFactory('legend'), li: createDOMFactory('li'), link: createDOMFactory('link'), main: createDOMFactory('main'), map: createDOMFactory('map'), mark: createDOMFactory('mark'), menu: createDOMFactory('menu'), menuitem: createDOMFactory('menuitem'), meta: createDOMFactory('meta'), meter: createDOMFactory('meter'), nav: createDOMFactory('nav'), noscript: createDOMFactory('noscript'), object: createDOMFactory('object'), ol: createDOMFactory('ol'), optgroup: createDOMFactory('optgroup'), option: createDOMFactory('option'), output: createDOMFactory('output'), p: createDOMFactory('p'), param: createDOMFactory('param'), picture: createDOMFactory('picture'), pre: createDOMFactory('pre'), progress: createDOMFactory('progress'), q: createDOMFactory('q'), rp: createDOMFactory('rp'), rt: createDOMFactory('rt'), ruby: createDOMFactory('ruby'), s: createDOMFactory('s'), samp: createDOMFactory('samp'), script: createDOMFactory('script'), section: createDOMFactory('section'), select: createDOMFactory('select'), small: createDOMFactory('small'), source: createDOMFactory('source'), span: createDOMFactory('span'), strong: createDOMFactory('strong'), style: createDOMFactory('style'), sub: createDOMFactory('sub'), summary: createDOMFactory('summary'), sup: createDOMFactory('sup'), table: createDOMFactory('table'), tbody: createDOMFactory('tbody'), td: createDOMFactory('td'), textarea: createDOMFactory('textarea'), tfoot: createDOMFactory('tfoot'), th: createDOMFactory('th'), thead: createDOMFactory('thead'), time: createDOMFactory('time'), title: createDOMFactory('title'), tr: createDOMFactory('tr'), track: createDOMFactory('track'), u: createDOMFactory('u'), ul: createDOMFactory('ul'), var: createDOMFactory('var'), video: createDOMFactory('video'), wbr: createDOMFactory('wbr'), // SVG circle: createDOMFactory('circle'), clipPath: createDOMFactory('clipPath'), defs: createDOMFactory('defs'), ellipse: createDOMFactory('ellipse'), g: createDOMFactory('g'), image: createDOMFactory('image'), line: createDOMFactory('line'), linearGradient: createDOMFactory('linearGradient'), mask: createDOMFactory('mask'), path: createDOMFactory('path'), pattern: createDOMFactory('pattern'), polygon: createDOMFactory('polygon'), polyline: createDOMFactory('polyline'), radialGradient: createDOMFactory('radialGradient'), rect: createDOMFactory('rect'), stop: createDOMFactory('stop'), svg: createDOMFactory('svg'), text: createDOMFactory('text'), tspan: createDOMFactory('tspan'), }; // due to wrapper and conditionals at the top, this will either become // `module.exports ReactDOMFactories` if that is available, // otherwise it will be defined via `define(['react'], ReactDOMFactories)` // if that is available, // otherwise it will be defined as global variable. return ReactDOMFactories; }); /***/ }) /******/ ]); }); ================================================ FILE: lib/ReactJsonSchema.js ================================================ import { createElement } from 'react'; import DOM from 'react-dom-factories'; const componentMapCollection = new WeakMap(); export default class ReactJsonSchema { parseSchema(schema) { let element = null; let elements = null; if (Array.isArray(schema)) { elements = this.parseSubSchemas(schema); } else if (schema) { element = this.createComponent(schema); } return element || elements; } parseSubSchemas(subSchemas = []) { const Components = []; let index = 0; Object.keys(subSchemas).forEach((key) => { const subSchema = subSchemas[key]; subSchema.key = typeof subSchema.key !== 'undefined' ? subSchema.key : index; Components.push(this.parseSchema(subSchema)); index += 1; }); return Components; } createComponent(schema) { // eslint-disable-next-line no-unused-vars const { component, children, text, ...rest } = schema; const Component = this.resolveComponent(schema); const Children = typeof text !== 'undefined' ? text : this.resolveComponentChildren(schema); return createElement(Component, rest, Children); } resolveComponent(schema) { const componentMap = this.getComponentMap(); let Component = null; if (Object.prototype.hasOwnProperty.call(schema, 'component')) { if (schema.component === Object(schema.component)) { Component = schema.component; } else if (componentMap && componentMap[schema.component]) { Component = componentMap[schema.component]; } else if (Object.prototype.hasOwnProperty.call(DOM, schema.component)) { Component = schema.component; } } else { throw new Error(`ReactJsonSchema could not resolve a component due to a missing component attribute in the schema.`); } return Component; } resolveComponentChildren(schema) { return (Object.prototype.hasOwnProperty.call(schema, 'children')) ? this.parseSchema(schema.children) : undefined; } getComponentMap() { return componentMapCollection.get(this); } setComponentMap(componentMap) { componentMapCollection.set(this, componentMap); } } ================================================ FILE: package.json ================================================ { "name": "react-json-schema", "version": "1.2.2", "description": "Write component schema in JSON; parse to create react elements.", "keywords": [ "react", "JSON", "schema", "components" ], "author": { "name": "A collaborative project overseen by Club OS", "url": "https://club-os.com/" }, "repository": { "type": "git", "url": "https://github.com/TechniqueSoftware/react-json-schema" }, "license": "Apache-2.0", "bugs": { "url": "https://github.com/TechniqueSoftware/react-json-schema/issues" }, "scripts": { "build": "eslint lib/ReactJsonSchema.js && webpack --progress --profile --colors --config webpack.config.dist.js", "jasmine": "eslint lib/ReactJsonSchema.js && jasmine spec/spec.js", "pretest": "eslint lib/ReactJsonSchema.js && webpack --progress --profile --colors --config webpack.config.spec.js", "test": "npm run jasmine", "preversion": "npm run jasmine", "version": "npm run build && git add -A", "postversion": "git push origin master && git push origin --tags" }, "main": "dist/react-json-schema.js", "files": [ "lib", "dist" ], "engines": { "node": ">=6.4.0" }, "peerDependencies": { "react": ">=15" }, "devDependencies": { "babel-core": "^6.26.3", "babel-eslint": "^8.2.1", "babel-loader": "^7.1.2", "babel-plugin-transform-es2015-destructuring": "^6.23.0", "babel-plugin-transform-object-rest-spread": "^6.26.0", "babel-preset-env": "^1.7.0", "babel-preset-react": "^6.24.1", "clean-webpack-plugin": "^0.1.18", "eslint": "^4.17.0", "eslint-config-airbnb": "^16.1.0", "eslint-plugin-import": "^2.8.0", "eslint-plugin-jsx-a11y": "^6.0.3", "eslint-plugin-react": "^7.6.1", "jasmine": "^2.99.0", "path": "^0.12.7", "react": "^16.2.0", "uglifyjs-webpack-plugin": "^1.2.5", "webpack": "^3.11.0" }, "dependencies": { "react-dom-factories": "^1.0.2" } } ================================================ FILE: spec/ReactJsonSchemaSpec.js ================================================ /* global jasmine, beforeEach, describe, it, expect, spyOn */ /* eslint max-len: 0 */ import React from 'react'; import ReactJsonSchema from '../lib/ReactJsonSchema'; let reactJsonSchema; let schema; export default describe('ReactJsonSchema', () => { class Tester extends React.Component { // eslint-disable-line render() { React.createElement('h1', null, 'Tester!!!!'); } } beforeEach(() => { reactJsonSchema = new ReactJsonSchema(); /* eslint-disable */ schema = { "component": Tester, "someProp": "I'm a tester" }; /* eslint-enable */ }); describe('when parsing schema', () => { it('should allow children to have a null value', () => { const component = reactJsonSchema.parseSchema({ component: 'input', children: null, value: 'test' }); expect(React.isValidElement()).toBe(true); }); it('should return an array of React elements when schema\'s root type is of type array.', () => { const actual = reactJsonSchema.parseSchema([schema]); expect(Array.isArray(actual)).toBe(true); const component = actual[0]; expect(React.isValidElement()).toBe(true); }); it('should return a root React element when the schema\'s root type is of type object.', () => { const actual = reactJsonSchema.parseSchema(schema); expect(actual === Object(actual)).toBe(true); }); }); describe('when parsing sub-schemas', () => { it('should return an empty array when no schemas are passed as an argument.', () => { const actual = reactJsonSchema.parseSubSchemas(); expect(Array.isArray(actual)).toBe(true); }); it('should return an array of React elements when valid schemas are passed as an argument.', () => { const subSchemas = [schema, schema]; const actual = reactJsonSchema.parseSubSchemas(subSchemas); expect(!!actual.length).toBe(true); expect(actual[0] === Object(actual[0])).toBe(true); }); it('should construct sub-schema React elements by parsing each sub-schema.', () => { const subSchemas = [schema, schema]; spyOn(reactJsonSchema, 'parseSchema'); reactJsonSchema.parseSubSchemas(subSchemas); expect(reactJsonSchema.parseSchema).toHaveBeenCalled(); }); it('should consume a key defined in the schema\'s keys for the current sub-schema based on the current sub-schema\'s index to meet React\'s key expectation of multiple React elements.', () => { const subSchemas = [Object.assign({}, schema), Object.assign({}, schema)]; for (const subSchema of subSchemas) { subSchema.key = Math.random(); } spyOn(reactJsonSchema, 'parseSchema'); reactJsonSchema.parseSubSchemas(subSchemas); expect(reactJsonSchema.parseSchema).toHaveBeenCalledWith(subSchemas[0]); expect(reactJsonSchema.parseSchema).toHaveBeenCalledWith(subSchemas[1]); }); it('should assign a key to the current sub-schema based on the current sub-schema\'s index to meet React\'s key expectation of multiple React elements.', () => { spyOn(reactJsonSchema, 'parseSchema'); const subSchemas = [Object.assign({}, schema), Object.assign({}, schema)]; reactJsonSchema.parseSubSchemas(subSchemas); const firstSubSchema = Object.assign({}, subSchemas[0], { key: 0 }); const secondSubSchema = Object.assign({}, subSchemas[1], { key: 1 }); expect(reactJsonSchema.parseSchema).toHaveBeenCalledWith(firstSubSchema); expect(reactJsonSchema.parseSchema).toHaveBeenCalledWith(secondSubSchema); }); }); describe('when creating components', () => { it('should throw an error when no schema is passed as an argument.', () => { spyOn(reactJsonSchema, 'resolveComponent'); spyOn(reactJsonSchema, 'resolveComponentChildren'); reactJsonSchema.resolveComponent.and.returnValue(null); reactJsonSchema.resolveComponentChildren.and.returnValue(null); expect(reactJsonSchema.createComponent).toThrowError(); }); it('should create a React element.', () => { const actual = reactJsonSchema.createComponent(schema); expect(React.isValidElement()).toBe(true); }); it('should resolve and pass props (schema key value pair not described by component or children) and child elements to React\'s create element functionality.', () => { const largeSchema = Object.assign({}, schema); largeSchema.children = [schema]; spyOn(React, 'createElement'); reactJsonSchema.createComponent(largeSchema); expect(React.createElement).toHaveBeenCalledWith(jasmine.any(Function), { someProp: schema.someProp }, jasmine.any(Array)); }); }); describe('when resolving components (evaluating schema for mapping requirements)', () => { it('should throw an error when a schema element does not have a component attribute.', () => { expect(reactJsonSchema.resolveComponent).toThrowError(); }); it('should resolve components defined as strings against a component map.', () => { const stringSchema = { component: 'Tester' }; reactJsonSchema.setComponentMap({ Tester }); const actual = reactJsonSchema.resolveComponent(stringSchema); expect(React.isValidElement()).toBe(true); }); it('should resolve components defined as components without a component map.', () => { reactJsonSchema.setComponentMap({}); // a little unecessary, but to paint the picture const actual = reactJsonSchema.resolveComponent(schema); expect(React.isValidElement()).toBe(true); }); it('should resolve native HTML tags.', () => { spyOn(React, 'createElement'); const stringSchema = { component: 'h1' }; reactJsonSchema.parseSchema(stringSchema); expect(React.createElement).toHaveBeenCalledWith(stringSchema.component, jasmine.any(Object), undefined); }); }); describe('when resolving component children', () => { it('should resolve text before resolving child components.', () => { spyOn(React, 'createElement'); spyOn(reactJsonSchema, 'resolveComponentChildren'); const stringSchema = { component: 'h1', text: 'Hello World' }; reactJsonSchema.parseSchema(stringSchema); expect(React.createElement).toHaveBeenCalledWith(jasmine.any(String), jasmine.any(Object), stringSchema.text); expect(reactJsonSchema.resolveComponentChildren).not.toHaveBeenCalled(); }); it('should return undefined if no child components are present.', () => { const actual = reactJsonSchema.resolveComponentChildren(schema); expect(typeof actual === 'undefined').toBe(true); }); it('should return an array with child components if the children attribute is defined by valid sub-schemas.', () => { const largeSchema = Object.assign({}, schema); largeSchema.children = [schema]; const actual = reactJsonSchema.resolveComponentChildren(largeSchema); expect(Array.isArray(actual)).toBe(true); expect(!!actual.length).toBe(true); }); }); describe('when multiple instances of ReactJsonSchema are created with different componentMaps', () => { it('getComponentMap() should return the appropriate value for each instance', () => { const reactJsonSchema1 = new ReactJsonSchema(); const componentMap1 = { component1: Tester }; reactJsonSchema1.setComponentMap(componentMap1); const reactJsonSchema2 = new ReactJsonSchema(); const componentMap2 = { component2: Tester }; reactJsonSchema2.setComponentMap(componentMap2); expect(reactJsonSchema1.getComponentMap()).toEqual(componentMap1); expect(reactJsonSchema2.getComponentMap()).toEqual(componentMap2); }); }); }); ================================================ FILE: spec/index.html ================================================ Jasmine Spec Runner ================================================ FILE: spec/spec.entry.js ================================================ export * from './ReactJsonSchemaSpec.js'; ================================================ FILE: spec/support/jasmine.json ================================================ { "spec_dir": "spec", "spec_files": [ "**/*[sS]pec.js" ], "helpers": [ "helpers/**/*.js" ] } ================================================ FILE: webpack.config.dist.js ================================================ const path = require('path'); const CleanWebpackPlugin = require('clean-webpack-plugin'); const UglifyJsPlugin = require('uglifyjs-webpack-plugin'); const reactJsonSchema = path.join(__dirname, './lib/ReactJsonSchema.js'); const distPath = path.join(__dirname, './dist'); module.exports = { entry: { 'react-json-schema': reactJsonSchema, 'react-json-schema.min': reactJsonSchema, }, output: { library: 'ReactJsonSchema', libraryTarget: 'umd', path: distPath, filename: '[name].js' }, module: { rules: [ { test: /\.js$/, include: /lib/, exclude: /node_modules/, use: [{ loader: 'babel-loader', options: { presets: ['react', 'env'], plugins: ['transform-es2015-destructuring', 'transform-object-rest-spread'] } }] } ] }, externals: { react: { root: 'React', commonjs2: 'react', commonjs: 'react', amd: 'react' } }, resolve: { modules: [ path.join(__dirname, 'lib'), 'node_modules' ] }, plugins: [ new CleanWebpackPlugin(distPath), new UglifyJsPlugin({ include: /\.min\.js$/ }) ] }; ================================================ FILE: webpack.config.spec.js ================================================ const path = require('path'); const srcPath = path.join(__dirname, './spec'); module.exports = { entry: path.join(srcPath, 'spec.entry'), output: { path: srcPath, filename: 'spec.js' }, module: { rules: [ { test: /\.js$/, exclude: /node_modules/, use: [{ loader: 'babel-loader', options: { presets: ['react', 'env'], plugins: ['transform-es2015-destructuring', 'transform-object-rest-spread'] } }] } ] }, resolve: { modules: [ path.join(__dirname, 'spec'), path.join(__dirname, 'lib'), 'node_modules' ] } };