mapexplorer-rails 1.0.0.pre.alpha.1 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +202 -0
- data/README.md +1 -1
- data/app/assets/javascripts/mapexplorer-rails.js +16 -0
- data/app/assets/stylesheets/mapexplorer-rails.scss +16 -0
- data/app/helpers/mapexplorer_helper.rb +14 -0
- data/config/routes.rb +14 -0
- data/lib/mapexplorer/rails.rb +14 -0
- data/lib/mapexplorer/rails/engine.rb +14 -0
- data/lib/mapexplorer/rails/version.rb +15 -1
- data/lib/tasks/mapexplorer/rails_tasks.rake +14 -0
- data/vendor/assets/mapexplorer-core/LICENSE +202 -21
- data/vendor/assets/mapexplorer-core/LICENSE_HEADER +15 -0
- data/vendor/assets/mapexplorer-core/bower.json +1 -1
- data/vendor/assets/mapexplorer-core/dist/mapexplorer-core.js +1552 -330
- data/vendor/assets/mapexplorer-core/dist/mapexplorer-core.js.map +1 -1
- data/vendor/assets/mapexplorer-core/karma.conf.js +4 -2
- data/vendor/assets/mapexplorer-core/package-lock.json +3486 -0
- data/vendor/assets/mapexplorer-core/package.json +8 -8
- data/vendor/assets/mapexplorer-core/update-license-headers.sh +20 -0
- data/vendor/assets/stratumn-agent-client/LICENSE +202 -0
- data/vendor/assets/stratumn-agent-client/LICENSE_HEADER +15 -0
- data/vendor/assets/stratumn-agent-client/README.md +268 -0
- data/vendor/assets/stratumn-agent-client/bower.json +27 -0
- data/vendor/assets/stratumn-agent-client/dist/stratumn-agent-client.js +1449 -0
- data/vendor/assets/stratumn-agent-client/dist/stratumn-agent-client.js.map +1 -0
- data/vendor/assets/stratumn-agent-client/dist/stratumn-agent-client.min.js +2 -0
- data/vendor/assets/stratumn-agent-client/dist/stratumn-agent-client.min.js.map +1 -0
- data/vendor/assets/stratumn-agent-client/examples/browser/index.html +34 -0
- data/vendor/assets/stratumn-agent-client/package.json +69 -0
- data/vendor/assets/stratumn-agent-client/rollup.base.config.js +13 -0
- data/vendor/assets/stratumn-agent-client/rollup.bower.config.js +18 -0
- data/vendor/assets/stratumn-agent-client/rollup.bower.min.config.js +7 -0
- data/vendor/assets/stratumn-agent-client/rollup.es.config.js +9 -0
- data/vendor/assets/stratumn-agent-client/rollup.umd.config.js +10 -0
- data/vendor/assets/stratumn-agent-client/update-license-headers.sh +20 -0
- metadata +25 -7
- data/MIT-LICENSE +0 -20
- data/vendor/assets/mapexplorer-core/dist/mapexplorer-core.min.js +0 -35
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "mapexplorer-core",
|
3
|
-
"version": "1.
|
3
|
+
"version": "1.1.4",
|
4
4
|
"description": "Core library for building Map Explorer components",
|
5
5
|
"main": "lib/mapexplorer-core.js",
|
6
6
|
"module": "lib/mapexplorer-core.mjs",
|
@@ -15,8 +15,9 @@
|
|
15
15
|
"build:npm": "rollup -c rollup.es.config.js && rollup -c rollup.umd.config.js",
|
16
16
|
"build:bower": "rollup -c rollup.bower.config.js",
|
17
17
|
"build": "npm run build:npm && npm run build:bower",
|
18
|
-
"watch": "rollup -c -w",
|
19
|
-
"
|
18
|
+
"watch": "rollup -c rollup.bower.config.js -w",
|
19
|
+
"prepublishOnly": "npm run build:npm",
|
20
|
+
"update-license-headers": "./update-license-headers.sh"
|
20
21
|
},
|
21
22
|
"repository": {
|
22
23
|
"type": "git",
|
@@ -29,7 +30,7 @@
|
|
29
30
|
"chainscript"
|
30
31
|
],
|
31
32
|
"author": "Stratumn Team",
|
32
|
-
"license": "
|
33
|
+
"license": "Apache-2.0",
|
33
34
|
"bugs": {
|
34
35
|
"url": "https://github.com/stratumn/mapexplorer-core/issues"
|
35
36
|
},
|
@@ -52,7 +53,6 @@
|
|
52
53
|
"karma-phantomjs-launcher": "^1.0.1",
|
53
54
|
"karma-rollup-plugin": "^0.2.2",
|
54
55
|
"karma-should": "^1.0.0",
|
55
|
-
"karma-sinon": "^1.0.5",
|
56
56
|
"karma-sourcemap-loader": "^0.3.7",
|
57
57
|
"mocha": "^2.4.5",
|
58
58
|
"rimraf": "^2.5.2",
|
@@ -60,13 +60,13 @@
|
|
60
60
|
"rollup-plugin-babel": "^2.6.1",
|
61
61
|
"rollup-plugin-coffee-script": "^1.1.0",
|
62
62
|
"rollup-plugin-commonjs": "^3.3.1",
|
63
|
-
"rollup-plugin-json": "^2.0
|
63
|
+
"rollup-plugin-json": "^2.1.0",
|
64
64
|
"rollup-plugin-node-builtins": "^1.0.7",
|
65
65
|
"rollup-plugin-node-globals": "^1.0.6",
|
66
66
|
"rollup-plugin-node-resolve": "^2.0.0",
|
67
67
|
"rollup-watch": "^2.5.0",
|
68
68
|
"should": "^8.2.2",
|
69
|
-
"
|
69
|
+
"xhr-mock": "^1.7.0",
|
70
70
|
"zock": "^0.2.6"
|
71
71
|
},
|
72
72
|
"dependencies": {
|
@@ -80,6 +80,6 @@
|
|
80
80
|
"deepmerge": "^0.2.10",
|
81
81
|
"httpplease": "^0.16.4",
|
82
82
|
"js-sha256": "^0.3.0",
|
83
|
-
"stratumn-
|
83
|
+
"stratumn-agent-client": "^1.9.0"
|
84
84
|
}
|
85
85
|
}
|
@@ -0,0 +1,20 @@
|
|
1
|
+
#!/bin/bash
|
2
|
+
|
3
|
+
set -e
|
4
|
+
|
5
|
+
update-license-header() {
|
6
|
+
perl -i -0pe 's/\/\*.*\n.*Copyright.*Stratumn.*\n(.*\n)*\*\/\n/`cat LICENSE_HEADER`/ge' $1
|
7
|
+
}
|
8
|
+
|
9
|
+
directories="src test"
|
10
|
+
extensions="js less"
|
11
|
+
|
12
|
+
for d in $directories; do
|
13
|
+
if [ -d "$d" ]; then
|
14
|
+
for e in $extensions; do
|
15
|
+
for f in $(find $d -name "*.$e"); do
|
16
|
+
update-license-header $f
|
17
|
+
done
|
18
|
+
done
|
19
|
+
fi
|
20
|
+
done
|
@@ -0,0 +1,202 @@
|
|
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
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
Copyright 2017 Stratumn SAS. All rights reserved.
|
3
|
+
|
4
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
you may not use this file except in compliance with the License.
|
6
|
+
You may obtain a copy of the License at
|
7
|
+
|
8
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
|
10
|
+
Unless required by applicable law or agreed to in writing, software
|
11
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
See the License for the specific language governing permissions and
|
14
|
+
limitations under the License.
|
15
|
+
*/
|
@@ -0,0 +1,268 @@
|
|
1
|
+
# Agent client for Javascript
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/stratumn/agent-client-js.svg?branch=master)](https://travis-ci.org/stratumn/agent-client-js)
|
4
|
+
[![codecov](https://codecov.io/gh/stratumn/agent-client-js/branch/master/graph/badge.svg)](https://codecov.io/gh/stratumn/agent-client-js/branch/master)
|
5
|
+
[![Build Status](https://david-dm.org/stratumn/agent-client-js.svg?branch=master)](https://david-dm.org/stratumn/agent-client-js)
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
### Browser
|
10
|
+
|
11
|
+
```html
|
12
|
+
<!-- Polyfill for browser compatibility -->
|
13
|
+
<script src="https://libs.stratumn.com/babel-polyfill.min.js"></script>
|
14
|
+
<!-- Actual Stratumn SDK -->
|
15
|
+
<script src="https://libs.stratumn.com/stratumn-agent-client.min.js"></script>
|
16
|
+
```
|
17
|
+
|
18
|
+
If you want a specific version, include `https://libs.stratumn.com/stratumn-agent-client-{version}.min.js` instead (for instance `https://libs.stratumn.com/stratumn-agent-client-1.0.2.min.js`).
|
19
|
+
|
20
|
+
### Bower
|
21
|
+
|
22
|
+
```
|
23
|
+
$ bower install stratumn-agent-client
|
24
|
+
```
|
25
|
+
|
26
|
+
### Node.js
|
27
|
+
|
28
|
+
```
|
29
|
+
$ npm install stratumn-agent-client@master
|
30
|
+
```
|
31
|
+
|
32
|
+
```javascript
|
33
|
+
var AgentClient = require('stratumn-agent-client');
|
34
|
+
```
|
35
|
+
|
36
|
+
## Quickstart
|
37
|
+
|
38
|
+
```javascript
|
39
|
+
AgentClient.getAgent('http://localhost:3000')
|
40
|
+
.then(function(agent) {
|
41
|
+
console.log(agent);
|
42
|
+
// Create a new map, you can pass arguments to init
|
43
|
+
return agent.createMap('My conversation');
|
44
|
+
})
|
45
|
+
.then(function(segment) {
|
46
|
+
// You can call an action like a regular function
|
47
|
+
return segment.addMessage('Hello, World');
|
48
|
+
})
|
49
|
+
.then(function(segment) {
|
50
|
+
console.log(segment.link);
|
51
|
+
console.log(segment.meta);
|
52
|
+
})
|
53
|
+
.catch(function(err) {
|
54
|
+
// Handle errors
|
55
|
+
});
|
56
|
+
```
|
57
|
+
|
58
|
+
## Reference
|
59
|
+
|
60
|
+
### AgentClient#getAgent(url)
|
61
|
+
|
62
|
+
Returns a promise that resolves with an agent client.
|
63
|
+
|
64
|
+
```javascript
|
65
|
+
AgentClient
|
66
|
+
.getAgent('http://localhost:3000')
|
67
|
+
.then(function(agent) {
|
68
|
+
console.log(agent);
|
69
|
+
})
|
70
|
+
.catch(function(err) {
|
71
|
+
// Handle errors
|
72
|
+
});
|
73
|
+
```
|
74
|
+
|
75
|
+
### AgentClient#fromSegment(rawSegment)
|
76
|
+
|
77
|
+
Returns a promise that resolves with the agent and segment from a given raw object.
|
78
|
+
|
79
|
+
```javascript
|
80
|
+
AgentClient
|
81
|
+
.fromSegment(someRawSegment)
|
82
|
+
.then(function(res) {
|
83
|
+
console.log(res.agent);
|
84
|
+
console.log(res.segment);
|
85
|
+
})
|
86
|
+
.catch(function(err) {
|
87
|
+
// Handle errors
|
88
|
+
});
|
89
|
+
```
|
90
|
+
|
91
|
+
### Agent#createMap(...args)
|
92
|
+
|
93
|
+
Returns a promise that resolves with a the first segment of a map.
|
94
|
+
|
95
|
+
```javascript
|
96
|
+
AgentClient
|
97
|
+
.getAgent('http://localhost:3000')
|
98
|
+
.then(function(agent) {
|
99
|
+
return agent.createMap('A new map');
|
100
|
+
})
|
101
|
+
.then(function(segment) {
|
102
|
+
console.log(segment);
|
103
|
+
})
|
104
|
+
.catch(function(err) {
|
105
|
+
// Handle errors
|
106
|
+
});
|
107
|
+
```
|
108
|
+
|
109
|
+
### Agent#getSegment(linkHash)
|
110
|
+
|
111
|
+
Returns a promise that resolves with an existing segment.
|
112
|
+
|
113
|
+
```javascript
|
114
|
+
AgentClient
|
115
|
+
.getAgent('http://localhost:3000')
|
116
|
+
.then(function(agent) {
|
117
|
+
return agent.getSegment('aee5427');
|
118
|
+
})
|
119
|
+
.then(function(segment) {
|
120
|
+
console.log(segment);
|
121
|
+
})
|
122
|
+
.catch(function(err) {
|
123
|
+
// Handle errors
|
124
|
+
});
|
125
|
+
```
|
126
|
+
|
127
|
+
### Agent#findSegments(opts)
|
128
|
+
|
129
|
+
Returns a promise that resolves with existing segments.
|
130
|
+
|
131
|
+
Available options are:
|
132
|
+
|
133
|
+
- `offset`: offset of first returned segments
|
134
|
+
- `limit`: limit number of returned segments, if -1 load all segments
|
135
|
+
- `batchSize`: size of each batch when loading all segments (default 20)
|
136
|
+
- `mapId`: return segments with specified map ID
|
137
|
+
- `prevLinkHash`: return segments with specified previous link hash
|
138
|
+
- `tags`: return segments that contains all the tags (array)
|
139
|
+
|
140
|
+
```javascript
|
141
|
+
AgentClient
|
142
|
+
.getAgent('http://localhost:3000')
|
143
|
+
.then(function(agent) {
|
144
|
+
return agent.findSegments({ tags: ['tag1', 'tag2'], offset: 20, limit: 10 });
|
145
|
+
})
|
146
|
+
.then(function(segments) {
|
147
|
+
console.log(segments);
|
148
|
+
})
|
149
|
+
.catch(function(err) {
|
150
|
+
// Handle errors
|
151
|
+
});
|
152
|
+
```
|
153
|
+
|
154
|
+
### Agent#getMapIds(opts)
|
155
|
+
|
156
|
+
Returns a promise that resolves with existing map IDs.
|
157
|
+
|
158
|
+
Available options are:
|
159
|
+
|
160
|
+
- `offset`: offset of first returned map ID
|
161
|
+
- `limit`: limit number of returned map ID
|
162
|
+
|
163
|
+
```javascript
|
164
|
+
AgentClient
|
165
|
+
.getAgent('http://localhost:3000')
|
166
|
+
.then(function(agent) {
|
167
|
+
return agent.findSegments({ offset: 20, limit: 10 });
|
168
|
+
})
|
169
|
+
.then(function(mapIDs) {
|
170
|
+
console.log(mapIDs);
|
171
|
+
})
|
172
|
+
.catch(function(err) {
|
173
|
+
// Handle errors
|
174
|
+
});
|
175
|
+
```
|
176
|
+
|
177
|
+
### Segment#getPrev()
|
178
|
+
|
179
|
+
Returns a promise that resolves with the previous segment.
|
180
|
+
|
181
|
+
```javascript
|
182
|
+
AgentClient
|
183
|
+
.getAgent('http://localhost:3000')
|
184
|
+
.then(function(agent) {
|
185
|
+
return agent.getSegment('aee5427');
|
186
|
+
})
|
187
|
+
.then(function(segment) {
|
188
|
+
return segment.getPrev();
|
189
|
+
})
|
190
|
+
.then(function(segment) {
|
191
|
+
console.log(segment);
|
192
|
+
})
|
193
|
+
.catch(function(err) {
|
194
|
+
// Handle errors
|
195
|
+
});
|
196
|
+
```
|
197
|
+
|
198
|
+
### Segment#:actionName(...args)
|
199
|
+
|
200
|
+
Executes an action and returns a promise that resolves with a new segment.
|
201
|
+
|
202
|
+
```javascript
|
203
|
+
AgentClient
|
204
|
+
.getAgent('http://localhost:3000')
|
205
|
+
.then(function(agent) {
|
206
|
+
return agent.getSegment('aee5427');
|
207
|
+
})
|
208
|
+
.then(function(segment) {
|
209
|
+
return segment.addMessage('Hello, World!');
|
210
|
+
})
|
211
|
+
.then(function(segment) {
|
212
|
+
console.log(segment);
|
213
|
+
})
|
214
|
+
.catch(function(err) {
|
215
|
+
// Handle errors
|
216
|
+
});
|
217
|
+
```
|
218
|
+
|
219
|
+
## Development
|
220
|
+
|
221
|
+
Install dependencies:
|
222
|
+
|
223
|
+
```
|
224
|
+
$ npm install
|
225
|
+
```
|
226
|
+
|
227
|
+
Build:
|
228
|
+
|
229
|
+
```
|
230
|
+
$ npm run build:all
|
231
|
+
```
|
232
|
+
|
233
|
+
Test:
|
234
|
+
|
235
|
+
```
|
236
|
+
$ npm test
|
237
|
+
```
|
238
|
+
|
239
|
+
Test coverage:
|
240
|
+
|
241
|
+
```
|
242
|
+
$ npm run test:cov
|
243
|
+
$ open coverage/lcov-report/index.html
|
244
|
+
```
|
245
|
+
|
246
|
+
Lint:
|
247
|
+
|
248
|
+
```
|
249
|
+
$ npm run lint
|
250
|
+
```
|
251
|
+
|
252
|
+
Lint and test:
|
253
|
+
|
254
|
+
```
|
255
|
+
$ npm run check
|
256
|
+
```
|
257
|
+
|
258
|
+
Bump version:
|
259
|
+
|
260
|
+
```
|
261
|
+
$ npm version major|minor|patch
|
262
|
+
```
|
263
|
+
|
264
|
+
Publish:
|
265
|
+
|
266
|
+
```
|
267
|
+
$ npm publish
|
268
|
+
```
|