Skip to content

Commit c42733e

Browse files
dbkrdbkr
committed
Basic structure of a react SDK and start of an implementation.
0 parents  commit c42733e

15 files changed

+407
-0
lines changed

‎LICENSE

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
matrix-react-sdk
2+
================
3+
4+
This is a react-based SDK for inserting a Matrix chat client into a web page

‎example/index.html

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Matrix Flux</title>
6+
</head>
7+
<body>
8+
<section id="matrixchat"></section>
9+
<script src="bundle.js"></script>
10+
</body>
11+
</html>

‎example/lib/index.jsx

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
var React = require("react");
2+
// In normal usage of the module:
3+
//var MatrixReactSdk = require("matrix-react-sdk");
4+
// Or to import the source directly from the file system:
5+
// (This is useful for debugging the SDK as ut seems source
6+
// maps cannot pass through two stages).
7+
var MatrixReactSdk = require("../../src/index");
8+
9+
React.render(
10+
<MatrixReactSdk.MatrixChat />,
11+
document.getElementById('matrixchat')
12+
);

‎example/package.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"name": "matrix-react-example",
3+
"version": "0.0.1",
4+
"description": "Example usage of matrix-react-sdk",
5+
"author": "matrix.org",
6+
"license": "Apache 2",
7+
"devDependencies": {
8+
"browserify": "^10.2.3",
9+
"envify": "^3.4.0",
10+
"matrix-react-sdk": "../",
11+
"reactify": "^1.1.1",
12+
"uglifyify": "^3.0.1",
13+
"watchify": "^3.2.1"
14+
},
15+
"scripts": {
16+
"build": "browserify -t [ envify --NODE_ENV production ] -t reactify -g uglifyify lib/index.jsx -o bundle.js",
17+
"start": "watchify -v -d -t reactify lib/index.jsx -o bundle.js"
18+
}
19+
}

‎package.json

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "matrix-react-sdk",
3+
"version": "0.0.1",
4+
"description": "SDK for matrix.org using React",
5+
"author": "matrix.org",
6+
"license": "Apache 2",
7+
"main": "build/index.js",
8+
"scripts": {
9+
"build": "jsx src/ build",
10+
"start": "jsx -w src/ build --source-map-inline"
11+
},
12+
"dependencies": {
13+
"react-loader": "^1.4.0",
14+
"flux": "^2.0.3",
15+
"matrix-js-sdk": "0.0.4",
16+
"react": "^0.13.0"
17+
},
18+
"devDependencies": {
19+
"react-tools": "^0.13.3"
20+
}
21+
}

‎src/MatrixClientPeg.js

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// A thing that holds your Matrix Client
2+
var Matrix = require("matrix-js-sdk");
3+
4+
var matrixClient = null;
5+
6+
module.exports = {
7+
get: function() {
8+
return matrixClient;
9+
},
10+
11+
replaceUsingUrl: function(hs_url) {
12+
matrixClient = Matrix.createClient(hs_url);
13+
}
14+
};
15+

‎src/dispatcher.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = new require("flux").Dispatcher();

‎src/index.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports.MatrixChat = require("./pages/MatrixChat");

‎src/molecules/HomeServerTextBox.js

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
var React = require('react');
2+
3+
var MatrixClientPeg = require("../MatrixClientPeg.js");
4+
5+
module.exports = React.createClass({
6+
getDefaultProps: function() {
7+
return {
8+
default_url: 'https://matrix.org/'
9+
};
10+
},
11+
12+
getInitialState: function() {
13+
return {
14+
hs_url: this.props.default_url
15+
}
16+
},
17+
18+
hsChanged: function(ev) {
19+
this.state.hs_url = ev.target.value;
20+
MatrixClientPeg.replaceUsingUrl(this.state.hs_url);
21+
},
22+
23+
render: function() {
24+
return (
25+
<div className="HomeServerTextBox">
26+
Home Server URL:&nbsp;
27+
<input type="text" value={this.state.hs_url} onChange={this.hsChanged} />
28+
</div>
29+
);
30+
}
31+
});

‎src/molecules/Message.js

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
var React = require('react');
2+
3+
module.exports = React.createClass({
4+
render: function() {
5+
return (
6+
<div>
7+
{this.props.event.content.body}
8+
</div>
9+
);
10+
},
11+
});
12+

‎src/organisms/MessageSection.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
var React = require('react');
2+
var Message = require('../molecules/Message');
3+
4+
module.exports = React.createClass({
5+
getInitialState: function() {
6+
return {
7+
messages: [ { foo: "bar"} ]
8+
}
9+
},
10+
11+
render: function() {
12+
var messageItems = this.state.messages.map(function(ev) {
13+
return (
14+
<Message ev={ev} />
15+
);
16+
});
17+
return (
18+
<div>
19+
<ul className="message-list" ref="messageList">
20+
{messageItems}
21+
</ul>
22+
</div>
23+
);
24+
},
25+
});
26+

‎src/organisms/ThreadSection.js

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
var React = require('react');
2+
3+
module.exports = React.createClass({
4+
render: function() {
5+
return (
6+
<div>
7+
<ul>
8+
</ul>
9+
</div>
10+
);
11+
}
12+
});
13+

‎src/pages/MatrixChat.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
var React = require('react');
2+
3+
var ThreadSection = require('../organisms/ThreadSection');
4+
var MessageSection = require('../organisms/MessageSection');
5+
6+
var Login = require('../templates/Login');
7+
8+
var mxCli = require("../MatrixClientPeg").get();
9+
10+
module.exports = React.createClass({
11+
render: function() {
12+
if (mxCli && mxCli.credentials) {
13+
return (
14+
<div>
15+
<ThreadSection />
16+
<MessageSection />
17+
</div>
18+
);
19+
} else {
20+
return (
21+
<Login />
22+
);
23+
}
24+
}
25+
});
26+

0 commit comments

Comments
 (0)