everlive-sdk
Advanced tools
The Everlive JavaScript SDK is intended to run in any Javascript environment. It is packaged with Browserify for all environments except for Node.js where the code from the src is used directly. It is distributed in the following forms:
Internally we use it in:
The docs are available here
<script src="path/to/sdk/everlive.all.js"></script>var Everlive = require('everlive-sdk');<script src="path/to/sdk/everlive.all.js"></script>var Everlive = require('everlive-sdk');import Everlive from 'everlive-sdk' Note: Use Typescript compiler version >= 2Run $ npm install in the root of the project.
The source code is available in the src folder. The entry point of the application is index.everlive.ts.
To build the source code use:
$ npm run build
To build the source code on each change:
$ npm run watch
The output is located in the root of the project - everlive.js and everlive.map.
To make a distibution build use the npm start command:
$ npm start
It outputs the following files:
|-- root
|-- dist
|-- everlive.all.js
|-- everlive.all.map
|-- everlive.all.min.js
|-- license
|-- readme
|-- declarations (contains the TS declarations)
|-- EverliveSDK.JS.zip
We have setup automated tests for each supported environment. The tests are located in the test folder.
There are mobile projects for Cordova and Nativescript located in test/mobile/Everlive(Cordova|NativeScript). Currently there are automated tests only for Android.
External files for Node.js and PhantomJs are located in test/external.
Also make sure to setup ADB on your system.
The easiest way is to open an .html file in the browser - test/suites/everlive-caching/everlive-caching.html.
To run all tests against all platforms sequentially run:
$ npm run test
Most of the times you will want to run them against specific platforms:
$ npm run test --platform desktop|nodejs|cordova|nativescript
If you want to run only a specific suite (test/suites/everlive-anything) specify the suite flag.
By convention it tries to find the suite in test/suites/(suite)/(suite).html.
$ npm run test --platform cordova --suite everlive-files
The test results are shown in the console and written as tap reports in test/testResults(platform).tap:
1..770
ok 0 Everlive data - Online EmailSubscribers Everlive data - offline control offline should throw when offline not enabled
ok 1 Everlive data - Online EmailSubscribers Everlive data - offline control isOffline should throw when offline not enabled
not ok 2 Everlive data - Online EmailSubscribers Everlive data - offline control isOnline should throw when offline not enabled - AssertionError: expected 'expected false to be truthy' to equal 'You have instantiated the SDK without support for offline storage'
Each platform's tests are ran against a different backend-services project. These settings can be changed in test/suites/externalconfig.template.js.
Write the actual tests in the test/suites/everlive-(suite) folder. Each such folder should have a everlive-(suite).html file which specifies its tests:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Everlive tests</title>
</head>
<body>
<script src="../../TestRunner.js" data-js="everlive-caching.test.js"></script>
</body>
</html>
A simple test:
describe("Test", function () {
ok(1 === 1);
}
This will load all the scripts and css needed by default (see test/TestRunner.js), create a div[id=mocha] and add the scripts specified in the data-js attribute.
The TestRunner can be accessed from window.runner.
FAQs
Backend Services SDK
We found that everlive-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.