From c42733ec951e1492bec746ebf337d3ec5f538e8d Mon Sep 17 00:00:00 2001 From: David Baker Date: Tue, 9 Jun 2015 17:40:42 +0100 Subject: [PATCH] Basic structure of a react SDK and start of an implementation. --- LICENSE | 177 +++++++++++++++++++++++++++++ README.md | 4 + example/index.html | 11 ++ example/lib/index.jsx | 12 ++ example/package.json | 19 ++++ package.json | 21 ++++ src/MatrixClientPeg.js | 15 +++ src/dispatcher.js | 1 + src/index.js | 1 + src/molecules/HomeServerTextBox.js | 31 +++++ src/molecules/Message.js | 12 ++ src/organisms/MessageSection.js | 26 +++++ src/organisms/ThreadSection.js | 13 +++ src/pages/MatrixChat.js | 26 +++++ src/templates/Login.js | 38 +++++++ 15 files changed, 407 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 example/index.html create mode 100644 example/lib/index.jsx create mode 100644 example/package.json create mode 100644 package.json create mode 100644 src/MatrixClientPeg.js create mode 100644 src/dispatcher.js create mode 100644 src/index.js create mode 100644 src/molecules/HomeServerTextBox.js create mode 100644 src/molecules/Message.js create mode 100644 src/organisms/MessageSection.js create mode 100644 src/organisms/ThreadSection.js create mode 100644 src/pages/MatrixChat.js create mode 100644 src/templates/Login.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f433b1a5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,177 @@ + + 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 diff --git a/README.md b/README.md new file mode 100644 index 00000000..c7943756 --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +matrix-react-sdk +================ + +This is a react-based SDK for inserting a Matrix chat client into a web page diff --git a/example/index.html b/example/index.html new file mode 100644 index 00000000..4cd1fb71 --- /dev/null +++ b/example/index.html @@ -0,0 +1,11 @@ + + + + + Matrix Flux + + +
+ + + diff --git a/example/lib/index.jsx b/example/lib/index.jsx new file mode 100644 index 00000000..0c6e1332 --- /dev/null +++ b/example/lib/index.jsx @@ -0,0 +1,12 @@ +var React = require("react"); +// In normal usage of the module: +//var MatrixReactSdk = require("matrix-react-sdk"); +// Or to import the source directly from the file system: +// (This is useful for debugging the SDK as ut seems source +// maps cannot pass through two stages). +var MatrixReactSdk = require("../../src/index"); + +React.render( + , + document.getElementById('matrixchat') +); diff --git a/example/package.json b/example/package.json new file mode 100644 index 00000000..a00baafa --- /dev/null +++ b/example/package.json @@ -0,0 +1,19 @@ +{ + "name": "matrix-react-example", + "version": "0.0.1", + "description": "Example usage of matrix-react-sdk", + "author": "matrix.org", + "license": "Apache 2", + "devDependencies": { + "browserify": "^10.2.3", + "envify": "^3.4.0", + "matrix-react-sdk": "../", + "reactify": "^1.1.1", + "uglifyify": "^3.0.1", + "watchify": "^3.2.1" + }, + "scripts": { + "build": "browserify -t [ envify --NODE_ENV production ] -t reactify -g uglifyify lib/index.jsx -o bundle.js", + "start": "watchify -v -d -t reactify lib/index.jsx -o bundle.js" + } +} diff --git a/package.json b/package.json new file mode 100644 index 00000000..99b6330a --- /dev/null +++ b/package.json @@ -0,0 +1,21 @@ +{ + "name": "matrix-react-sdk", + "version": "0.0.1", + "description": "SDK for matrix.org using React", + "author": "matrix.org", + "license": "Apache 2", + "main": "build/index.js", + "scripts": { + "build": "jsx src/ build", + "start": "jsx -w src/ build --source-map-inline" + }, + "dependencies": { + "react-loader": "^1.4.0", + "flux": "^2.0.3", + "matrix-js-sdk": "0.0.4", + "react": "^0.13.0" + }, + "devDependencies": { + "react-tools": "^0.13.3" + } +} diff --git a/src/MatrixClientPeg.js b/src/MatrixClientPeg.js new file mode 100644 index 00000000..2c22c6b7 --- /dev/null +++ b/src/MatrixClientPeg.js @@ -0,0 +1,15 @@ +// A thing that holds your Matrix Client +var Matrix = require("matrix-js-sdk"); + +var matrixClient = null; + +module.exports = { + get: function() { + return matrixClient; + }, + + replaceUsingUrl: function(hs_url) { + matrixClient = Matrix.createClient(hs_url); + } +}; + diff --git a/src/dispatcher.js b/src/dispatcher.js new file mode 100644 index 00000000..a8d766f6 --- /dev/null +++ b/src/dispatcher.js @@ -0,0 +1 @@ +module.exports = new require("flux").Dispatcher(); diff --git a/src/index.js b/src/index.js new file mode 100644 index 00000000..6edda44d --- /dev/null +++ b/src/index.js @@ -0,0 +1 @@ +module.exports.MatrixChat = require("./pages/MatrixChat"); diff --git a/src/molecules/HomeServerTextBox.js b/src/molecules/HomeServerTextBox.js new file mode 100644 index 00000000..4b5fbc64 --- /dev/null +++ b/src/molecules/HomeServerTextBox.js @@ -0,0 +1,31 @@ +var React = require('react'); + +var MatrixClientPeg = require("../MatrixClientPeg.js"); + +module.exports = React.createClass({ + getDefaultProps: function() { + return { + default_url: 'https://matrix.org/' + }; + }, + + getInitialState: function() { + return { + hs_url: this.props.default_url + } + }, + + hsChanged: function(ev) { + this.state.hs_url = ev.target.value; + MatrixClientPeg.replaceUsingUrl(this.state.hs_url); + }, + + render: function() { + return ( +
+ Home Server URL:  + +
+ ); + } +}); diff --git a/src/molecules/Message.js b/src/molecules/Message.js new file mode 100644 index 00000000..ffe3113f --- /dev/null +++ b/src/molecules/Message.js @@ -0,0 +1,12 @@ +var React = require('react'); + +module.exports = React.createClass({ + render: function() { + return ( +
+ {this.props.event.content.body} +
+ ); + }, +}); + diff --git a/src/organisms/MessageSection.js b/src/organisms/MessageSection.js new file mode 100644 index 00000000..10d85167 --- /dev/null +++ b/src/organisms/MessageSection.js @@ -0,0 +1,26 @@ +var React = require('react'); +var Message = require('../molecules/Message'); + +module.exports = React.createClass({ + getInitialState: function() { + return { + messages: [ { foo: "bar"} ] + } + }, + + render: function() { + var messageItems = this.state.messages.map(function(ev) { + return ( + + ); + }); + return ( +
+
    + {messageItems} +
+
+ ); + }, +}); + diff --git a/src/organisms/ThreadSection.js b/src/organisms/ThreadSection.js new file mode 100644 index 00000000..0a80ef8c --- /dev/null +++ b/src/organisms/ThreadSection.js @@ -0,0 +1,13 @@ +var React = require('react'); + +module.exports = React.createClass({ + render: function() { + return ( +
+
    +
+
+ ); + } +}); + diff --git a/src/pages/MatrixChat.js b/src/pages/MatrixChat.js new file mode 100644 index 00000000..6de89ab9 --- /dev/null +++ b/src/pages/MatrixChat.js @@ -0,0 +1,26 @@ +var React = require('react'); + +var ThreadSection = require('../organisms/ThreadSection'); +var MessageSection = require('../organisms/MessageSection'); + +var Login = require('../templates/Login'); + +var mxCli = require("../MatrixClientPeg").get(); + +module.exports = React.createClass({ + render: function() { + if (mxCli && mxCli.credentials) { + return ( +
+ + +
+ ); + } else { + return ( + + ); + } + } +}); + diff --git a/src/templates/Login.js b/src/templates/Login.js new file mode 100644 index 00000000..32069f12 --- /dev/null +++ b/src/templates/Login.js @@ -0,0 +1,38 @@ +var React = require('react'); +var MatrixClientPeg = require("../MatrixClientPeg"); + +var HomeServerTextBox = require("../molecules/HomeServerTextBox"); +var Loader = require("react-loader"); + +module.exports = React.createClass({ + getInitialState: function() { + return { + step: 'choose_hs' + }; + }, + + setStep: function(step) { + this.setState({ step: step }); + }, + + onHSChosen: function(ev) { + this.setStep("fetch_stages"); + }, + + render: function() { + switch (this.state.step) { + case 'choose_hs': + return ( +
+
Please log in:
+ + +
+ ); + case 'fetch_stages': + return ( + + ); + } + } +});