├── .eslintignore
├── .eslintrc.json
├── .github
└── workflows
│ └── node.js.yml
├── .gitignore
├── .jsdoc
├── .npmignore
├── .nycrc.json
├── CHANGELOG
├── CODE_OF_CODUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── docs
├── Client.html
├── Elarian.html
├── README.md
├── client.js.html
├── elarian.js.html
├── fonts
│ ├── OpenSans-Bold-webfont.eot
│ ├── OpenSans-Bold-webfont.svg
│ ├── OpenSans-Bold-webfont.woff
│ ├── OpenSans-BoldItalic-webfont.eot
│ ├── OpenSans-BoldItalic-webfont.svg
│ ├── OpenSans-BoldItalic-webfont.woff
│ ├── OpenSans-Italic-webfont.eot
│ ├── OpenSans-Italic-webfont.svg
│ ├── OpenSans-Italic-webfont.woff
│ ├── OpenSans-Light-webfont.eot
│ ├── OpenSans-Light-webfont.svg
│ ├── OpenSans-Light-webfont.woff
│ ├── OpenSans-LightItalic-webfont.eot
│ ├── OpenSans-LightItalic-webfont.svg
│ ├── OpenSans-LightItalic-webfont.woff
│ ├── OpenSans-Regular-webfont.eot
│ ├── OpenSans-Regular-webfont.svg
│ └── OpenSans-Regular-webfont.woff
├── global.html
├── index.html
├── index.js.html
├── scripts
│ ├── linenumber.js
│ └── prettify
│ │ ├── Apache-License-2.0.txt
│ │ ├── lang-css.js
│ │ └── prettify.js
├── styles
│ ├── jsdoc-default.css
│ ├── prettify-jsdoc.css
│ └── prettify-tomorrow.css
└── utils_types.js.html
├── index.js
├── lib
├── client.js
├── elarian.js
├── index.js
└── utils
│ ├── index.js
│ ├── service
│ ├── AppStateService.proto
│ └── SocialService.proto
│ └── types.js
├── package.json
├── test
├── elarian.spec.js
└── fixtures.js
└── webpack.config.js
/.eslintignore:
--------------------------------------------------------------------------------
1 | .nyc_output/
2 | node_modules/
3 | lib/utils/service
4 | docs/
5 | dist/
6 | web.js*
7 | tmp/
--------------------------------------------------------------------------------
/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "env": {
3 | "commonjs": true,
4 | "es2021": true,
5 | "node": true,
6 | "mocha": true
7 | },
8 | "extends": [
9 | "airbnb-base"
10 | ],
11 | "plugins": [
12 | "mocha",
13 | "security"
14 | ],
15 | "parserOptions": {
16 | "ecmaVersion": 12
17 | },
18 | "rules": {
19 | "indent": [2, 4],
20 |
21 | "import/no-extraneous-dependencies": [2, {
22 | "devDependencies": true
23 | }]
24 | }
25 | }
--------------------------------------------------------------------------------
/.github/workflows/node.js.yml:
--------------------------------------------------------------------------------
1 | name: Tests
2 |
3 | on:
4 | push:
5 | branches: [ develop, master ]
6 | pull_request:
7 | branches: [ develop, master ]
8 |
9 | jobs:
10 | test:
11 |
12 | runs-on: ubuntu-latest
13 |
14 | strategy:
15 | matrix:
16 | node-version: [18.x]
17 |
18 | steps:
19 | - uses: actions/checkout@v2
20 | - name: Use Node.js ${{ matrix.node-version }}
21 | uses: actions/setup-node@v1
22 | with:
23 | node-version: ${{ matrix.node-version }}
24 | - run: npm i
25 | - run: npm run lint
26 | - run: npm test
27 | env:
28 | HOST: ${{ secrets.HOST }}
29 | PORT: ${{ secrets.PORT }}
30 | ORG_ID: ${{ secrets.ORG_ID }}
31 | APP_ID: ${{ secrets.APP_ID }}
32 | API_KEY: ${{ secrets.API_KEY }}
33 | PURSE_ID: ${{ secrets.PURSE_ID }}
34 | USSD_CODE: ${{ secrets.USSD_CODE }}
35 | VOICE_NUMBER: ${{ secrets.VOICE_NUMBER }}
36 | MPESA_PAYBILL: ${{ secrets.MPESA_PAYBILL }}
37 | SMS_SENDER_ID: ${{ secrets.SMS_SENDER_ID }}
38 | SMS_SHORT_CODE: ${{ secrets.SMS_SHORT_CODE }}
39 | TELEGRAM_NUMBER: ${{ secrets.TELEGRAM_NUMBER }}
40 | WHATSAPP_NUMBER: ${{ secrets.WHATSAPP_NUMBER }}
41 | MESSENNGER_NUMBER: ${{ secrets.MESSENNGER_NUMBER }}
42 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.DS_Store
2 | .idea/
3 | coverage/
4 | node_modules/
5 | .nyc_output/
6 | .env
7 | tmp/
8 | package-lock.json
--------------------------------------------------------------------------------
/.jsdoc:
--------------------------------------------------------------------------------
1 | {
2 | "plugins": [
3 | "plugins/markdown"
4 | ],
5 | "recurseDepth": 1000,
6 | "source": {
7 | "includePattern": ".+\\.js(doc|x)?$",
8 | "excludePattern": "(^|\\/|\\\\)_",
9 | "exclude": ["lib/utils/service"]
10 | },
11 | "sourceType": "module",
12 | "tags": {
13 | "allowUnknownTags": true,
14 | "dictionaries": ["jsdoc","closure"]
15 | },
16 | "templates": {
17 | "cleverLinks": true,
18 | "monospaceLinks": false,
19 | "footer": "",
20 | "systemName": "Elarian",
21 | "copyright": "Elarian",
22 | "includeDate": true,
23 | "navType": "inline",
24 | "theme": "simplex",
25 | "linenums": true,
26 | "collapseSymbols": false,
27 | "inverseNav": true,
28 | "outputSourceFiles": true,
29 | "outputSourcePath": true,
30 | "dateFormat": "llll",
31 | "syntaxTheme": "dark",
32 | "sort": "longname, version, since",
33 | "search": true
34 | },
35 |
36 | "opts": {
37 | "encoding": "utf8",
38 | "destination": "./docs",
39 | "recurse": true
40 | }
41 | }
--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | .idea/
2 | coverage/
3 | example/
4 | test/
5 | node_modules/
6 | .nyc_output/
--------------------------------------------------------------------------------
/.nycrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "branches": 80,
3 | "lines": 80,
4 | "functions": 80,
5 | "statements": 80
6 | }
--------------------------------------------------------------------------------
/CHANGELOG:
--------------------------------------------------------------------------------
1 | # Changelog
2 | All notable changes to this project will be documented in this file.
3 |
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6 |
7 | ## [0.2.25] - 2022-06-10
8 |
9 | ### Fixed
10 |
11 | - Fixed websocket connection state
12 |
13 | ## [0.2.24] - 2022-06-07
14 |
15 | ### Fixed
16 |
17 | - Fixed customer activity notification payload
18 |
19 | ## [0.2.23] - 2022-01-14
20 |
21 | ### Added
22 |
23 | - Utility functions initializeClient, initializeSimulator, initializeCustomer
24 |
25 | ## [0.2.22] - 2022-01-12
26 |
27 | ### Added
28 |
29 | - Better error message for invalid channel, mode and provider values
30 |
31 | ## [0.2.21] - 2021-12-03
32 |
33 | ### Added
34 |
35 | - M-Pesa to channel number providers
36 | - GatewayError to VoiceCallStatus, MessageDeliveryStatus and PaymentStatus
37 | - Description to PaymentStatusNotification and MessageStatusNotification
38 | - Description to PaymentTransaction and SentMessage
39 |
40 | ## [0.2.20] - 2021-11-22
41 |
42 | ### Added
43 |
44 | - Payment replay commands
45 | - Narration field to initiate payment command
46 |
47 | ### Removed
48 |
49 | - Wallet Payment Status Notification
50 |
51 | ## [0.2.19] - 2021-11-11
52 |
53 | ### Added
54 |
55 | - Messaging replay commands
56 |
57 | ### Updated
58 |
59 | - ChannelPayment type - breaking change
60 |
61 | ## [0.2.18] - 2021-11-03
62 |
63 | ### Fixed
64 |
65 | - ussd input on first dial
66 |
67 | ## [0.2.17] - 2021-10-25
68 |
69 | ### Fixed
70 |
71 | - Email tests
72 | - Simulator email send
73 |
74 |
75 | ## [0.2.16] - 2021-09-23
76 |
77 | ### Updated
78 |
79 | - Fix simulator notifications
80 |
81 | ## [0.2.15] - 2021-09-08
82 |
83 | ### Updated
84 |
85 | - Remove attachment from email body
86 |
87 | ## [0.2.14] - 2021-09-06
88 |
89 | ### Added
90 |
91 | - Reconnect on transport close - unless disconnect() was called
92 |
93 | ## [0.2.12-0.2.13] - 2021-09-06
94 |
95 | ### Added
96 |
97 | - Remove payment mode
98 | - Replace ActivityChannel with source
99 |
100 | ## [0.2.4-0.2.11] - 2021-08-10
101 |
102 | ### Added
103 |
104 | - Make reconnect timeout configurable
105 | - Make server host/port configurable
106 | - Customer utilities for tags, metadata and secondary Ids
107 |
108 | ### Fixes
109 |
110 | - Messaging state schema
111 | - Typescript definitions
112 | - Ussd input schema
113 |
114 |
115 | ## [0.2.3] - 2021-04-22
116 |
117 | ### Fixes
118 |
119 | - Improve connection management
120 |
121 |
122 | ## [0.2.2] - 2021-03-12
123 |
124 | ### Added
125 |
126 | - ChannelPayment as a debit/credit party for initiatePayment()
127 |
128 | ### Fixed
129 |
130 | - Simulator tests
131 | - Simulator notification data
132 |
133 | ## [0.2.1] - 2021-03-11
134 |
135 | ### Fixed
136 |
137 | - Message notification data
138 | - Simulator receiveMessage data
139 |
140 |
141 | ## [0.2.0] - 2021-03-11
142 |
143 | ### Added
144 |
145 | - Implement SDK spec.
146 |
147 |
--------------------------------------------------------------------------------
/CODE_OF_CODUCT.md:
--------------------------------------------------------------------------------
1 |
2 | # Contributor Covenant Code of Conduct
3 |
4 | ## Our Pledge
5 |
6 | We as members, contributors, and leaders pledge to make participation in our
7 | community a harassment-free experience for everyone, regardless of age, body
8 | size, visible or invisible disability, ethnicity, sex characteristics, gender
9 | identity and expression, level of experience, education, socio-economic status,
10 | nationality, personal appearance, race, caste, color, religion, or sexual
11 | identity and orientation.
12 |
13 | We pledge to act and interact in ways that contribute to an open, welcoming,
14 | diverse, inclusive, and healthy community.
15 |
16 | ## Our Standards
17 |
18 | Examples of behavior that contributes to a positive environment for our
19 | community include:
20 |
21 | * Demonstrating empathy and kindness toward other people
22 | * Being respectful of differing opinions, viewpoints, and experiences
23 | * Giving and gracefully accepting constructive feedback
24 | * Accepting responsibility and apologizing to those affected by our mistakes,
25 | and learning from the experience
26 | * Focusing on what is best not just for us as individuals, but for the overall
27 | community
28 |
29 | Examples of unacceptable behavior include:
30 |
31 | * The use of sexualized language or imagery, and sexual attention or advances of
32 | any kind
33 | * Trolling, insulting or derogatory comments, and personal or political attacks
34 | * Public or private harassment
35 | * Publishing others' private information, such as a physical or email address,
36 | without their explicit permission
37 | * Other conduct which could reasonably be considered inappropriate in a
38 | professional setting
39 |
40 | ## Enforcement Responsibilities
41 |
42 | Community leaders are responsible for clarifying and enforcing our standards of
43 | acceptable behavior and will take appropriate and fair corrective action in
44 | response to any behavior that they deem inappropriate, threatening, offensive,
45 | or harmful.
46 |
47 | Community leaders have the right and responsibility to remove, edit, or reject
48 | comments, commits, code, wiki edits, issues, and other contributions that are
49 | not aligned to this Code of Conduct, and will communicate reasons for moderation
50 | decisions when appropriate.
51 |
52 | ## Scope
53 |
54 | This Code of Conduct applies within all community spaces, and also applies when
55 | an individual is officially representing the community in public spaces.
56 | Examples of representing our community include using an official e-mail address,
57 | posting via an official social media account, or acting as an appointed
58 | representative at an online or offline event.
59 |
60 | ## Enforcement
61 |
62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
63 | reported to the community leaders responsible for enforcement at
64 | info@elarian.com.
65 | All complaints will be reviewed and investigated promptly and fairly.
66 |
67 | All community leaders are obligated to respect the privacy and security of the
68 | reporter of any incident.
69 |
70 | ## Enforcement Guidelines
71 |
72 | Community leaders will follow these Community Impact Guidelines in determining
73 | the consequences for any action they deem in violation of this Code of Conduct:
74 |
75 | ### 1. Correction
76 |
77 | **Community Impact**: Use of inappropriate language or other behavior deemed
78 | unprofessional or unwelcome in the community.
79 |
80 | **Consequence**: A private, written warning from community leaders, providing
81 | clarity around the nature of the violation and an explanation of why the
82 | behavior was inappropriate. A public apology may be requested.
83 |
84 | ### 2. Warning
85 |
86 | **Community Impact**: A violation through a single incident or series of
87 | actions.
88 |
89 | **Consequence**: A warning with consequences for continued behavior. No
90 | interaction with the people involved, including unsolicited interaction with
91 | those enforcing the Code of Conduct, for a specified period of time. This
92 | includes avoiding interactions in community spaces as well as external channels
93 | like social media. Violating these terms may lead to a temporary or permanent
94 | ban.
95 |
96 | ### 3. Temporary Ban
97 |
98 | **Community Impact**: A serious violation of community standards, including
99 | sustained inappropriate behavior.
100 |
101 | **Consequence**: A temporary ban from any sort of interaction or public
102 | communication with the community for a specified period of time. No public or
103 | private interaction with the people involved, including unsolicited interaction
104 | with those enforcing the Code of Conduct, is allowed during this period.
105 | Violating these terms may lead to a permanent ban.
106 |
107 | ### 4. Permanent Ban
108 |
109 | **Community Impact**: Demonstrating a pattern of violation of community
110 | standards, including sustained inappropriate behavior, harassment of an
111 | individual, or aggression toward or disparagement of classes of individuals.
112 |
113 | **Consequence**: A permanent ban from any sort of public interaction within the
114 | community.
115 |
116 | ## Attribution
117 |
118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119 | version 2.1, available at
120 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121 |
122 | Community Impact Guidelines were inspired by
123 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124 |
125 | For answers to common questions about this code of conduct, see the FAQ at
126 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127 | [https://www.contributor-covenant.org/translations][translations].
128 |
129 | [homepage]: https://www.contributor-covenant.org
130 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131 | [Mozilla CoC]: https://github.com/mozilla/diversity
132 | [FAQ]: https://www.contributor-covenant.org/faq
133 | [translations]: https://www.contributor-covenant.org/translations
134 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Thank you for considering to contribute to Elarian.
4 |
5 | This document provides you with everything you need to get started. We encourage all sorts of contributions including (but not limited to):
6 |
7 | - Writing tutorials or blog posts
8 | - Improving the documentation
9 | - Submitting new features
10 | - Submitting bug reports and fixes
11 |
12 | ## Assumptions
13 |
14 | - You're familiar with GitHub PR workflow
15 | - You've read the Elarian documentation
16 | - Your change has an issue. Find an existing issue or open a new issue.
17 | - You've discussed the with Elarian community
18 |
19 | ## How to Contribute
20 |
21 | - Fork the Elarian repository in your own GitHub account.
22 |
23 | - Create a new Git branch
24 |
25 | - Make your changes on your branch.
26 | - Make sure tests are updated accordingly
27 |
28 | - Submit the branch as a PR pointing to the `master` branch of the Elarian repository.
29 | - A maintainer should comment and/or review your PR within a few hours or days.
30 |
31 | # Git Guidelines
32 |
33 | - We recommend commit messages follow the [Chris Beams](https://chris.beams.io/posts/git-commit/) style.
34 | - The PR title should be accurate and descriptive of the changes.
35 | - Draft PRs are recommended when you want to show that you are working on something and make your work visible.
36 | - [Convert your PR to a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress.
37 | - Maintainers will review the PR once you mark it as **ready for review**.
38 | - The branch related to the PR **must** be up-to-date with `master` before merging.
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 Elarian
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Elarian
2 |
3 | [](https://www.npmjs.org/package/elarian)
4 |
5 | > A framework that helps you build scalable, personalized customer engagement applications.
6 |
7 | ## Install
8 |
9 | You can install the package from [npm](https://www.npmjs.com/package/elarian) by running:
10 |
11 | ```bash
12 | $ npm install elarian@latest
13 | ```
14 |
15 | ## Usage
16 |
17 | ```javascript
18 |
19 | const { initializeClient } = require('elarian');
20 |
21 |
22 | // ...
23 |
24 | const elarian = await initializeClient({
25 | token: 'YOUR_TOKEN',
26 | appId: 'YOUR_APP_ID',
27 | });
28 |
29 | elarian.on('consentDenied', (userId) => {
30 | // ...
31 | });
32 |
33 | elarian.on('consentGranted', (userId, data) => {
34 | // ...
35 | });
36 |
37 | const { state } = await elarian.fetchAppState();
38 |
39 | await elarian.updateAppState(Buffer.from('abc'));
40 |
41 | await elarian.sendMessage('Hello test');
42 |
43 | await elarian.collectPayment({ amount: 10, currency: 'UGX' });
44 |
45 | ```
46 |
47 | ## Documentation
48 |
49 | For detailed info on this SDK, see the [reference](https://elarianltd.github.io/javascript-sdk/index.html).
50 |
51 | ## Development
52 |
53 | Run all tests:
54 |
55 | ```bash
56 | $ npm install
57 | $ npm test
58 | ```
59 |
60 | See [SDK Spec](https://github.com/ElarianLtd/sdk-spec) for reference.
61 |
62 | ## Contributing
63 |
64 | Pull requests are welcome. For major changes, please open an issue first
65 | to discuss what you would like to change.
66 |
67 | Read the [contribution guide](CONTRIBUTING.md) for more information.
68 |
69 | ## Issues
70 |
71 | If you find a bug, please file an issue on [our issue tracker on GitHub](https://github.com/ElarianLtd/javascript-sdk/issues).
72 |
73 | ## Known Issues
74 |
75 | - Missing partial state updates
76 | - Missing consent event notifications
77 | - Missing sendMessage() and collectPayment() implementations
78 |
--------------------------------------------------------------------------------
/docs/Client.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Class: Client
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Class: Client
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 | (config)
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
(config)
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
Instantiate an elarian client. You have to call connect() on then client to start using it
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
Parameters:
64 |
65 |
66 |
67 |
68 |
69 |
70 | Name
71 |
72 |
73 | Type
74 |
75 |
76 |
77 |
78 |
79 | Description
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 | config
92 |
93 |
94 | ClientConfig
99 |
100 |
101 |
102 |
103 |
104 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 | Source:
144 |
155 |
156 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
Methods
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 |
205 |
206 |
207 |
208 |
209 |
Connecto to elarian servers
210 |
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
243 |
244 |
245 |
246 |
247 |
248 |
249 |
250 |
251 | Source:
252 |
263 |
264 |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
274 |
275 |
276 |
277 |
278 | Returns:
279 |
280 |
281 |
282 |
this instance
283 |
288 |
289 | Type
290 |
291 |
292 |
293 | Elarian
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 | ()
319 |
Disconnect from the elarian server
320 |
335 |
336 |
337 |
338 |
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
347 |
348 |
349 |
350 |
351 |
352 |
353 |
354 |
355 |
356 |
357 |
358 |
359 |
360 |
361 | Source:
362 |
373 |
374 |
375 |
376 |
377 |
378 |
379 |
380 |
381 |
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 | () → {boolean}
407 |
Check if client is connected
408 |
423 |
424 |
425 |
426 |
427 |
428 |
429 |
430 |
431 |
432 |
433 |
434 |
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
446 |
447 |
448 |
449 | Source:
450 |
461 |
462 |
463 |
464 |
465 |
466 |
467 |
468 |
469 |
470 |
471 |
472 |
473 |
474 |
475 |
476 | Returns:
477 |
478 |
479 |
480 |
481 |
482 |
483 | Type
484 |
485 |
486 |
487 | boolean
488 |
489 |
490 |
491 |
492 |
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 |
502 |
503 |
504 |
505 | (event, handler) → {Client }
513 |
Register a listener to watch out for events. Can also be called with client.registerListerner(event,listener)
514 |
Parameters:
525 |
526 |
527 |
528 |
529 |
530 |
531 | Name
532 |
533 |
534 | Type
535 |
536 |
537 |
538 |
539 |
540 | Description
541 |
542 |
543 |
544 |
545 |
546 |
547 |
548 |
549 | event
553 |
554 |
555 | Event
560 |
561 |
562 |
563 |
564 |
565 | The event whose listener to register
567 |
568 |
569 |
570 |
571 |
572 | handler
576 |
577 |
578 | NotificationHandler
583 |
584 |
585 |
586 |
587 |
588 | A function that reacts to events
590 |
591 |
592 |
593 |
594 |
595 |
596 |
597 |
598 |
599 |
600 |
601 |
602 |
603 |
604 |
605 |
606 |
607 |
608 |
609 |
610 |
611 |
612 |
613 |
614 |
615 |
616 |
617 |
618 |
619 |
620 |
621 |
622 |
623 |
624 |
625 |
626 |
627 | Source:
628 |
639 |
640 |
641 |
642 |
643 |
644 |
645 |
646 |
647 |
648 |
649 |
650 |
651 |
652 |
653 |
654 | Returns:
655 |
656 |
657 |
658 |
this instance
659 |
664 |
665 | Type
666 |
667 |
668 |
669 | Client
673 |
674 |
675 |
676 |
677 |
678 |
679 |
680 |
681 |
682 |
683 |
684 |
685 |
686 |
687 | (event, handler) → {Client }
695 |
Register a listener to watch out for events. Can also be called with client.on(event,listener)
696 |
Parameters:
707 |
708 |
709 |
710 |
711 |
712 |
713 | Name
714 |
715 |
716 | Type
717 |
718 |
719 |
720 |
721 |
722 | Description
723 |
724 |
725 |
726 |
727 |
728 |
729 |
730 |
731 | event
735 |
736 |
737 | Event
742 |
743 |
744 |
745 |
746 |
747 | The event whose listener to register
749 |
750 |
751 |
752 |
753 |
754 | handler
758 |
759 |
760 | NotificationHandler
765 |
766 |
767 |
768 |
769 |
770 | A function that reacts to events
772 |
773 |
774 |
775 |
776 |
777 |
778 |
779 |
780 |
781 |
782 |
783 |
784 |
785 |
786 |
787 |
788 |
789 |
790 |
791 |
792 |
793 |
794 |
795 |
796 |
797 |
798 |
799 |
800 |
801 |
802 |
803 |
804 |
805 |
806 |
807 |
808 |
809 | Source:
810 |
821 |
822 |
823 |
824 |
825 |
826 |
827 |
828 |
829 |
830 |
831 |
832 |
833 |
834 |
835 |
836 | Returns:
837 |
838 |
839 |
840 |
this instance
841 |
846 |
847 | Type
848 |
849 |
850 |
851 | Client
855 |
856 |
857 |
858 |
859 |
860 |
861 |
862 |
863 |
864 |
865 |
866 |
867 |
868 |
869 |
870 |
871 |
872 |
873 |
874 |
875 |
876 |
879 | Classes Global
880 |
881 |
882 |
885 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
886 |
887 |
888 |
889 |
890 |
891 |
--------------------------------------------------------------------------------
/docs/Elarian.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Class: Elarian
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Class: Elarian
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 | (config)
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
(config)
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
Instantiate an elarian client. You have to call connect() on the client to start using it
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
Parameters:
64 |
65 |
66 |
67 |
68 |
69 |
70 | Name
71 |
72 |
73 | Type
74 |
75 |
76 |
77 |
78 |
79 | Description
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
88 | config
92 |
93 |
94 | ClientConfig
99 |
100 |
101 |
102 |
103 |
104 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 | Source:
144 |
155 |
156 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
Extends
180 |
181 |
182 |
183 |
184 |
187 |
188 |
189 |
190 |
191 |
192 |
193 |
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 | Methods
205 |
206 |
207 |
208 |
209 |
210 |
211 |
212 | (amount) → {Response }
220 |
Initiale payment collection from user
221 |
Parameters:
232 |
233 |
234 |
235 |
236 |
237 |
238 | Name
239 |
240 |
241 | Type
242 |
243 |
244 |
245 |
246 |
247 | Description
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
256 | amount
260 |
261 |
262 | Cash
267 |
268 |
269 |
270 |
271 |
272 |
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
282 |
283 |
284 |
285 |
286 |
287 |
288 |
289 |
290 |
291 |
292 |
293 |
294 |
295 |
296 |
297 |
298 |
299 |
300 |
301 |
302 |
303 |
304 |
305 |
306 |
307 |
308 |
309 |
310 |
311 | Source:
312 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
332 |
333 |
334 |
335 |
336 |
337 |
338 | Returns:
339 |
340 |
341 |
342 |
343 |
344 |
345 | Type
346 |
347 |
348 |
349 | Response
353 |
354 |
355 |
356 |
357 |
358 |
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
Connecto to elarian servers
376 |
391 |
392 |
393 |
394 |
395 |
396 |
397 | Inherited From:
398 | Source:
423 |
434 |
435 |
436 |
437 |
438 |
439 |
440 |
441 |
442 |
443 |
444 |
445 |
446 |
447 |
448 |
449 | Returns:
450 |
451 |
452 |
453 |
this instance
454 |
459 |
460 | Type
461 |
462 |
463 |
464 | Elarian
468 |
469 |
470 |
471 |
472 |
473 |
474 |
475 |
476 |
477 |
478 |
479 |
480 |
481 |
482 | ()
490 |
Disconnect from the elarian server
491 |
506 |
507 |
508 |
509 |
510 |
511 |
512 | Inherited From:
513 | Source:
538 |
549 |
550 |
551 |
552 |
553 |
554 |
555 |
556 |
557 |
558 |
559 |
560 |
561 |
562 |
563 |
564 |
565 |
566 |
567 |
568 |
569 |
570 |
571 |
572 |
573 |
574 |
575 | (appIds) → {AppState |Array.<AppState >}
583 |
Fetch your app state
584 |
Parameters:
595 |
596 |
597 |
598 |
599 |
600 |
601 | Name
602 |
603 |
604 | Type
605 |
606 |
607 |
608 |
609 |
610 | Description
611 |
612 |
613 |
614 |
615 |
616 |
617 |
618 |
619 | appIds
623 |
624 |
625 | Array.<String>
626 |
627 |
628 |
629 |
630 |
631 |
632 |
633 |
634 |
635 | Other apps whose state you want to get. This trigger a consent notification to the user
637 |
638 |
639 |
640 |
641 |
642 |
643 |
644 |
645 |
646 |
647 |
648 |
649 |
650 |
651 |
652 |
653 |
654 |
655 |
656 |
657 |
658 |
659 |
660 |
661 |
662 |
663 |
664 |
665 |
666 |
667 |
668 |
669 |
670 |
671 |
672 |
673 |
674 | Source:
675 |
686 |
687 |
688 |
689 |
690 |
691 |
692 |
693 |
694 |
695 |
696 |
697 |
698 |
699 |
700 |
701 | Returns:
702 |
703 |
704 |
705 |
706 |
707 |
708 | Type
709 |
710 |
711 |
712 | AppState Array.<AppState >
716 |
717 |
718 |
719 |
720 |
721 |
722 |
723 |
724 |
725 |
726 |
727 |
728 |
729 |
730 |
731 |
732 |
733 | () → {boolean}
741 |
Check if client is connected
742 |
757 |
758 |
759 |
760 |
761 |
762 |
763 | Inherited From:
764 | Source:
789 |
800 |
801 |
802 |
803 |
804 |
805 |
806 |
807 |
808 |
809 |
810 |
811 |
812 |
813 |
814 |
815 | Returns:
816 |
817 |
818 |
819 |
820 |
821 |
822 | Type
823 |
824 |
825 |
826 | boolean
827 |
828 |
829 |
830 |
831 |
832 |
833 |
834 |
835 |
836 |
837 |
838 |
839 |
840 |
841 |
842 |
843 |
844 | (event, handler) → {Client }
852 |
Register a listener to watch out for events. Can also be called with client.registerListerner(event,listener)
853 |
Parameters:
864 |
865 |
866 |
867 |
868 |
869 |
870 | Name
871 |
872 |
873 | Type
874 |
875 |
876 |
877 |
878 |
879 | Description
880 |
881 |
882 |
883 |
884 |
885 |
886 |
887 |
888 | event
892 |
893 |
894 | Event
899 |
900 |
901 |
902 |
903 |
904 | The event whose listener to register
906 |
907 |
908 |
909 |
910 |
911 | handler
915 |
916 |
917 | NotificationHandler
922 |
923 |
924 |
925 |
926 |
927 | A function that reacts to events
929 |
930 |
931 |
932 |
933 |
934 |
935 |
936 |
937 |
938 |
939 |
940 |
941 |
942 |
943 |
944 |
945 |
946 | Inherited From:
947 | Source:
972 |
983 |
984 |
985 |
986 |
987 |
988 |
989 |
990 |
991 |
992 |
993 |
994 |
995 |
996 |
997 |
998 | Returns:
999 |
1000 |
1001 |
1002 |
this instance
1003 |
1008 |
1009 | Type
1010 |
1011 |
1012 |
1013 | Client
1017 |
1018 |
1019 |
1020 |
1021 |
1022 |
1023 |
1024 |
1025 |
1026 |
1027 |
1028 |
1029 |
1030 |
1031 | (event, handler) → {Client }
1039 |
Register a listener to watch out for events. Can also be called with client.on(event,listener)
1040 |
Parameters:
1051 |
1052 |
1053 |
1054 |
1055 |
1056 |
1057 | Name
1058 |
1059 |
1060 | Type
1061 |
1062 |
1063 |
1064 |
1065 |
1066 | Description
1067 |
1068 |
1069 |
1070 |
1071 |
1072 |
1073 |
1074 |
1075 | event
1079 |
1080 |
1081 | Event
1086 |
1087 |
1088 |
1089 |
1090 |
1091 | The event whose listener to register
1093 |
1094 |
1095 |
1096 |
1097 |
1098 | handler
1102 |
1103 |
1104 | NotificationHandler
1109 |
1110 |
1111 |
1112 |
1113 |
1114 | A function that reacts to events
1116 |
1117 |
1118 |
1119 |
1120 |
1121 |
1122 |
1123 |
1124 |
1125 |
1126 |
1127 |
1128 |
1129 |
1130 |
1131 |
1132 |
1133 | Inherited From:
1134 | Source:
1159 |
1170 |
1171 |
1172 |
1173 |
1174 |
1175 |
1176 |
1177 |
1178 |
1179 |
1180 |
1181 |
1182 |
1183 |
1184 |
1185 | Returns:
1186 |
1187 |
1188 |
1189 |
this instance
1190 |
1195 |
1196 | Type
1197 |
1198 |
1199 |
1200 | Client
1204 |
1205 |
1206 |
1207 |
1208 |
1209 |
1210 |
1211 |
1212 |
1213 |
1214 |
1215 |
1216 |
1217 |
1218 | (message) → {Response }
1226 |
Send user a message
1227 |
Parameters:
1238 |
1239 |
1240 |
1241 |
1242 |
1243 |
1244 | Name
1245 |
1246 |
1247 | Type
1248 |
1249 |
1250 |
1251 |
1252 |
1253 | Description
1254 |
1255 |
1256 |
1257 |
1258 |
1259 |
1260 |
1261 |
1262 | message
1266 |
1267 |
1268 | string
1269 |
1270 |
1271 |
1272 |
1273 |
1274 |
1275 |
1276 |
1277 |
1278 |
1280 |
1281 |
1282 |
1283 |
1284 |
1285 |
1286 |
1287 |
1288 |
1289 |
1290 |
1291 |
1292 |
1293 |
1294 |
1295 |
1296 |
1297 |
1298 |
1299 |
1300 |
1301 |
1302 |
1303 |
1304 |
1305 |
1306 |
1307 |
1308 |
1309 |
1310 |
1311 |
1312 |
1313 |
1314 |
1315 |
1316 |
1317 | Source:
1318 |
1329 |
1330 |
1331 |
1332 |
1333 |
1334 |
1335 |
1336 |
1337 |
1338 |
1339 |
1340 |
1341 |
1342 |
1343 |
1344 | Returns:
1345 |
1346 |
1347 |
1348 |
1349 |
1350 |
1351 | Type
1352 |
1353 |
1354 |
1355 | Response
1359 |
1360 |
1361 |
1362 |
1363 |
1364 |
1365 |
1366 |
1367 |
1368 |
1369 |
1370 |
1371 |
1372 |
1373 | (data) → {AppState }
1381 |
Update app state
1382 |
Parameters:
1393 |
1394 |
1395 |
1396 |
1397 |
1398 |
1399 | Name
1400 |
1401 |
1402 | Type
1403 |
1404 |
1405 |
1406 |
1407 |
1408 | Description
1409 |
1410 |
1411 |
1412 |
1413 |
1414 |
1415 |
1416 |
1417 | data
1421 |
1422 |
1423 | Buffer
1424 |
1425 |
1426 |
1427 |
1428 |
1429 |
1430 |
1431 |
1432 |
1433 |
1435 |
1436 |
1437 |
1438 |
1439 |
1440 |
1441 |
1442 |
1443 |
1444 |
1445 |
1446 |
1447 |
1448 |
1449 |
1450 |
1451 |
1452 |
1453 |
1454 |
1455 |
1456 |
1457 |
1458 |
1459 |
1460 |
1461 |
1462 |
1463 |
1464 |
1465 |
1466 |
1467 |
1468 |
1469 |
1470 |
1471 |
1472 | Source:
1473 |
1484 |
1485 |
1486 |
1487 |
1488 |
1489 |
1490 |
1491 |
1492 |
1493 |
1494 |
1495 |
1496 |
1497 |
1498 |
1499 | Returns:
1500 |
1501 |
1502 |
1503 |
1504 |
1505 |
1506 | Type
1507 |
1508 |
1509 |
1510 | AppState
1514 |
1515 |
1516 |
1517 |
1518 |
1519 |
1520 |
1521 |
1522 |
1523 |
1524 |
1525 |
1526 |
1527 |
1528 |
1529 |
1530 |
1531 |
1532 |
1533 |
1534 |
1535 |
1538 | Classes Global
1539 |
1540 |
1541 |
1544 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
1545 |
1546 |
1547 |
1548 |
1549 |
1550 |
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | ## Classes
2 |
3 |
4 | Client Elarian ⇐ Client
9 |
10 | ## Functions
11 |
12 |
13 | initializeClient(config) ⇒ Elarian Initialize a client
16 |
17 | Elarian](#Elarian)
25 | * [.isConnected()](#Client+isConnected) ⇒ boolean
26 | * [.disconnect()](#Client+disconnect)
27 | * [.registerNotificationHandler(event, handler)](#Client+registerNotificationHandler) ⇒ [Client](#Client)
28 | * [.on(event, handler)](#Client+on) ⇒ [Client](#Client)
29 |
30 | Instantiate an elarian client. You have to call connect() on then client to start using it
34 |
35 |
36 | | Param | Type |
37 | | --- | --- |
38 | | config | ClientConfig |
39 |
40 | Elarian](#Elarian)
43 | Connecto to elarian servers
44 |
45 | **Kind**: instance method of [Client](#Client)
46 | **Returns**: [Elarian](#Elarian) - this instance
47 | boolean
50 | Check if client is connected
51 |
52 | **Kind**: instance method of [Client](#Client)
53 | Disconnect from the elarian server
57 |
58 | **Kind**: instance method of [Client](#Client)
59 | Client](#Client)
62 | Register a listener to watch out for events. Can also be called with client.on(event,listener)
63 |
64 | **Kind**: instance method of [Client](#Client)
65 | **Returns**: [Client](#Client) - this instance
66 |
67 | | Param | Type | Description |
68 | | --- | --- | --- |
69 | | event | Event | The event whose listener to register
|
70 | | handler | NotificationHandler | A function that reacts to events
|
71 |
72 | Client](#Client)
75 | Register a listener to watch out for events. Can also be called with client.registerListerner(event,listener)
76 |
77 | **Kind**: instance method of [Client](#Client)
78 | **Returns**: [Client](#Client) - this instance
79 |
80 | | Param | Type | Description |
81 | | --- | --- | --- |
82 | | event | Event | The event whose listener to register
|
83 | | handler | NotificationHandler | A function that reacts to events
|
84 |
85 | Client](#Client)
88 | **Kind**: global class
89 | **Extends**: [Client](#Client)
90 |
91 | * [Elarian](#Elarian) ⇐ [Client](#Client)
92 | * [new Elarian(config)](#new_Elarian_new)
93 | * [.fetchAppState(appIds)](#Elarian+fetchAppState) ⇒ AppState \| Array.<AppState>
94 | * [.updateAppState(data)](#Elarian+updateAppState) ⇒ AppState
95 | * [.sendMessage(message)](#Elarian+sendMessage) ⇒ Response
96 | * [.collectPayment(amount)](#Elarian+collectPayment) ⇒ Response
97 | * [.connect()](#Client+connect) ⇒ [Elarian](#Elarian)
98 | * [.isConnected()](#Client+isConnected) ⇒ boolean
99 | * [.disconnect()](#Client+disconnect)
100 | * [.registerNotificationHandler(event, handler)](#Client+registerNotificationHandler) ⇒ [Client](#Client)
101 | * [.on(event, handler)](#Client+on) ⇒ [Client](#Client)
102 |
103 | Instantiate an elarian client. You have to call connect() on the client to start using it
107 |
108 |
109 | | Param | Type |
110 | | --- | --- |
111 | | config | ClientConfig |
112 |
113 | AppState \| Array.<AppState>
116 | Fetch your app state
117 |
118 | **Kind**: instance method of [Elarian](#Elarian)
119 |
120 | | Param | Type | Description |
121 | | --- | --- | --- |
122 | | appIds | Array.<String> | Other apps whose state you want to get. This trigger a consent notification to the user
|
123 |
124 | AppState
127 | Update app state
128 |
129 | **Kind**: instance method of [Elarian](#Elarian)
130 |
131 | | Param | Type |
132 | | --- | --- |
133 | | data | Buffer |
134 |
135 | Response
138 | Send user a message
139 |
140 | **Kind**: instance method of [Elarian](#Elarian)
141 |
142 | | Param | Type |
143 | | --- | --- |
144 | | message | string |
145 |
146 | Response
149 | Initiale payment collection from user
150 |
151 | **Kind**: instance method of [Elarian](#Elarian)
152 |
153 | | Param | Type |
154 | | --- | --- |
155 | | amount | Cash |
156 |
157 | Elarian](#Elarian)
160 | Connecto to elarian servers
161 |
162 | **Kind**: instance method of [Elarian](#Elarian)
163 | **Returns**: [Elarian](#Elarian) - this instance
164 | boolean
167 | Check if client is connected
168 |
169 | **Kind**: instance method of [Elarian](#Elarian)
170 | Disconnect from the elarian server
174 |
175 | **Kind**: instance method of [Elarian](#Elarian)
176 | Client](#Client)
179 | Register a listener to watch out for events. Can also be called with client.on(event,listener)
180 |
181 | **Kind**: instance method of [Elarian](#Elarian)
182 | **Returns**: [Client](#Client) - this instance
183 |
184 | | Param | Type | Description |
185 | | --- | --- | --- |
186 | | event | Event | The event whose listener to register
|
187 | | handler | NotificationHandler | A function that reacts to events
|
188 |
189 | Client](#Client)
192 | Register a listener to watch out for events. Can also be called with client.registerListerner(event,listener)
193 |
194 | **Kind**: instance method of [Elarian](#Elarian)
195 | **Returns**: [Client](#Client) - this instance
196 |
197 | | Param | Type | Description |
198 | | --- | --- | --- |
199 | | event | Event | The event whose listener to register
|
200 | | handler | NotificationHandler | A function that reacts to events
|
201 |
202 | Elarian](#Elarian)
205 | Initialize a client
206 |
207 | **Kind**: global function
208 |
209 | | Param | Type |
210 | | --- | --- |
211 | | config | ClientConfig |
212 |
213 |
--------------------------------------------------------------------------------
/docs/client.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Source: client.js
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Source: client.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | /* eslint-disable max-len */
30 | /* eslint-disable no-underscore-dangle */
31 | const grpc = require('@grpc/grpc-js');
32 | const validate = require('validate.js');
33 | const protoLoader = require('@grpc/proto-loader');
34 |
35 | const utils = require('./utils');
36 |
37 | const { log } = utils;
38 |
39 | /**
40 | * Instantiate an elarian client. You have to call connect() on then client to start using it
41 | * @class
42 | * @param {ClientConfig} config
43 | */
44 | function Client(config) {
45 | const conf = {
46 | ...config,
47 | };
48 | const constraints = {
49 | appId: {
50 | type: 'string',
51 | presence: true,
52 | },
53 | token: {
54 | type: 'string',
55 | presence: true,
56 | },
57 | options: {
58 | type: 'object',
59 | },
60 | };
61 |
62 | const error = validate(conf, constraints);
63 | if (error) {
64 | throw error;
65 | }
66 |
67 | this.config = {
68 | ...conf,
69 | options: conf.options || {
70 | uris: {
71 | social: 'id.elarian.com:443',
72 | state: 'api.elarian.com:443',
73 | },
74 | },
75 | };
76 | this._socialService = null;
77 | this._appStateService = null;
78 |
79 | this.eventListeners = {
80 | // Connection
81 | error: null,
82 | closed: null,
83 | pending: null,
84 | connected: null,
85 | connecting: null,
86 | };
87 |
88 | /**
89 | * Connecto to elarian servers
90 | * @returns {Elarian} this instance
91 | */
92 | this.connect = function connect() {
93 | // TODO: Connect to notification service
94 |
95 | if (this.eventListeners.connected) {
96 | this.eventListeners.connected();
97 | }
98 | return this;
99 | };
100 |
101 | /**
102 | * Check if client is connected
103 | * @returns {boolean}
104 | */
105 | this.isConnected = function isConnected() {
106 | return this._isConnected;
107 | };
108 |
109 | /**
110 | * Disconnect from the elarian server
111 | */
112 | this.disconnect = function disconnect() {
113 | // TODO: Disconnect from notification service
114 |
115 | if (this.eventListeners.closed) {
116 | this.eventListeners.closed();
117 | }
118 | };
119 |
120 | const cleanup = (code) => {
121 | log.warn(`Disconnecting from API server(${code})`);
122 | this.disconnect();
123 | process.exit(code);
124 | };
125 |
126 | process.on('SIGINT', cleanup.bind(null));
127 | process.on('SIGQUIT', cleanup.bind(null));
128 | process.on('SIGTERM', cleanup.bind(null));
129 | }
130 |
131 | // eslint-disable-next-line no-underscore-dangle
132 | Client.prototype._getAppStateService = function _getAppStateService() {
133 | if (this._appStateService) {
134 | return this._appStateService;
135 | }
136 |
137 | const { options } = this.config;
138 | const uri = options.uris.state;
139 | const def = protoLoader.loadSync(
140 | utils.SERVICE_PROTO.APP_STATE,
141 | {
142 | keepCase: true,
143 | longs: String,
144 | enums: String,
145 | defaults: true,
146 | oneofs: true,
147 | },
148 | );
149 | const pd = grpc.loadPackageDefinition(def);
150 | const credentials = options.dev ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
151 | this._appStateService = new pd.com.elarian.hera.proto.AppStateService(uri, credentials);
152 | return this._appStateService;
153 | };
154 |
155 | // eslint-disable-next-line no-underscore-dangle
156 | Client.prototype._getSocialService = function _getSocialService() {
157 | if (this._socialService) {
158 | return this._socialService;
159 | }
160 |
161 | const { options } = this.config;
162 | const uri = options.uris.social;
163 | const def = protoLoader.loadSync(
164 | utils.SERVICE_PROTO.SOCIAL,
165 | {
166 | keepCase: true,
167 | longs: String,
168 | enums: String,
169 | defaults: true,
170 | oneofs: true,
171 | },
172 | );
173 | const pd = grpc.loadPackageDefinition(def);
174 | const credentials = options.dev ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
175 | this._socialService = new pd.com.elarian.hera.proto.SocialService(uri, credentials);
176 | return this._socialService;
177 | };
178 |
179 | // eslint-disable-next-line no-underscore-dangle
180 | Client.prototype._notificationHandler = () => (payload) => {
181 | log.debug(`TODO: Handle incoming ${payload}`);
182 | };
183 |
184 | /**
185 | * Register a listener to watch out for events. Can also be called with <code>client.on(event,listener)</code>
186 | * @param {Event} event The event whose listener to register
187 | * @param {NotificationHandler} handler A function that reacts to events
188 | * @returns {Client} this instance
189 | */
190 | Client.prototype.registerNotificationHandler = function registerNotificationHandler(event, handler) {
191 | const events = Object.keys(this.eventListeners);
192 | if (!events.includes(event)) {
193 | throw new Error(`Unexpected event ${event}. Must be one of ${events}`);
194 | }
195 | this.eventListeners[event] = handler;
196 | return this;
197 | };
198 |
199 | /**
200 | * Register a listener to watch out for events. Can also be called with <code>client.registerListerner(event,listener)</code>
201 | * @param {Event} event The event whose listener to register
202 | * @param {NotificationHandler} handler A function that reacts to events
203 | * @returns {Client} this instance
204 | */
205 | Client.prototype.on = function on(event, handler) { return this.registerNotificationHandler(event, handler); };
206 |
207 | module.exports = Client;
208 |
210 |
211 |
212 |
213 |
214 |
215 |
218 | Classes Global
219 |
220 |
221 |
224 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
225 |
226 |
227 |
228 |
229 |
230 |
231 |
--------------------------------------------------------------------------------
/docs/elarian.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Source: elarian.js
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Source: elarian.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | /* eslint-disable max-len */
30 | /* eslint-disable no-underscore-dangle */
31 | const Client = require('./client');
32 |
33 | /**
34 | * Instantiate an elarian client. You have to call connect() on the client to start using it
35 | * @class
36 | * @extends Client
37 | * @param {ClientConfig} config
38 | */
39 | function Elarian(config) {
40 | Client.call(this, config);
41 |
42 | this.eventListeners = {
43 | ...this.eventListeners,
44 |
45 | // Core
46 | consentDenied: null,
47 | consentRevoked: null,
48 | };
49 | }
50 |
51 | Elarian.prototype = Object.create(Client.prototype, { constructor: Elarian });
52 |
53 | /**
54 | * Fetch your app state
55 | * @param {String[]} appIds Other apps whose state you want to get. This trigger a consent notification to the user
56 | * @returns {AppState|AppState[]}
57 | * @memberof Elarian
58 | */
59 | Elarian.prototype.fetchAppState = function fetchAppState(appIds = []) {
60 | const { appId, token } = this.config;
61 | const service = this._getAppStateService();
62 | return new Promise((resolve, reject) => {
63 | const params = {
64 | appId,
65 | token,
66 | appIds,
67 | };
68 | service.GetAppState(params, (error, result) => {
69 | if (error) {
70 | reject(error);
71 | } else if (appIds && appIds.length) {
72 | resolve(result.states);
73 | } else {
74 | resolve(result.states[0]);
75 | }
76 | });
77 | });
78 | };
79 |
80 | /**
81 | * Update app state
82 | * @param {Buffer} data
83 | * @returns {AppState}
84 | * @memberof Elarian
85 | */
86 | Elarian.prototype.updateAppState = function updateAppState(data) {
87 | if (!data) {
88 | throw new Error('data is required');
89 | }
90 | const { appId, token } = this.config;
91 | const service = this._getAppStateService();
92 | return new Promise((resolve, reject) => {
93 | const params = {
94 | state: {
95 | appId,
96 | token,
97 | state: data,
98 | },
99 | };
100 | service.UpdateAppState(params, (error, result) => {
101 | if (error) {
102 | reject(error);
103 | } else {
104 | resolve(result);
105 | }
106 | });
107 | });
108 | };
109 |
110 | /**
111 | * Send user a message
112 | * @param {string} message
113 | * @returns {Response}
114 | * @memberof Elarian
115 | */
116 | Elarian.prototype.sendMessage = function sendMessage(message) {
117 | if (!message) {
118 | throw new Error('message is required');
119 | }
120 | const { appId, token } = this.config;
121 | const service = this._getSocialService();
122 | return new Promise((resolve, reject) => {
123 | const params = {
124 | appId,
125 | token,
126 | message,
127 | };
128 | service.SendMessage(params, (error, result) => {
129 | if (error) {
130 | reject(error);
131 | } else {
132 | resolve(result);
133 | }
134 | });
135 | });
136 | };
137 |
138 | /**
139 | * Initiale payment collection from user
140 | * @param {Cash} amount
141 | * @returns {Response}
142 | * @memberof Elarian
143 | */
144 | Elarian.prototype.collectPayment = function sendMessage(amount) {
145 | if (!amount || !amount.value || !amount.currency) {
146 | throw new Error('A valid amount is required');
147 | }
148 | const { appId, token } = this.config;
149 | const service = this._getSocialService();
150 | return new Promise((resolve, reject) => {
151 | const params = {
152 | appId,
153 | token,
154 | amount,
155 | };
156 | service.CollectPayment(params, (error, result) => {
157 | if (error) {
158 | reject(error);
159 | } else {
160 | resolve(result);
161 | }
162 | });
163 | });
164 | };
165 |
166 | module.exports = Elarian;
167 |
169 |
170 |
171 |
172 |
173 |
174 |
177 | Classes Global
178 |
179 |
180 |
183 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
184 |
185 |
186 |
187 |
188 |
189 |
190 |
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Bold-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Bold-webfont.eot
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Bold-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Bold-webfont.woff
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-BoldItalic-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-BoldItalic-webfont.eot
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-BoldItalic-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-BoldItalic-webfont.woff
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Italic-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Italic-webfont.eot
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Italic-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Italic-webfont.woff
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Light-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Light-webfont.eot
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Light-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Light-webfont.woff
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-LightItalic-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-LightItalic-webfont.eot
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-LightItalic-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-LightItalic-webfont.woff
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Regular-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Regular-webfont.eot
--------------------------------------------------------------------------------
/docs/fonts/OpenSans-Regular-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ElarianLtd/javascript-sdk/87fd3e6e3e1d899aaa1a6bbf394b651a4c5b2008/docs/fonts/OpenSans-Regular-webfont.woff
--------------------------------------------------------------------------------
/docs/global.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Global
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Global
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
78 |
79 |
80 |
81 |
82 |
Methods
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 | (config) → {Elarian }
115 |
Initialize a client
116 |
Parameters:
127 |
128 |
129 |
130 |
131 |
132 |
133 | Name
134 |
135 |
136 | Type
137 |
138 |
139 |
140 |
141 |
142 | Description
143 |
144 |
145 |
146 |
147 |
148 |
149 |
150 |
151 | config
155 |
156 |
157 | ClientConfig
162 |
163 |
164 |
165 |
166 |
167 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
191 |
192 |
193 |
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 |
205 |
206 | Source:
207 |
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 | Returns:
234 |
235 |
236 |
237 |
238 |
239 |
240 | Type
241 |
242 |
243 |
244 | Elarian
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
256 |
257 |
258 |
259 |
260 | Type Definitions
261 |
262 |
263 |
264 | AppState
265 |
266 |
267 |
268 |
269 |
270 |
An object representing app state
271 |
Type:
276 |
277 |
278 |
279 | Object
280 |
281 |
282 |
283 |
284 |
285 |
286 |
287 |
288 |
289 | Properties:
290 |
291 |
292 |
293 |
294 |
295 |
296 |
297 | Name
298 |
299 |
300 | Type
301 |
302 |
303 |
304 |
305 |
306 | Description
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 |
315 | appId
319 |
320 |
321 | string
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 |
330 |
331 |
333 |
334 |
335 |
336 |
337 |
338 | token
342 |
343 |
344 | string
345 |
346 |
347 |
348 |
349 |
350 |
351 |
352 |
353 |
354 |
356 |
357 |
358 |
359 |
360 |
361 | state
365 |
366 |
367 | Buffer
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
379 |
380 |
381 |
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 |
391 |
392 |
393 |
394 |
395 |
396 |
397 |
398 |
399 |
400 |
401 |
402 |
403 |
404 |
405 |
406 |
407 |
408 |
409 |
410 |
411 |
412 |
413 |
414 | Source:
415 |
426 |
427 |
428 |
429 |
430 |
431 |
432 |
433 |
434 | Cash
435 |
436 |
437 |
438 |
439 |
440 |
An object representing cash
441 |
Type:
446 |
447 |
448 |
449 | Object
450 |
451 |
452 |
453 |
454 |
455 |
456 |
457 |
458 |
459 | Properties:
460 |
461 |
462 |
463 |
464 |
465 |
466 |
467 | Name
468 |
469 |
470 | Type
471 |
472 |
473 |
474 |
475 |
476 | Description
477 |
478 |
479 |
480 |
481 |
482 |
483 |
484 |
485 | value
489 |
490 |
491 | double
492 |
493 |
494 |
495 |
496 |
497 |
498 |
499 |
500 |
501 |
503 |
504 |
505 |
506 |
507 |
508 | currency
512 |
513 |
514 | string
515 |
516 |
517 |
518 |
519 |
520 |
521 |
522 |
523 |
524 |
526 |
527 |
528 |
529 |
530 |
531 |
532 |
533 |
534 |
535 |
536 |
537 |
538 |
539 |
540 |
541 |
542 |
543 |
544 |
545 |
546 |
547 |
548 |
549 |
550 |
551 |
552 |
553 |
554 |
555 |
556 |
557 |
558 |
559 |
560 |
561 | Source:
562 |
573 |
574 |
575 |
576 |
577 |
578 |
579 |
580 |
581 | ClientConfig
582 |
583 |
584 |
585 |
586 |
587 |
An object representing client params
588 |
Type:
593 |
594 |
595 |
596 | Object
597 |
598 |
599 |
600 |
601 |
602 |
603 |
604 |
605 |
606 | Properties:
607 |
608 |
609 |
610 |
611 |
612 |
613 |
614 | Name
615 |
616 |
617 | Type
618 |
619 |
620 | Attributes
621 |
622 |
623 |
624 |
625 | Description
626 |
627 |
628 |
629 |
630 |
631 |
632 |
633 |
634 | token
638 |
639 |
640 | string
641 |
642 |
643 |
644 |
645 |
646 |
647 |
648 |
649 |
650 |
651 |
652 |
653 |
654 |
655 |
656 |
658 |
659 |
660 |
661 |
662 |
663 | appId
667 |
668 |
669 | string
670 |
671 |
672 |
673 |
674 |
675 |
676 |
677 |
678 |
679 |
680 |
681 |
682 |
683 |
684 |
685 |
687 |
688 |
689 |
690 |
691 |
692 | options
696 |
697 |
698 | Object
699 |
700 |
701 |
702 |
703 |
704 |
705 |
706 |
707 | <optional>
712 |
713 |
714 |
715 |
716 |
718 |
719 |
720 |
721 |
722 |
723 |
724 |
725 |
726 |
727 |
728 |
729 |
730 |
731 |
732 |
733 |
734 |
735 |
736 |
737 |
738 |
739 |
740 |
741 |
742 |
743 |
744 |
745 |
746 |
747 |
748 |
749 |
750 |
751 |
752 |
753 | Source:
754 |
765 |
766 |
767 |
768 |
769 |
770 |
771 |
772 |
773 | Event
774 |
775 |
776 |
777 |
778 |
779 |
An string representing an event. Must be one of:
780 |
781 | Connection Events:
782 |
783 | error : Emitted on connection errorclosed : Emitted on connection closedpending : Emitted when not connectedconnected : Emitted on connection successconnecting : Emitted when connecting
789 |
790 | App Events
791 |
792 | consentDenied : ...consentRevoked : ...
795 |
796 |
797 |
Type:
802 |
803 |
804 |
805 | string
806 |
807 |
808 |
809 |
810 |
811 |
812 |
813 |
814 |
815 |
816 |
817 |
818 |
819 |
820 |
821 |
822 |
823 |
824 |
825 |
826 |
827 |
828 |
829 |
830 |
831 |
832 |
833 |
834 |
835 |
836 |
837 |
838 |
839 |
840 |
841 |
842 | Source:
843 |
854 |
855 |
856 |
857 |
858 |
859 |
860 |
861 |
862 |
863 |
864 |
865 |
866 | (notification, callbackopt ) → {void}
874 |
A function that reacts to events
875 |
Parameters:
886 |
887 |
888 |
889 |
890 |
891 |
892 | Name
893 |
894 |
895 | Type
896 |
897 |
898 | Attributes
899 |
900 |
901 |
902 |
903 | Description
904 |
905 |
906 |
907 |
908 |
909 |
910 |
911 |
912 | notification
916 |
917 |
918 | Notification
919 |
920 |
921 |
922 |
923 |
924 |
925 |
926 |
927 |
928 |
929 |
930 |
931 |
932 |
933 |
934 |
935 |
936 |
938 |
939 |
940 |
941 |
942 |
943 | callback
947 |
948 |
949 | NotificationCallback
950 |
951 |
952 |
953 |
954 |
955 |
956 |
957 |
958 | <optional>
965 |
966 |
967 |
968 |
969 | A response to the event. Required for voice and ussd events
971 |
972 |
973 |
974 |
975 |
976 |
977 |
978 |
979 |
980 |
981 |
982 |
983 |
984 |
985 |
986 |
987 |
988 |
989 |
990 |
991 |
992 |
993 |
994 |
995 |
996 |
997 |
998 |
999 |
1000 |
1001 |
1002 |
1003 |
1004 |
1005 |
1006 |
1007 |
1008 | Source:
1009 |
1020 |
1021 |
1022 |
1023 |
1024 |
1025 |
1026 |
1027 |
1028 |
1029 |
1030 |
1031 |
1032 |
1033 |
1034 |
1035 | Returns:
1036 |
1037 |
1038 |
1039 |
1040 |
1041 |
1042 | Type
1043 |
1044 |
1045 |
1046 | void
1047 |
1048 |
1049 |
1050 |
1051 |
1052 |
1053 |
1054 |
1055 |
1056 |
1057 |
1058 |
1059 |
1060 | Response
1061 |
1062 |
1063 |
1064 |
1065 |
1066 |
An object representing a response
1067 |
Type:
1072 |
1073 |
1074 |
1075 | Object
1076 |
1077 |
1078 |
1079 |
1080 |
1081 |
1082 |
1083 |
1084 |
1085 | Properties:
1086 |
1087 |
1088 |
1089 |
1090 |
1091 |
1092 |
1093 | Name
1094 |
1095 |
1096 | Type
1097 |
1098 |
1099 |
1100 |
1101 |
1102 | Description
1103 |
1104 |
1105 |
1106 |
1107 |
1108 |
1109 |
1110 |
1111 | success
1115 |
1116 |
1117 | boolean
1118 |
1119 |
1120 |
1121 |
1122 |
1123 |
1124 |
1125 |
1126 |
1127 |
1129 |
1130 |
1131 |
1132 |
1133 |
1134 | message
1138 |
1139 |
1140 | string
1141 |
1142 |
1143 |
1144 |
1145 |
1146 |
1147 |
1148 |
1149 |
1150 |
1152 |
1153 |
1154 |
1155 |
1156 |
1157 |
1158 |
1159 |
1160 |
1161 |
1162 |
1163 |
1164 |
1165 |
1166 |
1167 |
1168 |
1169 |
1170 |
1171 |
1172 |
1173 |
1174 |
1175 |
1176 |
1177 |
1178 |
1179 |
1180 |
1181 |
1182 |
1183 |
1184 |
1185 |
1186 |
1187 | Source:
1188 |
1199 |
1200 |
1201 |
1202 |
1203 |
1204 |
1205 |
1206 |
1207 |
1208 |
1209 |
1210 |
1211 |
1212 |
1213 |
1214 |
1215 |
1216 |
1219 | Classes Global
1220 |
1221 |
1222 |
1225 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
1226 |
1227 |
1228 |
1229 |
1230 |
1231 |
--------------------------------------------------------------------------------
/docs/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Home
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Home
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 | Elarian
47 |
48 |
49 | A framework that helps you build scalable, personalized customer engagement applications.
50 |
51 | Install
52 | You can install the package from npm by running:
53 | $ npm install elarian@latest
54 | Usage
56 |
57 | const { initializeClient } = require('elarian');
58 |
59 |
60 | // ...
61 |
62 | const elarian = await initializeClient({
63 | token: 'YOUR_TOKEN',
64 | appId: 'YOUR_APP_ID',
65 | });
66 |
67 | elarian.on('consentDenied', (userId) => {
68 | // ...
69 | });
70 |
71 | elarian.on('consentGranted', (userId, data) => {
72 | // ...
73 | });
74 |
75 | const { state } = await elarian.fetchAppState();
76 |
77 | await elarian.updateAppState(Buffer.from('abc'));
78 |
79 | await elarian.sendMessage('Hello test');
80 |
81 | await elarian.collectPayment({ amount: 10, currency: 'UGX' });
82 |
83 | Documentation
85 | For detailed info on this SDK, see the reference .
86 | Development
87 | Run all tests:
88 | $ npm install
89 | $ npm test
90 | See SDK Spec for reference.
92 | Contributing
93 | Pull requests are welcome. For major changes, please open an issue first
94 | to discuss what you would like to change.
95 | Read the contribution guide for more information.
96 | Issues
97 | If you find a bug, please file an issue on our issue tracker on GitHub .
98 | Known Issues
99 |
100 | Missing partial state updates
101 | Missing consent event notifications
102 | Missing sendMessage() and collectPayment() implementations
103 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
114 | Classes Global
115 |
116 |
117 |
120 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
121 |
122 |
123 |
124 |
125 |
126 |
--------------------------------------------------------------------------------
/docs/index.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Source: index.js
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Source: index.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | /* eslint-disable global-require */
30 |
31 | const Elarian = require('./elarian');
32 |
33 | /**
34 | * Initialize a client
35 | * @param {ClientConfig} config
36 | * @returns {Elarian}
37 | */
38 | const initializeClient = (config) => new Promise((resolve, reject) => {
39 | try {
40 | const client = new Elarian(config);
41 | client.on('error', (err) => reject(err));
42 | client.on('connected', () => resolve(client));
43 | client.connect();
44 | } catch (error) {
45 | reject(error);
46 | }
47 | });
48 |
49 | module.exports = {
50 | Elarian,
51 | initializeClient,
52 | };
53 |
55 |
56 |
57 |
58 |
59 |
60 |
63 | Classes Global
64 |
65 |
66 |
69 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/docs/scripts/linenumber.js:
--------------------------------------------------------------------------------
1 | /*global document */
2 | (() => {
3 | const source = document.getElementsByClassName('prettyprint source linenums');
4 | let i = 0;
5 | let lineNumber = 0;
6 | let lineId;
7 | let lines;
8 | let totalLines;
9 | let anchorHash;
10 |
11 | if (source && source[0]) {
12 | anchorHash = document.location.hash.substring(1);
13 | lines = source[0].getElementsByTagName('li');
14 | totalLines = lines.length;
15 |
16 | for (; i < totalLines; i++) {
17 | lineNumber++;
18 | lineId = `line${lineNumber}`;
19 | lines[i].id = lineId;
20 | if (lineId === anchorHash) {
21 | lines[i].className += ' selected';
22 | }
23 | }
24 | }
25 | })();
26 |
--------------------------------------------------------------------------------
/docs/scripts/prettify/Apache-License-2.0.txt:
--------------------------------------------------------------------------------
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.
203 |
--------------------------------------------------------------------------------
/docs/scripts/prettify/lang-css.js:
--------------------------------------------------------------------------------
1 | PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
2 | /^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
3 |
--------------------------------------------------------------------------------
/docs/scripts/prettify/prettify.js:
--------------------------------------------------------------------------------
1 | var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
2 | (function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
3 | [],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
9 | l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
10 | q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
11 | q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
12 | "");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
13 | a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
14 | for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
18 | "catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
19 | H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
20 | J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
21 | I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
22 | ["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
23 | /^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
24 | ["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
25 | hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=
26 | !k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p th:last-child { border-right: 1px solid #ddd; }
224 |
225 | .ancestors, .attribs { color: #999; }
226 | .ancestors a, .attribs a
227 | {
228 | color: #999 !important;
229 | text-decoration: none;
230 | }
231 |
232 | .clear
233 | {
234 | clear: both;
235 | }
236 |
237 | .important
238 | {
239 | font-weight: bold;
240 | color: #950B02;
241 | }
242 |
243 | .yes-def {
244 | text-indent: -1000px;
245 | }
246 |
247 | .type-signature {
248 | color: #aaa;
249 | }
250 |
251 | .name, .signature {
252 | font-family: Consolas, Monaco, 'Andale Mono', monospace;
253 | }
254 |
255 | .details { margin-top: 14px; border-left: 2px solid #DDD; }
256 | .details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; }
257 | .details dd { margin-left: 70px; }
258 | .details ul { margin: 0; }
259 | .details ul { list-style-type: none; }
260 | .details li { margin-left: 30px; padding-top: 6px; }
261 | .details pre.prettyprint { margin: 0 }
262 | .details .object-value { padding-top: 0; }
263 |
264 | .description {
265 | margin-bottom: 1em;
266 | margin-top: 1em;
267 | }
268 |
269 | .code-caption
270 | {
271 | font-style: italic;
272 | font-size: 107%;
273 | margin: 0;
274 | }
275 |
276 | .source
277 | {
278 | border: 1px solid #ddd;
279 | width: 80%;
280 | overflow: auto;
281 | }
282 |
283 | .prettyprint.source {
284 | width: inherit;
285 | }
286 |
287 | .source code
288 | {
289 | font-size: 100%;
290 | line-height: 18px;
291 | display: block;
292 | padding: 4px 12px;
293 | margin: 0;
294 | background-color: #fff;
295 | color: #4D4E53;
296 | }
297 |
298 | .prettyprint code span.line
299 | {
300 | display: inline-block;
301 | }
302 |
303 | .prettyprint.linenums
304 | {
305 | padding-left: 70px;
306 | -webkit-user-select: none;
307 | -moz-user-select: none;
308 | -ms-user-select: none;
309 | user-select: none;
310 | }
311 |
312 | .prettyprint.linenums ol
313 | {
314 | padding-left: 0;
315 | }
316 |
317 | .prettyprint.linenums li
318 | {
319 | border-left: 3px #ddd solid;
320 | }
321 |
322 | .prettyprint.linenums li.selected,
323 | .prettyprint.linenums li.selected *
324 | {
325 | background-color: lightyellow;
326 | }
327 |
328 | .prettyprint.linenums li *
329 | {
330 | -webkit-user-select: text;
331 | -moz-user-select: text;
332 | -ms-user-select: text;
333 | user-select: text;
334 | }
335 |
336 | .params .name, .props .name, .name code {
337 | color: #4D4E53;
338 | font-family: Consolas, Monaco, 'Andale Mono', monospace;
339 | font-size: 100%;
340 | }
341 |
342 | .params td.description > p:first-child,
343 | .props td.description > p:first-child
344 | {
345 | margin-top: 0;
346 | padding-top: 0;
347 | }
348 |
349 | .params td.description > p:last-child,
350 | .props td.description > p:last-child
351 | {
352 | margin-bottom: 0;
353 | padding-bottom: 0;
354 | }
355 |
356 | .disabled {
357 | color: #454545;
358 | }
359 |
--------------------------------------------------------------------------------
/docs/styles/prettify-jsdoc.css:
--------------------------------------------------------------------------------
1 | /* JSDoc prettify.js theme */
2 |
3 | /* plain text */
4 | .pln {
5 | color: #000000;
6 | font-weight: normal;
7 | font-style: normal;
8 | }
9 |
10 | /* string content */
11 | .str {
12 | color: #006400;
13 | font-weight: normal;
14 | font-style: normal;
15 | }
16 |
17 | /* a keyword */
18 | .kwd {
19 | color: #000000;
20 | font-weight: bold;
21 | font-style: normal;
22 | }
23 |
24 | /* a comment */
25 | .com {
26 | font-weight: normal;
27 | font-style: italic;
28 | }
29 |
30 | /* a type name */
31 | .typ {
32 | color: #000000;
33 | font-weight: normal;
34 | font-style: normal;
35 | }
36 |
37 | /* a literal value */
38 | .lit {
39 | color: #006400;
40 | font-weight: normal;
41 | font-style: normal;
42 | }
43 |
44 | /* punctuation */
45 | .pun {
46 | color: #000000;
47 | font-weight: bold;
48 | font-style: normal;
49 | }
50 |
51 | /* lisp open bracket */
52 | .opn {
53 | color: #000000;
54 | font-weight: bold;
55 | font-style: normal;
56 | }
57 |
58 | /* lisp close bracket */
59 | .clo {
60 | color: #000000;
61 | font-weight: bold;
62 | font-style: normal;
63 | }
64 |
65 | /* a markup tag name */
66 | .tag {
67 | color: #006400;
68 | font-weight: normal;
69 | font-style: normal;
70 | }
71 |
72 | /* a markup attribute name */
73 | .atn {
74 | color: #006400;
75 | font-weight: normal;
76 | font-style: normal;
77 | }
78 |
79 | /* a markup attribute value */
80 | .atv {
81 | color: #006400;
82 | font-weight: normal;
83 | font-style: normal;
84 | }
85 |
86 | /* a declaration */
87 | .dec {
88 | color: #000000;
89 | font-weight: bold;
90 | font-style: normal;
91 | }
92 |
93 | /* a variable name */
94 | .var {
95 | color: #000000;
96 | font-weight: normal;
97 | font-style: normal;
98 | }
99 |
100 | /* a function name */
101 | .fun {
102 | color: #000000;
103 | font-weight: bold;
104 | font-style: normal;
105 | }
106 |
107 | /* Specify class=linenums on a pre to get line numbering */
108 | ol.linenums {
109 | margin-top: 0;
110 | margin-bottom: 0;
111 | }
112 |
--------------------------------------------------------------------------------
/docs/styles/prettify-tomorrow.css:
--------------------------------------------------------------------------------
1 | /* Tomorrow Theme */
2 | /* Original theme - https://github.com/chriskempson/tomorrow-theme */
3 | /* Pretty printing styles. Used with prettify.js. */
4 | /* SPAN elements with the classes below are added by prettyprint. */
5 | /* plain text */
6 | .pln {
7 | color: #4d4d4c; }
8 |
9 | @media screen {
10 | /* string content */
11 | .str {
12 | color: #718c00; }
13 |
14 | /* a keyword */
15 | .kwd {
16 | color: #8959a8; }
17 |
18 | /* a comment */
19 | .com {
20 | color: #8e908c; }
21 |
22 | /* a type name */
23 | .typ {
24 | color: #4271ae; }
25 |
26 | /* a literal value */
27 | .lit {
28 | color: #f5871f; }
29 |
30 | /* punctuation */
31 | .pun {
32 | color: #4d4d4c; }
33 |
34 | /* lisp open bracket */
35 | .opn {
36 | color: #4d4d4c; }
37 |
38 | /* lisp close bracket */
39 | .clo {
40 | color: #4d4d4c; }
41 |
42 | /* a markup tag name */
43 | .tag {
44 | color: #c82829; }
45 |
46 | /* a markup attribute name */
47 | .atn {
48 | color: #f5871f; }
49 |
50 | /* a markup attribute value */
51 | .atv {
52 | color: #3e999f; }
53 |
54 | /* a declaration */
55 | .dec {
56 | color: #f5871f; }
57 |
58 | /* a variable name */
59 | .var {
60 | color: #c82829; }
61 |
62 | /* a function name */
63 | .fun {
64 | color: #4271ae; } }
65 | /* Use higher contrast and text-weight for printable form. */
66 | @media print, projection {
67 | .str {
68 | color: #060; }
69 |
70 | .kwd {
71 | color: #006;
72 | font-weight: bold; }
73 |
74 | .com {
75 | color: #600;
76 | font-style: italic; }
77 |
78 | .typ {
79 | color: #404;
80 | font-weight: bold; }
81 |
82 | .lit {
83 | color: #044; }
84 |
85 | .pun, .opn, .clo {
86 | color: #440; }
87 |
88 | .tag {
89 | color: #006;
90 | font-weight: bold; }
91 |
92 | .atn {
93 | color: #404; }
94 |
95 | .atv {
96 | color: #060; } }
97 | /* Style */
98 | /*
99 | pre.prettyprint {
100 | background: white;
101 | font-family: Consolas, Monaco, 'Andale Mono', monospace;
102 | font-size: 12px;
103 | line-height: 1.5;
104 | border: 1px solid #ccc;
105 | padding: 10px; }
106 | */
107 |
108 | /* Specify class=linenums on a pre to get line numbering */
109 | ol.linenums {
110 | margin-top: 0;
111 | margin-bottom: 0; }
112 |
113 | /* IE indents via margin-left */
114 | li.L0,
115 | li.L1,
116 | li.L2,
117 | li.L3,
118 | li.L4,
119 | li.L5,
120 | li.L6,
121 | li.L7,
122 | li.L8,
123 | li.L9 {
124 | /* */ }
125 |
126 | /* Alternate shading for lines */
127 | li.L1,
128 | li.L3,
129 | li.L5,
130 | li.L7,
131 | li.L9 {
132 | /* */ }
133 |
--------------------------------------------------------------------------------
/docs/utils_types.js.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | JSDoc: Source: utils/types.js
6 |
7 |
8 |
9 |
12 |
19 |
20 |
Source: utils/types.js
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 | /* eslint-disable max-len */
30 |
31 | /**
32 | * An object representing client params
33 | * @typedef {Object} ClientConfig
34 | * @property {string} token
35 | * @property {string} appId
36 | * @property {Object} [options]
37 | */
38 |
39 | /**
40 | * An object representing app state
41 | * @typedef {Object} AppState
42 | * @property {string} appId
43 | * @property {string} token
44 | * @property {Buffer} state
45 | */
46 |
47 | /**
48 | * An object representing a response
49 | * @typedef {Object} Response
50 | * @property {boolean} success
51 | * @property {string} message
52 | */
53 |
54 | /**
55 | * An object representing cash
56 | * @typedef {Object} Cash
57 | * @property {double} value
58 | * @property {string} currency
59 | */
60 |
61 | /**
62 | * A function that reacts to events
63 | * @typedef {function} NotificationHandler
64 | * @param {Notification} notification
65 | * @param {NotificationCallback} [callback] A response to the event. Required for voice and ussd events
66 | * @returns {void}
67 | */
68 |
69 | /**
70 | * An string representing an event. Must be one of:
71 | * <ul>
72 | * <li>Connection Events:
73 | * <ul>
74 | * <li><b>error</b>: Emitted on connection error</li>
75 | * <li><b>closed</b>: Emitted on connection closed</li>
76 | * <li><b>pending</b>: Emitted when not connected</li>
77 | * <li><b>connected</b>: Emitted on connection success</li>
78 | * <li><b>connecting</b>: Emitted when connecting </li>
79 | * </ul>
80 | * </li>
81 | * <li>App Events
82 | * <ul>
83 | * <li><b>consentDenied</b>: ...</li>
84 | * <li><b>consentRevoked</b>: ...</li>
85 | * </ul>
86 | * </li>
87 | * </ul>
88 | * @typedef {string} Event
89 | */
90 |
92 |
93 |
94 |
95 |
96 |
97 |
100 | Classes Global
101 |
102 |
103 |
106 | Documentation generated by JSDoc 4.0.2 on Mon Feb 19 2024 13:25:38 GMT+0300 (East Africa Time)
107 |
108 |
109 |
110 |
111 |
112 |
113 |
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | module.exports = require('./lib/index');
2 |
--------------------------------------------------------------------------------
/lib/client.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable max-len */
2 | /* eslint-disable no-underscore-dangle */
3 | const grpc = require('@grpc/grpc-js');
4 | const validate = require('validate.js');
5 | const protoLoader = require('@grpc/proto-loader');
6 |
7 | const utils = require('./utils');
8 |
9 | const { log } = utils;
10 |
11 | /**
12 | * Instantiate an elarian client. You have to call connect() on then client to start using it
13 | * @class
14 | * @param {ClientConfig} config
15 | */
16 | function Client(config) {
17 | const conf = {
18 | ...config,
19 | };
20 | const constraints = {
21 | appId: {
22 | type: 'string',
23 | presence: true,
24 | },
25 | token: {
26 | type: 'string',
27 | presence: true,
28 | },
29 | options: {
30 | type: 'object',
31 | },
32 | };
33 |
34 | const error = validate(conf, constraints);
35 | if (error) {
36 | throw error;
37 | }
38 |
39 | this.config = {
40 | ...conf,
41 | options: conf.options || {
42 | uris: {
43 | social: 'id.elarian.com:443',
44 | state: 'api.elarian.com:443',
45 | },
46 | },
47 | };
48 | this._socialService = null;
49 | this._appStateService = null;
50 |
51 | this.eventListeners = {
52 | // Connection
53 | error: null,
54 | closed: null,
55 | pending: null,
56 | connected: null,
57 | connecting: null,
58 | };
59 |
60 | /**
61 | * Connecto to elarian servers
62 | * @returns {Elarian} this instance
63 | */
64 | this.connect = function connect() {
65 | // TODO: Connect to notification service
66 |
67 | if (this.eventListeners.connected) {
68 | this.eventListeners.connected();
69 | }
70 | return this;
71 | };
72 |
73 | /**
74 | * Check if client is connected
75 | * @returns {boolean}
76 | */
77 | this.isConnected = function isConnected() {
78 | return this._isConnected;
79 | };
80 |
81 | /**
82 | * Disconnect from the elarian server
83 | */
84 | this.disconnect = function disconnect() {
85 | // TODO: Disconnect from notification service
86 |
87 | if (this.eventListeners.closed) {
88 | this.eventListeners.closed();
89 | }
90 | };
91 |
92 | const cleanup = (code) => {
93 | log.warn(`Disconnecting from API server(${code})`);
94 | this.disconnect();
95 | process.exit(code);
96 | };
97 |
98 | process.on('SIGINT', cleanup.bind(null));
99 | process.on('SIGQUIT', cleanup.bind(null));
100 | process.on('SIGTERM', cleanup.bind(null));
101 | }
102 |
103 | // eslint-disable-next-line no-underscore-dangle
104 | Client.prototype._getAppStateService = function _getAppStateService() {
105 | if (this._appStateService) {
106 | return this._appStateService;
107 | }
108 |
109 | const { options } = this.config;
110 | const uri = options.uris.state;
111 | const def = protoLoader.loadSync(
112 | utils.SERVICE_PROTO.APP_STATE,
113 | {
114 | keepCase: true,
115 | longs: String,
116 | enums: String,
117 | defaults: true,
118 | oneofs: true,
119 | },
120 | );
121 | const pd = grpc.loadPackageDefinition(def);
122 | const credentials = options.dev ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
123 | this._appStateService = new pd.com.elarian.hera.proto.AppStateService(uri, credentials);
124 | return this._appStateService;
125 | };
126 |
127 | // eslint-disable-next-line no-underscore-dangle
128 | Client.prototype._getSocialService = function _getSocialService() {
129 | if (this._socialService) {
130 | return this._socialService;
131 | }
132 |
133 | const { options } = this.config;
134 | const uri = options.uris.social;
135 | const def = protoLoader.loadSync(
136 | utils.SERVICE_PROTO.SOCIAL,
137 | {
138 | keepCase: true,
139 | longs: String,
140 | enums: String,
141 | defaults: true,
142 | oneofs: true,
143 | },
144 | );
145 | const pd = grpc.loadPackageDefinition(def);
146 | const credentials = options.dev ? grpc.credentials.createInsecure() : grpc.credentials.createSsl();
147 | this._socialService = new pd.com.elarian.hera.proto.SocialService(uri, credentials);
148 | return this._socialService;
149 | };
150 |
151 | // eslint-disable-next-line no-underscore-dangle
152 | Client.prototype._notificationHandler = () => (payload) => {
153 | log.debug(`TODO: Handle incoming ${payload}`);
154 | };
155 |
156 | /**
157 | * Register a listener to watch out for events. Can also be called with client.on(event,listener)
158 | * @param {Event} event The event whose listener to register
159 | * @param {NotificationHandler} handler A function that reacts to events
160 | * @returns {Client} this instance
161 | */
162 | Client.prototype.registerNotificationHandler = function registerNotificationHandler(event, handler) {
163 | const events = Object.keys(this.eventListeners);
164 | if (!events.includes(event)) {
165 | throw new Error(`Unexpected event ${event}. Must be one of ${events}`);
166 | }
167 | this.eventListeners[event] = handler;
168 | return this;
169 | };
170 |
171 | /**
172 | * Register a listener to watch out for events. Can also be called with client.registerListerner(event,listener)
173 | * @param {Event} event The event whose listener to register
174 | * @param {NotificationHandler} handler A function that reacts to events
175 | * @returns {Client} this instance
176 | */
177 | Client.prototype.on = function on(event, handler) { return this.registerNotificationHandler(event, handler); };
178 |
179 | module.exports = Client;
180 |
--------------------------------------------------------------------------------
/lib/elarian.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable max-len */
2 | /* eslint-disable no-underscore-dangle */
3 | const Client = require('./client');
4 |
5 | /**
6 | * Instantiate an elarian client. You have to call connect() on the client to start using it
7 | * @class
8 | * @extends Client
9 | * @param {ClientConfig} config
10 | */
11 | function Elarian(config) {
12 | Client.call(this, config);
13 |
14 | this.eventListeners = {
15 | ...this.eventListeners,
16 |
17 | // Core
18 | consentDenied: null,
19 | consentRevoked: null,
20 | };
21 | }
22 |
23 | Elarian.prototype = Object.create(Client.prototype, { constructor: Elarian });
24 |
25 | /**
26 | * Fetch your app state
27 | * @param {String[]} appIds Other apps whose state you want to get. This trigger a consent notification to the user
28 | * @returns {AppState|AppState[]}
29 | * @memberof Elarian
30 | */
31 | Elarian.prototype.fetchAppState = function fetchAppState(appIds = []) {
32 | const { appId, token } = this.config;
33 | const service = this._getAppStateService();
34 | return new Promise((resolve, reject) => {
35 | const params = {
36 | appId,
37 | token,
38 | appIds,
39 | };
40 | service.GetAppState(params, (error, result) => {
41 | if (error) {
42 | reject(error);
43 | } else if (appIds && appIds.length) {
44 | resolve(result.states);
45 | } else {
46 | resolve(result.states[0]);
47 | }
48 | });
49 | });
50 | };
51 |
52 | /**
53 | * Update app state
54 | * @param {Buffer} data
55 | * @returns {AppState}
56 | * @memberof Elarian
57 | */
58 | Elarian.prototype.updateAppState = function updateAppState(data) {
59 | if (!data) {
60 | throw new Error('data is required');
61 | }
62 | const { appId, token } = this.config;
63 | const service = this._getAppStateService();
64 | return new Promise((resolve, reject) => {
65 | const params = {
66 | state: {
67 | appId,
68 | token,
69 | state: data,
70 | },
71 | };
72 | service.UpdateAppState(params, (error, result) => {
73 | if (error) {
74 | reject(error);
75 | } else {
76 | resolve(result);
77 | }
78 | });
79 | });
80 | };
81 |
82 | /**
83 | * Send user a message
84 | * @param {string} message
85 | * @returns {Response}
86 | * @memberof Elarian
87 | */
88 | Elarian.prototype.sendMessage = function sendMessage(message) {
89 | if (!message) {
90 | throw new Error('message is required');
91 | }
92 | const { appId, token } = this.config;
93 | const service = this._getSocialService();
94 | return new Promise((resolve, reject) => {
95 | const params = {
96 | appId,
97 | token,
98 | message,
99 | };
100 | service.SendMessage(params, (error, result) => {
101 | if (error) {
102 | reject(error);
103 | } else {
104 | resolve(result);
105 | }
106 | });
107 | });
108 | };
109 |
110 | /**
111 | * Initiale payment collection from user
112 | * @param {Cash} amount
113 | * @returns {Response}
114 | * @memberof Elarian
115 | */
116 | Elarian.prototype.collectPayment = function sendMessage(amount) {
117 | if (!amount || !amount.value || !amount.currency) {
118 | throw new Error('A valid amount is required');
119 | }
120 | const { appId, token } = this.config;
121 | const service = this._getSocialService();
122 | return new Promise((resolve, reject) => {
123 | const params = {
124 | appId,
125 | token,
126 | amount,
127 | };
128 | service.CollectPayment(params, (error, result) => {
129 | if (error) {
130 | reject(error);
131 | } else {
132 | resolve(result);
133 | }
134 | });
135 | });
136 | };
137 |
138 | module.exports = Elarian;
139 |
--------------------------------------------------------------------------------
/lib/index.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable global-require */
2 |
3 | const Elarian = require('./elarian');
4 |
5 | /**
6 | * Initialize a client
7 | * @param {ClientConfig} config
8 | * @returns {Elarian}
9 | */
10 | const initializeClient = (config) => new Promise((resolve, reject) => {
11 | try {
12 | const client = new Elarian(config);
13 | client.on('error', (err) => reject(err));
14 | client.on('connected', () => resolve(client));
15 | client.connect();
16 | } catch (error) {
17 | reject(error);
18 | }
19 | });
20 |
21 | module.exports = {
22 | Elarian,
23 | initializeClient,
24 | };
25 |
--------------------------------------------------------------------------------
/lib/utils/index.js:
--------------------------------------------------------------------------------
1 | const SERVICE_PROTO = {
2 | SOCIAL: `${__dirname}/service/SocialService.proto`,
3 | APP_STATE: `${__dirname}/service/AppStateService.proto`,
4 | };
5 |
6 | module.exports = {
7 | SERVICE_PROTO,
8 | log: console,
9 | };
10 |
--------------------------------------------------------------------------------
/lib/utils/service/AppStateService.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package com.elarian.hera.proto;
4 |
5 | message AppState {
6 | string appId = 1;
7 | string token = 2;
8 | bytes state = 3;
9 | }
10 |
11 | message GetAppStatesRequest {
12 | string appId = 1;
13 | string token = 2;
14 | repeated string appIds = 3;
15 | }
16 |
17 | message GetAppStatesReply {
18 | repeated AppState states = 1;
19 | }
20 |
21 | message UpdateAppStateRequest {
22 | AppState state = 1;
23 | }
24 |
25 | service AppStateService {
26 | rpc GetAppState (GetAppStatesRequest) returns (GetAppStatesReply);
27 | rpc UpdateAppState (UpdateAppStateRequest) returns (AppState);
28 | }
--------------------------------------------------------------------------------
/lib/utils/service/SocialService.proto:
--------------------------------------------------------------------------------
1 | syntax = "proto3";
2 |
3 | package com.elarian.hera.proto;
4 |
5 | message Reply {
6 | bool success = 1;
7 | string message = 2;
8 | }
9 |
10 | message Cash {
11 | double amount = 1;
12 | string currency = 2;
13 | }
14 |
15 | message SendMessageRequest {
16 | string appId = 1;
17 | string token = 2;
18 | string message = 3;
19 | }
20 |
21 | message CollectPaymentRequest {
22 | string appId = 1;
23 | string token = 2;
24 | Cash amount = 3;
25 | }
26 |
27 | service SocialService {
28 | rpc SendMessage (SendMessageRequest) returns (Reply);
29 | rpc CollectPayment (CollectPaymentRequest) returns (Reply);
30 | }
--------------------------------------------------------------------------------
/lib/utils/types.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable max-len */
2 |
3 | /**
4 | * An object representing client params
5 | * @typedef {Object} ClientConfig
6 | * @property {string} token
7 | * @property {string} appId
8 | * @property {Object} [options]
9 | */
10 |
11 | /**
12 | * An object representing app state
13 | * @typedef {Object} AppState
14 | * @property {string} appId
15 | * @property {string} token
16 | * @property {Buffer} state
17 | */
18 |
19 | /**
20 | * An object representing a response
21 | * @typedef {Object} Response
22 | * @property {boolean} success
23 | * @property {string} message
24 | */
25 |
26 | /**
27 | * An object representing cash
28 | * @typedef {Object} Cash
29 | * @property {double} value
30 | * @property {string} currency
31 | */
32 |
33 | /**
34 | * A function that reacts to events
35 | * @typedef {function} NotificationHandler
36 | * @param {Notification} notification
37 | * @param {NotificationCallback} [callback] A response to the event. Required for voice and ussd events
38 | * @returns {void}
39 | */
40 |
41 | /**
42 | * An string representing an event. Must be one of:
43 | *
44 | * Connection Events:
45 | *
46 | * error : Emitted on connection errorclosed : Emitted on connection closedpending : Emitted when not connectedconnected : Emitted on connection successconnecting : Emitted when connecting
52 | *
53 | * App Events
54 | *
55 | * consentDenied : ...consentRevoked : ...
58 | *
59 | *
60 | * @typedef {string} Event
61 | */
62 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "elarian",
3 | "version": "0.5.6",
4 | "description": "Elarian JavaScript SDK",
5 | "main": "index.js",
6 | "scripts": {
7 | "pretest": "npm run lint",
8 | "posttest": "npm run build",
9 | "test": "DEBUG=1 nyc mocha ./test -t 10000 --slow 500 --exit",
10 | "lint": "eslint .",
11 | "build": "rm -rf docs/ && npm run build:docs",
12 | "build:types": "jsdoc -t node_modules/tsd-jsdoc/dist -c .jsdoc -r lib/ && mv docs/types.d.ts ./ ",
13 | "build:docs": "jsdoc -c .jsdoc -R README.md -r lib/ && jsdoc2md -c .jsdoc --files lib/** > docs/README.md",
14 | "prepublish": "npm run build"
15 | },
16 | "author": "Salama Balekage",
17 | "license": "MIT",
18 | "repository": {
19 | "type": "git",
20 | "url": "git+https://github.com/ElarianLtd/javascript-sdk"
21 | },
22 | "types": "./types.d.ts",
23 | "keywords": [
24 | "elarian"
25 | ],
26 | "engines": {
27 | "node": ">=12"
28 | },
29 | "dependencies": {
30 | "@grpc/grpc-js": "^1.9.12",
31 | "@grpc/proto-loader": "^0.7.10",
32 | "google-protobuf": "^3.21.2",
33 | "validate.js": "^0.13.1"
34 | },
35 | "devDependencies": {
36 | "@alenon/grpc-mock-server": "^3.1.8",
37 | "dotenv": "^16.3.1",
38 | "eslint": "^8.55.0",
39 | "eslint-config-airbnb-base": "^15.0.0",
40 | "eslint-plugin-import": "^2.29.0",
41 | "eslint-plugin-mocha": "^10.2.0",
42 | "eslint-plugin-security": "^1.7.1",
43 | "ink-docstrap": "^1.3.2",
44 | "jsdoc": "^4.0.2",
45 | "jsdoc-to-markdown": "^8.0.0",
46 | "lodash": "^4.17.21",
47 | "mocha": "^10.2.0",
48 | "node-fetch": ">=3.3.2",
49 | "nyc": "^15.1.0",
50 | "promise-parallel-throttle": "^3.3.0",
51 | "should": "^13.2.3",
52 | "signale": "^1.4.0",
53 | "webpack": "^5.89.0",
54 | "webpack-cli": "^5.1.4"
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/test/elarian.spec.js:
--------------------------------------------------------------------------------
1 | /* eslint-disable func-names, no-new */
2 | // eslint-disable-next-line no-unused-vars
3 | const _ = require('lodash');
4 | require('should');
5 |
6 | const fixtures = require('./fixtures');
7 | const { initializeClient } = require('../index');
8 |
9 | describe('Elarian', () => {
10 | let client;
11 |
12 | before(async () => {
13 | await fixtures.startMockServices();
14 | client = await initializeClient(fixtures.clientParams);
15 | });
16 |
17 | after(async () => {
18 | await fixtures.sleep(1000);
19 | client.disconnect();
20 | await fixtures.sleep(1500);
21 | client = null;
22 | await fixtures.stopMockServices();
23 | });
24 |
25 | it('updateAppState()', async () => {
26 | const data = Buffer.from(JSON.stringify([1, 2, 3]));
27 | const resp = await client.updateAppState(data);
28 | resp.should.have.properties(['token', 'appId', 'state']);
29 | });
30 |
31 | it('fetchAppState()', async () => {
32 | const resp = await client.fetchAppState();
33 | resp.should.have.properties(['token', 'appId', 'state']);
34 | });
35 |
36 | it('fetchAppState(appIds[])', async () => {
37 | const resp = await client.fetchAppState(['app1', 'app2']);
38 | resp.should.be.an.Array();
39 | resp[0].should.have.properties(['token', 'appId', 'state']);
40 | });
41 |
42 | it('sendMessage()', async () => {
43 | const resp = await client.sendMessage('This is a test');
44 | resp.should.have.properties(['success', 'message']);
45 | });
46 |
47 | it('collectPayment()', async () => {
48 | const resp = await client.collectPayment({ value: 10, currency: 'KES' });
49 | resp.should.have.properties(['success', 'message']);
50 | });
51 | });
52 |
--------------------------------------------------------------------------------
/test/fixtures.js:
--------------------------------------------------------------------------------
1 | require('dotenv').config();
2 | const grpc = require('@grpc/grpc-js');
3 | const protoLoader = require('@grpc/proto-loader');
4 | const { GrpcMockServer } = require('@alenon/grpc-mock-server');
5 |
6 | const utils = require('../lib/utils');
7 |
8 | const clientParams = {
9 | appId: process.env.APP_ID ? process.env.APP_ID : 'test_app',
10 | token: process.env.TOKEN || 'test_token',
11 | options: {
12 | dev: true,
13 | uris: {
14 | state: '127.0.0.1:50777',
15 | social: '127.0.0.1:50777',
16 | },
17 | },
18 | };
19 |
20 | const grpcService = (() => {
21 | const pkgName = 'com.elarian.hera.proto';
22 | const appStatePKGDef = grpc.loadPackageDefinition(
23 | protoLoader.loadSync(utils.SERVICE_PROTO.APP_STATE),
24 | );
25 | const socialPKGDef = grpc.loadPackageDefinition(
26 | protoLoader.loadSync(utils.SERVICE_PROTO.SOCIAL),
27 | );
28 |
29 | const parseProto = (def, name) => {
30 | const pathArr = name.split('.');
31 | return pathArr.reduce((obj, key) => (obj && obj[key] !== 'undefined' ? obj[key] : undefined), def);
32 | };
33 |
34 | const service = new GrpcMockServer();
35 | service.addService(utils.SERVICE_PROTO.SOCIAL, pkgName, 'SocialService', {
36 | SendMessage: (call, callback) => {
37 | const { Reply } = parseProto(socialPKGDef, pkgName);
38 | const res = Reply.constructor({
39 | success: false,
40 | message: 'Not Implemented',
41 | });
42 | callback(null, res);
43 | },
44 | CollectPayment: (call, callback) => {
45 | const { Reply } = parseProto(socialPKGDef, pkgName);
46 | const res = Reply.constructor({
47 | success: false,
48 | message: 'Not Implemented',
49 | });
50 | callback(null, res);
51 | },
52 | });
53 |
54 | service.addService(utils.SERVICE_PROTO.APP_STATE, pkgName, 'AppStateService', {
55 | GetAppState: (call, callback) => {
56 | const proto = parseProto(appStatePKGDef, pkgName);
57 | const state = proto.AppState.constructor({
58 | appId: process.env.APP_ID,
59 | token: process.env.TOKEN,
60 | state: Buffer.from(JSON.stringify({ abc: 1 })),
61 | });
62 | const res = proto.GetAppStatesReply.constructor({
63 | states: [state],
64 | });
65 | callback(null, res);
66 | },
67 | UpdateAppState: (call, callback) => {
68 | const proto = parseProto(appStatePKGDef, pkgName);
69 | const res = proto.AppState.constructor({
70 | appId: process.env.APP_ID,
71 | token: process.env.TOKEN,
72 | state: Buffer.from(JSON.stringify({ abc: 1 })),
73 | });
74 | callback(null, res);
75 | },
76 | });
77 |
78 | return service;
79 | })();
80 |
81 | module.exports = {
82 | clientParams,
83 | elarianId: '3er23re23',
84 |
85 | sleep: (ms) => new Promise((resolve) => {
86 | setTimeout(resolve, ms);
87 | }),
88 |
89 | startMockServices: async () => {
90 | await grpcService.start();
91 | },
92 |
93 | stopMockServices: async () => {
94 | await grpcService.stop();
95 | },
96 | };
97 |
--------------------------------------------------------------------------------
/webpack.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 |
3 | module.exports = {
4 | mode: 'production',
5 | devtool: 'source-map',
6 | entry: './lib/index.web.js',
7 | output: {
8 | path: path.join(__dirname),
9 | filename: 'web.js',
10 | library: {
11 | type: 'umd',
12 | },
13 | },
14 | resolve: {
15 | fallback: {
16 | buffer: false,
17 | },
18 | },
19 | };
20 |
--------------------------------------------------------------------------------
