├── docs ├── CNAME ├── scripts │ ├── linenumber.js │ └── prettify │ │ ├── lang-css.js │ │ ├── Apache-License-2.0.txt │ │ └── prettify.js ├── styles │ ├── prettify.css │ └── jsdoc.css ├── index.html ├── Node.html ├── global.html ├── Orchestration.html └── Bucket.server.html ├── index.js ├── .gitignore ├── .npmignore ├── examples ├── browser-id │ ├── index.html │ └── index.js ├── web │ ├── index.html │ └── main.js ├── embed_get_user.js ├── realtime_server.js └── standalone_get_user.js ├── constants.js ├── src ├── auth_strategies │ ├── standalone_strategy.js │ ├── strategy.js │ ├── browser_strategy.js │ └── embed_strategy.js ├── endpoint.js ├── namespace.js ├── keymetrics.js ├── utils │ ├── websocket.js │ └── validator.js └── network.js ├── test └── keymetrics.mocha.js ├── package.json ├── .drone.jsonnet ├── LICENSE └── README.md /docs/CNAME: -------------------------------------------------------------------------------- 1 | docs.api.cloud.pm2.io -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | module.exports = require('./src/keymetrics.js') 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | out 3 | package-lock.json 4 | dist 5 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | test 2 | apps 3 | doc 4 | pres 5 | examples 6 | docs 7 | /docs 8 | -------------------------------------------------------------------------------- /examples/browser-id/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /examples/web/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /examples/browser-id/index.js: -------------------------------------------------------------------------------- 1 | 2 | var client = new window.Keymetrics() 3 | 4 | client.use('browser', { 5 | client_id: '4228578805' 6 | }) 7 | 8 | client.user.retrieve() 9 | .then((response) => { 10 | console.log(response.data) 11 | }) 12 | -------------------------------------------------------------------------------- /examples/web/main.js: -------------------------------------------------------------------------------- 1 | 2 | 3 | var client = new window.Keymetrics() 4 | 5 | client.use('browser', { 6 | client_id: '4228578805' 7 | }) 8 | 9 | client.user.retrieve() 10 | .then((response) => { 11 | console.log(response.data) 12 | }) 13 | 14 | 15 | client.bucket.retrieveAll() 16 | .then((res) => { 17 | var bucket = res.data[0] 18 | 19 | client.realtime.subscribe(bucket._id).catch(console.error) 20 | 21 | client.realtime.on(`${bucket.public_id}:*:status`, (status) => { 22 | console.log(status) 23 | }) 24 | }) 25 | -------------------------------------------------------------------------------- /examples/embed_get_user.js: -------------------------------------------------------------------------------- 1 | const Keymetrics = require('../index.js') 2 | 3 | let km = new Keymetrics({ 4 | OAUTH_CLIENT_ID: '9459143721' 5 | }).use('embed') 6 | 7 | km.bucket.retrieveAll() 8 | .then((res) => { 9 | console.log(res.data.map(bucket => bucket._id)) 10 | km.bucket.retrieveUsers(res.data[1]._id) 11 | .then((res) => { 12 | console.log(res.data) 13 | }) 14 | }) 15 | .catch((err) => { 16 | delete err.response.request 17 | // console.log(err.response) 18 | console.log(err.response.data) 19 | }) 20 | -------------------------------------------------------------------------------- /constants.js: -------------------------------------------------------------------------------- 1 | 2 | const pkg = require('./package.json') 3 | 4 | const config = { 5 | headers: { 6 | 'X-JS-API-Version': pkg.version 7 | }, 8 | services: { 9 | API: 'https://api.keymetrics.io', 10 | OAUTH: 'https://id.keymetrics.io' 11 | }, 12 | OAUTH_AUTHORIZE_ENDPOINT: '/api/oauth/authorize', 13 | OAUTH_CLIENT_ID: '795984050', 14 | ENVIRONNEMENT: process && process.versions && process.versions.node ? 'node' : 'browser', 15 | VERSION: pkg.version, 16 | // put in debug when using km.io with browser OR when DEBUG=true with nodejs 17 | IS_DEBUG: (typeof window !== 'undefined' && window.location.host.match(/km.(io|local)/)) || 18 | (typeof process !== 'undefined' && (process.env.DEBUG === 'true')) 19 | } 20 | 21 | module.exports = Object.assign({}, config) 22 | -------------------------------------------------------------------------------- /examples/realtime_server.js: -------------------------------------------------------------------------------- 1 | 2 | var IO = require('..') 3 | 4 | var io = new IO().use('standalone', { 5 | refresh_token: 'refresh-token' 6 | }) 7 | 8 | io.bucket.retrieveAll() 9 | .then((res) => { 10 | var bucket = res.data[0] 11 | 12 | io.realtime.subscribe(bucket._id).catch(console.error) 13 | 14 | io.realtime.on(`${bucket.public_id}:*:status`, (status) => { 15 | console.log(status) 16 | }) 17 | 18 | io.realtime.on(`${bucket.public_id}:*:human:event`, (status) => { 19 | console.log(status) 20 | }) 21 | 22 | io.realtime.on(`${bucket.public_id}:*:process:exception`, (status) => { 23 | console.log(status) 24 | }) 25 | 26 | io.realtime.on(`${bucket.public_id}:*:process:event`, (status) => { 27 | console.log(status) 28 | }) 29 | }) 30 | -------------------------------------------------------------------------------- /docs/scripts/linenumber.js: -------------------------------------------------------------------------------- 1 | /*global document */ 2 | (function() { 3 | var source = document.getElementsByClassName('prettyprint source linenums'); 4 | var i = 0; 5 | var lineNumber = 0; 6 | var lineId; 7 | var lines; 8 | var totalLines; 9 | var 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/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 | -------------------------------------------------------------------------------- /examples/standalone_get_user.js: -------------------------------------------------------------------------------- 1 | const Keymetrics = require('../index.js') 2 | 3 | process.on('unhandledRejection', (reason, promise) => console.log(reason)); 4 | 5 | let km = new Keymetrics({ 6 | OAUTH_CLIENT_ID: '795984050', 7 | services: { 8 | API: 'http://cl1.km.io:3000', 9 | OAUTH: 'http://cl1.km.io:3100' 10 | } 11 | }).use('standalone', { 12 | refresh_token: '7ny9ay0lnaocpb07cboubev32ytm4w3tl2eteah5h0cbwizac9itndsnmtag2dnm' 13 | }) 14 | 15 | // retrieve our buckets 16 | km.bucket.retrieveAll() 17 | .then((res) => { 18 | let bucket = res.data.filter(bucket => bucket.public_id === '96a1ph8ymmrycwr')[0] 19 | 20 | // attach handler on specific namespaces 21 | km.realtime.on(`${bucket.public_id}:connected`, () => console.log('connected to realtime')) 22 | km.realtime.on(`96a1ph8ymmrycwr:mercury-76b7346a:status`, (data) => console.log(data)) 23 | 24 | // connect to realtime data of a bucket 25 | km.realtime.subscribe(bucket._id, (err) => console.log(err)) 26 | }) 27 | .catch((err) => { 28 | console.log(err) 29 | }) 30 | -------------------------------------------------------------------------------- /src/auth_strategies/standalone_strategy.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const AuthStrategy = require('./strategy') 5 | 6 | module.exports = class StandaloneFlow extends AuthStrategy { 7 | retrieveTokens (km, cb) { 8 | if (this._opts.refresh_token && this._opts.access_token) { 9 | // if both access and refresh tokens are provided, we are good 10 | return cb(null, { 11 | access_token: this._opts.access_token, 12 | refresh_token: this._opts.refresh_token 13 | }) 14 | } else if (this._opts.refresh_token && this._opts.client_id) { 15 | // we can also make a request to get an access token 16 | km.auth.retrieveToken({ 17 | client_id: this._opts.client_id, 18 | refresh_token: this._opts.refresh_token 19 | }).then((res) => { 20 | let tokens = res.data 21 | return cb(null, tokens) 22 | }).catch(cb) 23 | } else { 24 | // otherwise the flow isn't used correctly 25 | throw new Error(`If you want to use the standalone flow you need to provide either 26 | a refresh and access token OR a refresh token and a client id`) 27 | } 28 | } 29 | 30 | deleteTokens (km) { 31 | return km.auth.revoke 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/endpoint.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const RequestValidator = require('./utils/validator') 5 | const debug = require('debug')('kmjs:endpoint') 6 | 7 | module.exports = class Endpoint { 8 | constructor (opts) { 9 | Object.assign(this, opts) 10 | } 11 | 12 | build (http) { 13 | let endpoint = this 14 | return function () { 15 | let callsite = new Error().stack.split('\n')[2] 16 | if (callsite && callsite.length > 0) { 17 | debug(`Call to '${endpoint.route.name}' from ${callsite.replace(' at ', '')}`) 18 | } 19 | return new Promise((resolve, reject) => { 20 | RequestValidator.extract(endpoint, Array.prototype.slice.call(arguments)) 21 | .then((opts) => { 22 | // Different service than default, setup base url in url 23 | if (endpoint.service && endpoint.service.baseURL) { 24 | let base = endpoint.service.baseURL 25 | base = base[base.length - 1] === '/' ? base.substr(0, base.length - 1) : base 26 | opts.url = base + opts.url 27 | } 28 | http.request(opts).then(resolve, reject) 29 | }) 30 | .catch(reject) 31 | }) 32 | } 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /docs/styles/prettify.css: -------------------------------------------------------------------------------- 1 | .pln { 2 | color: #ddd; 3 | } 4 | 5 | /* string content */ 6 | .str { 7 | color: #61ce3c; 8 | } 9 | 10 | /* a keyword */ 11 | .kwd { 12 | color: #fbde2d; 13 | } 14 | 15 | /* a comment */ 16 | .com { 17 | color: #aeaeae; 18 | } 19 | 20 | /* a type name */ 21 | .typ { 22 | color: #8da6ce; 23 | } 24 | 25 | /* a literal value */ 26 | .lit { 27 | color: #fbde2d; 28 | } 29 | 30 | /* punctuation */ 31 | .pun { 32 | color: #ddd; 33 | } 34 | 35 | /* lisp open bracket */ 36 | .opn { 37 | color: #000000; 38 | } 39 | 40 | /* lisp close bracket */ 41 | .clo { 42 | color: #000000; 43 | } 44 | 45 | /* a markup tag name */ 46 | .tag { 47 | color: #8da6ce; 48 | } 49 | 50 | /* a markup attribute name */ 51 | .atn { 52 | color: #fbde2d; 53 | } 54 | 55 | /* a markup attribute value */ 56 | .atv { 57 | color: #ddd; 58 | } 59 | 60 | /* a declaration */ 61 | .dec { 62 | color: #EF5050; 63 | } 64 | 65 | /* a variable name */ 66 | .var { 67 | color: #c82829; 68 | } 69 | 70 | /* a function name */ 71 | .fun { 72 | color: #4271ae; 73 | } 74 | 75 | /* Specify class=linenums on a pre to get line numbering */ 76 | ol.linenums { 77 | margin-top: 0; 78 | margin-bottom: 0; 79 | } 80 | -------------------------------------------------------------------------------- /src/auth_strategies/strategy.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const constants = require('../../constants.js') 5 | 6 | const AuthStrategy = class AuthStrategy { 7 | constructor (opts) { 8 | this._opts = opts 9 | this.client_id = opts.client_id || opts.OAUTH_CLIENT_ID 10 | if (!this.client_id) { 11 | throw new Error('You must always provide a application id for any of the strategies') 12 | } 13 | this.scope = opts.scope || 'all' 14 | this.response_mode = opts.reponse_mode || 'query' 15 | 16 | let optsOauthEndpoint = null 17 | if (opts && opts.services) { 18 | optsOauthEndpoint = opts.services.OAUTH || opts.services.API 19 | } 20 | const oauthEndpoint = constants.services.OAUTH || constants.services.API 21 | this.oauth_endpoint = `${optsOauthEndpoint || oauthEndpoint}` 22 | if (this.oauth_endpoint[this.oauth_endpoint.length - 1] === '/' && constants.OAUTH_AUTHORIZE_ENDPOINT[0] === '/') { 23 | this.oauth_endpoint = this.oauth_endpoint.substr(0, this.oauth_endpoint.length - 1) 24 | } 25 | this.oauth_endpoint += constants.OAUTH_AUTHORIZE_ENDPOINT 26 | this.oauth_query = `?client_id=${opts.client_id}&response_mode=${this.response_mode}` + 27 | `&response_type=token&scope=${this.scope}` 28 | } 29 | 30 | retrieveTokens () { 31 | throw new Error('You need to implement a retrieveTokens function inside your strategy') 32 | } 33 | 34 | deleteTokens () { 35 | throw new Error('You need to implement a deleteTokens function inside your strategy') 36 | } 37 | 38 | static implementations (name) { 39 | const flows = { 40 | 'embed': { 41 | nodule: require('./embed_strategy'), 42 | condition: 'node' 43 | }, 44 | 'browser': { 45 | nodule: require('./browser_strategy'), 46 | condition: 'browser' 47 | }, 48 | 'standalone': { 49 | nodule: require('./standalone_strategy'), 50 | condition: null 51 | } 52 | } 53 | return name ? flows[name] : null 54 | } 55 | } 56 | 57 | module.exports = AuthStrategy 58 | -------------------------------------------------------------------------------- /test/keymetrics.mocha.js: -------------------------------------------------------------------------------- 1 | /* eslint-env mocha */ 2 | 3 | 'use strict' 4 | 5 | const Keymetrics = require('..') 6 | const assert = require('assert') 7 | const async = require('async') 8 | 9 | describe('Keymetrics Integration', function () { 10 | this.timeout(5000) 11 | let km = null 12 | it('should instanciate keymetrics', () => { 13 | km = new Keymetrics().use('standalone', { 14 | refresh_token: process.env.KEYMETRICS_TOKEN 15 | }) 16 | 17 | assert(km.user !== null) 18 | assert(km.bucket !== null) 19 | assert(km.data !== null) 20 | }) 21 | 22 | it('should succesfully retrieve user data', (done) => { 23 | km.user.retrieve().then((res) => { 24 | assert(res.status === 200) 25 | assert(typeof res.data.username === 'string') 26 | assert(typeof res.data._id === 'string') 27 | assert(res.data.authorized_bucket instanceof Array) 28 | return done() 29 | }).catch(done) 30 | }) 31 | 32 | it('should succesfully retrieve user buckets', (done) => { 33 | km.bucket.retrieveAll().then((res) => { 34 | assert(res.status === 200) 35 | assert(res.data instanceof Array) 36 | let bucket = res.data[0] 37 | assert(res.data.length > 0) 38 | assert(typeof bucket._id === 'string') 39 | assert(typeof bucket.name === 'string') 40 | assert(typeof bucket.public_id === 'string') 41 | assert(typeof bucket.secret_id === 'string') 42 | return done() 43 | }).catch(done) 44 | }) 45 | 46 | it('should retrieve some data from bucket', (done) => { 47 | let bucket 48 | async.series([ 49 | next => { 50 | km.bucket.retrieveAll().then(res => { 51 | bucket = res.data[0] 52 | return next() 53 | }).catch(next) 54 | }, 55 | next => { 56 | km.data.status.retrieve(bucket._id).then(res => { 57 | let status = res.data 58 | assert(res.status === 200) 59 | assert(status instanceof Array) 60 | return next() 61 | }).catch(next) 62 | } 63 | ], done) 64 | }) 65 | }) 66 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@pm2/js-api", 3 | "version": "0.8.0", 4 | "description": "PM2.io API Client for Javascript", 5 | "main": "index.js", 6 | "unpkg": "dist/keymetrics.es5.min.js", 7 | "engines": { 8 | "node": ">=4.0" 9 | }, 10 | "scripts": { 11 | "test": "mocha test/*", 12 | "build": "mkdir -p dist; browserify -s Keymetrics -r ./ > ./dist/keymetrics.es5.js", 13 | "dist": "mkdir -p dist; browserify -s Keymetrics -r ./ | uglifyjs -c warnings=false -m > ./dist/keymetrics.es5.min.js", 14 | "doc": "jsdoc -r ./src --readme ./README.md -d doc -t ./node_modules/minami", 15 | "clean": "rm dist/*", 16 | "prepare": "npm run build && npm run dist" 17 | }, 18 | "repository": { 19 | "type": "git", 20 | "url": "git+https://github.com/keymetrics/km.js.git" 21 | }, 22 | "keywords": [ 23 | "keymetrics", 24 | "api", 25 | "dashboard", 26 | "monitoring", 27 | "wrapper" 28 | ], 29 | "author": "Keymetrics Team", 30 | "license": "Apache-2", 31 | "bugs": { 32 | "url": "https://github.com/keymetrics/km.js/issues" 33 | }, 34 | "homepage": "https://github.com/keymetrics/km.js#readme", 35 | "dependencies": { 36 | "async": "^2.6.3", 37 | "extrareqp2": "^1.0.0", 38 | "debug": "~4.3.1", 39 | "eventemitter2": "^6.3.1", 40 | "ws": "^7.0.0" 41 | }, 42 | "devDependencies": { 43 | "@babel/core": "^7.0.0", 44 | "@babel/preset-env": "^7.0.0", 45 | "babelify": "10.0.0", 46 | "browserify": "^17.0.0", 47 | "jsdoc": "^3.4.2", 48 | "minami": "^1.1.1", 49 | "mocha": "^7.0.0", 50 | "should": "*", 51 | "uglify-es": "~3.3.9" 52 | }, 53 | "browserify": { 54 | "debug": true, 55 | "transform": [ 56 | [ 57 | "babelify", 58 | { 59 | "presets": [ 60 | [ 61 | "@babel/preset-env", 62 | { 63 | "debug": false, 64 | "forceAllTransforms": true 65 | } 66 | ] 67 | ], 68 | "sourceMaps": true 69 | } 70 | ] 71 | ] 72 | }, 73 | "browser": { 74 | "./src/auth_strategies/embed_strategy.js": false, 75 | "ws": false 76 | } 77 | } 78 | -------------------------------------------------------------------------------- /.drone.jsonnet: -------------------------------------------------------------------------------- 1 | local pipeline(version) = { 2 | kind: "pipeline", 3 | name: "node-v" + version, 4 | steps: [ 5 | { 6 | name: "tests", 7 | image: "node:" + version, 8 | commands: [ 9 | "npm install", 10 | "npm run test", 11 | ], 12 | environment: { 13 | NODE_ENV: "test", 14 | KEYMETRICS_TOKEN: { 15 | from_secret: "keymetrics_token", 16 | }, 17 | }, 18 | }, 19 | ], 20 | trigger: { 21 | event: ["push", "tag"] 22 | }, 23 | }; 24 | 25 | [ 26 | pipeline("10"), 27 | pipeline("12"), 28 | pipeline("14"), 29 | { 30 | kind: "pipeline", 31 | name: "build & publish", 32 | trigger: { 33 | event: "tag" 34 | }, 35 | depends_on: [ 36 | "node-v10", 37 | "node-v12", 38 | "node-v14" 39 | ], 40 | steps: [ 41 | { 42 | name: "build", 43 | image: "node:12", 44 | commands: [ 45 | "npm install 2> /dev/null", 46 | "mkdir -p dist", 47 | "npm run build", 48 | "npm run dist", 49 | ], 50 | }, 51 | { 52 | name: "publish", 53 | image: "plugins/npm", 54 | settings: { 55 | username: { 56 | from_secret: "npm_username" 57 | }, 58 | password: { 59 | from_secret: "npm_password" 60 | }, 61 | email: { 62 | from_secret: "npm_email" 63 | }, 64 | }, 65 | }, 66 | ], 67 | }, 68 | { 69 | kind: "secret", 70 | name: "npm_username", 71 | get: { 72 | path: "secret/drone/npm", 73 | name: "username", 74 | }, 75 | }, 76 | { 77 | kind: "secret", 78 | name: "npm_email", 79 | get: { 80 | path: "secret/drone/npm", 81 | name: "email", 82 | }, 83 | }, 84 | { 85 | kind: "secret", 86 | name: "npm_password", 87 | get: { 88 | path: "secret/drone/npm", 89 | name: "password", 90 | }, 91 | }, 92 | { 93 | kind: "secret", 94 | name: "keymetrics_token", 95 | get: { 96 | path: "secret/drone/keymetrics", 97 | name: "token", 98 | }, 99 | }, 100 | ] 101 | -------------------------------------------------------------------------------- /src/auth_strategies/browser_strategy.js: -------------------------------------------------------------------------------- 1 | /* global URLSearchParams, URL, localStorage */ 2 | 'use strict' 3 | 4 | const AuthStrategy = require('./strategy') 5 | 6 | module.exports = class BrowserFlow extends AuthStrategy { 7 | removeUrlToken (refreshToken) { 8 | let url = window.location.href 9 | let params = `?access_token=${refreshToken}&token_type=refresh_token` 10 | let newUrl = url.replace(params, '') 11 | window.history.pushState('', '', newUrl) 12 | } 13 | 14 | retrieveTokens (km, cb) { 15 | let verifyToken = (refresh) => { 16 | return km.auth.retrieveToken({ 17 | client_id: this.client_id, 18 | refresh_token: refresh 19 | }) 20 | } 21 | 22 | // parse the url since it can contain tokens 23 | let url = new URL(window.location) 24 | this.response_mode = this.response_mode === 'query' ? 'search' : this.response_mode 25 | let params = new URLSearchParams(url[this.response_mode]) 26 | 27 | if (params.get('access_token') !== null) { 28 | // verify that the access_token in parameters is valid 29 | verifyToken(params.get('access_token')) 30 | .then((res) => { 31 | this.removeUrlToken(res.data.refresh_token) 32 | // Save refreshToken in localstorage 33 | localStorage.setItem('km_refresh_token', params.get('access_token')) 34 | let tokens = res.data 35 | return cb(null, tokens) 36 | }).catch(cb) 37 | } else if (typeof localStorage !== 'undefined' && localStorage.getItem('km_refresh_token') !== null) { 38 | // maybe in the local storage ? 39 | verifyToken(localStorage.getItem('km_refresh_token')) 40 | .then((res) => { 41 | this.removeUrlToken(res.data.refresh_token) 42 | let tokens = res.data 43 | return cb(null, tokens) 44 | }).catch(cb) 45 | } else { 46 | // otherwise we need to get a refresh token 47 | window.location = `${this.oauth_endpoint}${this.oauth_query}&redirect_uri=${window.location}` 48 | } 49 | } 50 | 51 | deleteTokens (km) { 52 | return new Promise((resolve, reject) => { 53 | // revoke the refreshToken 54 | km.auth.revoke() 55 | .then(res => console.log('Token successfuly revoked!')) 56 | .catch(err => console.error(`Error when trying to revoke token: ${err.message}`)) 57 | // We need to remove from storage and redirect user in every case (cf. https://github.com/keymetrics/pm2-io-js-api/issues/49) 58 | // remove the token from the localStorage 59 | localStorage.removeItem('km_refresh_token') 60 | setTimeout(_ => { 61 | // redirect after few miliseconds so any user code will run 62 | window.location = `${this.oauth_endpoint}${this.oauth_query}` 63 | }, 500) 64 | return resolve() 65 | }) 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /src/namespace.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const Endpoint = require('./endpoint') 5 | const logger = require('debug')('kmjs:namespace') 6 | 7 | module.exports = class Namespace { 8 | constructor (mapping, opts) { 9 | logger(`initialization namespace ${opts.name}`) 10 | this.name = opts.name 11 | this.http = opts.http 12 | this.endpoints = [] 13 | this.namespaces = [] 14 | 15 | logger(`building namespace ${opts.name}`) 16 | for (let name in mapping) { 17 | let child = mapping[name] 18 | if (typeof mapping === 'object' && !child.route) { 19 | // ignore the 'default' namespace that should bind to the parent namespace 20 | if (name === 'default') { 21 | // create the namespace 22 | const defaultNamespace = new Namespace(child, { name, http: this.http, services: opts.services }) 23 | this.namespaces.push(defaultNamespace) 24 | // bind property of the default namespace to this namespace 25 | for (let key in defaultNamespace) { 26 | if (key === 'name' || key === 'opts') continue 27 | this[key] = defaultNamespace[key] 28 | } 29 | continue 30 | } 31 | // if the parent namespace is a object, the child are namespace too 32 | this.addNamespace(new Namespace(child, { name, http: this.http, services: opts.services })) 33 | } else { 34 | // otherwise its an endpoint 35 | if (child.service && opts.services && opts.services[child.service.name]) { 36 | child.service.baseURL = opts.services[child.service.name] 37 | } 38 | this.addEndpoint(new Endpoint(child)) 39 | } 40 | } 41 | 42 | // logging namespaces 43 | if (this.namespaces.length > 0) { 44 | logger(`namespace ${this.name} contains namespaces : \n${this.namespaces.map(namespace => namespace.name).join('\n')}\n`) 45 | } 46 | 47 | // logging endpoints 48 | if (this.endpoints.length > 0) { 49 | logger(`Namespace ${this.name} contains endpoints : \n${this.endpoints.map(endpoint => endpoint.route.name).join('\n')}\n`) 50 | } 51 | } 52 | 53 | addNamespace (namespace) { 54 | if (!namespace || namespace.name === this.name) { 55 | throw new Error(`A namespace must not have the same name as the parent namespace`) 56 | } 57 | if (!(namespace instanceof Namespace)) { 58 | throw new Error(`addNamespace only accept Namespace instance`) 59 | } 60 | 61 | this.namespaces.push(namespace) 62 | this[namespace.name] = namespace 63 | } 64 | 65 | addEndpoint (endpoint) { 66 | if (!endpoint || endpoint.name === this.name) { 67 | throw new Error(`A endpoint must not have the same name as a namespace`) 68 | } 69 | if (!(endpoint instanceof Endpoint)) { 70 | throw new Error(`addNamespace only accept Namespace instance`) 71 | } 72 | 73 | this.endpoints.push(endpoint) 74 | this[endpoint.name] = endpoint.build(this.http) 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /src/keymetrics.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const Namespace = require('./namespace') 5 | const constants = require('../constants') 6 | const NetworkWrapper = require('./network') 7 | const logger = require('debug')('kmjs') 8 | 9 | const Keymetrics = class Keymetrics { 10 | /** 11 | * @constructor 12 | * Keymetrics 13 | * 14 | * @param {Object} [opts] 15 | * @param {String} [opts.OAUTH_CLIENT_ID] the oauth client ID used to authenticate to KM 16 | * @param {Object} [opts.services] base url for differents services 17 | * @param {String} [opts.mappings] api mappings 18 | */ 19 | constructor (opts) { 20 | logger('init keymetrics instance') 21 | this.opts = Object.assign(constants, opts) 22 | 23 | logger('init network client (http/ws)') 24 | this._network = new NetworkWrapper(this, this.opts) 25 | 26 | const mapping = opts && opts.mappings ? opts.mappings : require('./api_mappings.json') 27 | logger(`Using mappings provided in ${opts && opts.mappings ? 'options' : 'package'}`) 28 | 29 | // build namespaces at startup 30 | logger('building namespaces') 31 | let root = new Namespace(mapping, { 32 | name: 'root', 33 | http: this._network, 34 | services: this.opts.services 35 | }) 36 | logger('exposing namespaces') 37 | for (let key in root) { 38 | if (key === 'name' || key === 'opts') continue 39 | this[key] = root[key] 40 | } 41 | logger(`attached namespaces : ${Object.keys(this)}`) 42 | 43 | this.realtime = this._network.realtime 44 | } 45 | 46 | /** 47 | * Use a specific flow to retrieve an access token on behalf the user 48 | * @param {String|Function} flow either a flow name or a custom implementation 49 | * @param {Object} [opts] 50 | * @param {String} [opts.client_id] the OAuth client ID to use to identify the application 51 | * default to the one defined when instancing Keymetrics and fallback to 795984050 (custom tokens) 52 | * @throws invalid use of this function, either the flow don't exist or isn't correctly implemented 53 | */ 54 | use (flow, opts) { 55 | logger(`using ${flow} authentication strategy`) 56 | this._network.useStrategy(flow, opts) 57 | // the logout is dependent of the auth flow so we need it to be initialize 58 | // but also we need to give the access of the instance, so we inject it here 59 | this.auth.logout = () => { 60 | return this._network.oauth_flow.deleteTokens(this) 61 | } 62 | return this 63 | } 64 | 65 | /** 66 | * API date lag, in millisecond. This is the difference between the current browser date and the 67 | * approximated API date. This is useful to compute duration between dates returned by the API 68 | * and "now". 69 | * @example 70 | * const apiDate = moment().add(km.apiDateLag) 71 | * const timeSinceLastUpdate = apiDate.diff(server.updated_at) 72 | */ 73 | get apiDateLag () { 74 | return this._network.apiDateLag 75 | } 76 | } 77 | 78 | module.exports = Keymetrics 79 | -------------------------------------------------------------------------------- /src/auth_strategies/embed_strategy.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const AuthStrategy = require('./strategy.js') 5 | const http = require('http') 6 | const fs = require('fs') 7 | const url = require('url') 8 | const exec = require('child_process').exec 9 | const async = require('async') 10 | const path = require('path') 11 | const os = require('os') 12 | 13 | module.exports = class EmbedStrategy extends AuthStrategy { 14 | // try to find a token 15 | retrieveTokens (km, cb) { 16 | let verifyToken = (refresh) => { 17 | return km.auth.retrieveToken({ 18 | client_id: this.client_id, 19 | refresh_token: refresh 20 | }) 21 | } 22 | async.tryEach([ 23 | // try to find the token via the environement 24 | (next) => { 25 | if (!process.env.KM_TOKEN) { 26 | return next(new Error('No token in env')) 27 | } 28 | verifyToken(process.env.KM_TOKEN) 29 | .then((res) => { 30 | return next(null, res.data) 31 | }) 32 | .catch(next) 33 | }, 34 | // try to find it in the file system 35 | (next) => { 36 | fs.readFile(path.resolve(os.homedir(), '.keymetrics-tokens'), (err, tokens) => { 37 | if (err) return next(err) 38 | 39 | // verify that the token is valid 40 | tokens = JSON.parse(tokens || '{}') 41 | if (new Date(tokens.expire_at) > new Date(new Date().toISOString())) { 42 | return next(null, tokens) 43 | } 44 | 45 | verifyToken(tokens.refresh_token) 46 | .then((res) => { 47 | return next(null, res.data) 48 | }) 49 | .catch(next) 50 | }) 51 | }, 52 | // otherwise make the whole flow 53 | (next) => { 54 | return this.launch((data) => { 55 | // verify that the token is valid 56 | verifyToken(data.access_token) 57 | .then((res) => { 58 | return next(null, res.data) 59 | }) 60 | .catch(next) 61 | }) 62 | } 63 | ], (err, result) => { 64 | if (result.refresh_token) { 65 | let file = path.resolve(os.homedir(), '.keymetrics-tokens') 66 | fs.writeFile(file, JSON.stringify(result), () => { 67 | return cb(err, result) 68 | }) 69 | } else { 70 | return cb(err, result) 71 | } 72 | }) 73 | } 74 | 75 | launch (cb) { 76 | let shutdown = false 77 | let server = http.createServer((req, res) => { 78 | // only handle one request 79 | if (shutdown === true) return res.end() 80 | shutdown = true 81 | 82 | let query = url.parse(req.url, true).query 83 | 84 | res.write(` You can go back to your terminal now :) `) 85 | res.end() 86 | server.close() 87 | return cb(query) 88 | }) 89 | server.listen(43532, () => { 90 | this.open(`${this.oauth_endpoint}${this.oauth_query}`) 91 | }) 92 | } 93 | 94 | open (target, appName, callback) { 95 | let opener 96 | const escape = function (s) { 97 | return s.replace(/"/g, '\\"') 98 | } 99 | 100 | if (typeof (appName) === 'function') { 101 | callback = appName 102 | appName = null 103 | } 104 | 105 | switch (process.platform) { 106 | case 'darwin': { 107 | opener = appName ? `open -a "${escape(appName)}"` : `open` 108 | break 109 | } 110 | case 'win32': { 111 | opener = appName ? `start "" ${escape(appName)}"` : `start ""` 112 | break 113 | } 114 | default: { 115 | opener = appName ? escape(appName) : `xdg-open` 116 | break 117 | } 118 | } 119 | 120 | if (process.env.SUDO_USER) { 121 | opener = 'sudo -u ' + process.env.SUDO_USER + ' ' + opener 122 | } 123 | return exec(`${opener} "${escape(target)}"`, callback) 124 | } 125 | 126 | deleteTokens (km) { 127 | return new Promise((resolve, reject) => { 128 | // revoke the refreshToken 129 | km.auth.revoke() 130 | .then(res => { 131 | // remove the token from the filesystem 132 | let file = path.resolve(os.homedir(), '.keymetrics-tokens') 133 | fs.unlinkSync(file) 134 | return resolve(res) 135 | }).catch(reject) 136 | }) 137 | } 138 | } 139 | -------------------------------------------------------------------------------- /src/utils/websocket.js: -------------------------------------------------------------------------------- 1 | /* global WebSocket */ 2 | 3 | 'use strict' 4 | 5 | const ws = require('ws') 6 | const debug = require('debug')('kmjs:network:_ws') 7 | 8 | const _WebSocket = typeof ws !== 'function' ? WebSocket : ws 9 | 10 | const defaultOptions = { 11 | debug: false, 12 | automaticOpen: true, 13 | reconnectOnError: true, 14 | reconnectInterval: 1000, 15 | maxReconnectInterval: 10000, 16 | reconnectDecay: 1, 17 | timeoutInterval: 2000, 18 | maxReconnectAttempts: Infinity, 19 | randomRatio: 3, 20 | reconnectOnCleanClose: false 21 | } 22 | 23 | const ReconnectableWebSocket = function (url, token, protocols, options) { 24 | if (!protocols) protocols = [] 25 | if (!options) options = [] 26 | 27 | this.CONNECTING = 0 28 | this.OPEN = 1 29 | this.CLOSING = 2 30 | this.CLOSED = 3 31 | 32 | this._url = url 33 | this._token = token 34 | this._protocols = protocols 35 | this._options = Object.assign({}, defaultOptions, options) 36 | this._messageQueue = [] 37 | this._reconnectAttempts = 0 38 | this.readyState = this.CONNECTING 39 | 40 | if (typeof this._options.debug === 'function') { 41 | this._debug = this._options.debug 42 | } else if (this._options.debug) { 43 | this._debug = console.log.bind(console) 44 | } else { 45 | this._debug = function () {} 46 | } 47 | 48 | if (this._options.automaticOpen) this.open() 49 | } 50 | 51 | ReconnectableWebSocket.prototype.updateAuthorization = function (authorization) { 52 | this._token = authorization 53 | } 54 | 55 | ReconnectableWebSocket.prototype.open = function () { 56 | debug('open') 57 | var socket = this._socket = new _WebSocket(`${this._url}?token=${this._token}`, this._protocols) 58 | 59 | if (this._options.binaryType) { 60 | socket.binaryType = this._options.binaryType 61 | } 62 | 63 | if (this._options.maxReconnectAttempts && this._options.maxReconnectAttempts < this._reconnectAttempts) { 64 | return this.onmaxreconnect() 65 | } 66 | 67 | this._syncState() 68 | 69 | if (socket.on) { 70 | socket.on('unexpected-response', this._onunexpectedresponse) 71 | } 72 | socket.onmessage = this._onmessage.bind(this) 73 | socket.onopen = this._onopen.bind(this) 74 | socket.onclose = this._onclose.bind(this) 75 | socket.onerror = this._onerror.bind(this) 76 | } 77 | 78 | ReconnectableWebSocket.prototype.send = function (data) { 79 | debug('send') 80 | if (this._socket && this._socket.readyState === _WebSocket.OPEN && this._messageQueue.length === 0) { 81 | this._socket.send(data) 82 | } else { 83 | this._messageQueue.push(data) 84 | } 85 | } 86 | 87 | ReconnectableWebSocket.prototype.ping = function () { 88 | debug('ping') 89 | if (this._socket.ping && this._socket && this._socket.readyState === _WebSocket.OPEN && this._messageQueue.length === 0) { 90 | this._socket.ping() 91 | } 92 | } 93 | 94 | ReconnectableWebSocket.prototype.close = function (code, reason) { 95 | debug('close') 96 | if (typeof code === 'undefined') code = 1000 97 | 98 | if (this._socket) this._socket.close(code, reason) 99 | } 100 | 101 | ReconnectableWebSocket.prototype._onunexpectedresponse = function (req, res) { 102 | debug('unexpected-response') 103 | this.onunexpectedresponse && this.onunexpectedresponse(req, res) 104 | } 105 | 106 | ReconnectableWebSocket.prototype._onmessage = function (message) { 107 | debug('onmessage') 108 | this.onmessage && this.onmessage(message) 109 | } 110 | 111 | ReconnectableWebSocket.prototype._onopen = function (event) { 112 | debug('onopen') 113 | this._syncState() 114 | this._flushQueue() 115 | if (this._reconnectAttempts !== 0) { 116 | this.onreconnect && this.onreconnect() 117 | } 118 | this._reconnectAttempts = 0 119 | 120 | this.onopen && this.onopen(event) 121 | } 122 | 123 | ReconnectableWebSocket.prototype._onclose = function (event) { 124 | debug('onclose', event) 125 | this._syncState() 126 | this._debug('WebSocket: connection is broken', event) 127 | 128 | this.onclose && this.onclose(event) 129 | 130 | this._tryReconnect(event) 131 | } 132 | 133 | ReconnectableWebSocket.prototype._onerror = function (event) { 134 | debug('onerror', event) 135 | // To avoid undetermined state, we close socket on error 136 | this._socket.close() 137 | this._syncState() 138 | 139 | this._debug('WebSocket: error', event) 140 | 141 | this.onerror && this.onerror(event) 142 | 143 | if (this._options.reconnectOnError) this._tryReconnect(event) 144 | } 145 | 146 | ReconnectableWebSocket.prototype._tryReconnect = function (event) { 147 | var self = this 148 | debug('Trying to reconnect') 149 | if (event.wasClean && !this._options.reconnectOnCleanClose) { 150 | return 151 | } 152 | setTimeout(function () { 153 | if (self.readyState === self.CLOSING || self.readyState === self.CLOSED) { 154 | self._reconnectAttempts++ 155 | self.open() 156 | } 157 | }, this._getTimeout()) 158 | } 159 | 160 | ReconnectableWebSocket.prototype._flushQueue = function () { 161 | while (this._messageQueue.length !== 0) { 162 | var data = this._messageQueue.shift() 163 | this._socket.send(data) 164 | } 165 | } 166 | 167 | ReconnectableWebSocket.prototype._getTimeout = function () { 168 | var timeout = this._options.reconnectInterval * Math.pow(this._options.reconnectDecay, this._reconnectAttempts) 169 | timeout = timeout > this._options.maxReconnectInterval ? this._options.maxReconnectInterval : timeout 170 | return this._options.randomRatio ? getRandom(timeout / this._options.randomRatio, timeout) : timeout 171 | } 172 | 173 | ReconnectableWebSocket.prototype._syncState = function () { 174 | this.readyState = this._socket.readyState 175 | } 176 | 177 | function getRandom (min, max) { 178 | return Math.random() * (max - min) + min 179 | } 180 | 181 | module.exports = ReconnectableWebSocket 182 | -------------------------------------------------------------------------------- /src/utils/validator.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | module.exports = class RequestValidator { 5 | /** 6 | * Extract httpOptions from the endpoint definition 7 | * and the data given by the user 8 | * 9 | * @param {Object} endpoint endpoint definition 10 | * @param {Array} args arguments given by the user 11 | * @return {Promise} resolve to the http options need to make the request 12 | */ 13 | static extract (endpoint, args) { 14 | let isDefined = val => val !== null && typeof val !== 'undefined' 15 | 16 | return new Promise((resolve, reject) => { 17 | let httpOpts = { 18 | params: {}, 19 | data: {}, 20 | url: endpoint.route.name + '', 21 | method: endpoint.route.type, 22 | authentication: endpoint.authentication || false 23 | } 24 | 25 | switch (endpoint.route.type) { 26 | // GET request, we assume data will only be in the query or url params 27 | case 'GET': { 28 | for (let param of (endpoint.params || [])) { 29 | let value = args.shift() 30 | // params should always be a string since they will be replaced in the url 31 | if (typeof value !== 'string' && param.optional === false) { 32 | return reject(new Error(`Expected to receive string argument for ${param.name} to match but got ${value}`)) 33 | } 34 | if (value) { 35 | // if value is given, use it 36 | httpOpts.url = httpOpts.url.replace(param.name, value) 37 | } else if (param.optional === false && param.defaultvalue !== null) { 38 | // use default value if available 39 | httpOpts.url = httpOpts.url.replace(param.name, param.defaultvalue) 40 | } 41 | } 42 | for (let param of (endpoint.query || [])) { 43 | let value = args.shift() 44 | // query should always be a string since they will be replaced in the url 45 | if (typeof value !== 'string' && param.optional === false) { 46 | return reject(new Error(`Expected to receive string argument for ${param.name} query but got ${value}`)) 47 | } 48 | // set query value 49 | if (value) { 50 | // if value is given, use it 51 | httpOpts.params[param.name] = value 52 | } else if (param.optional === false && param.defaultvalue !== null) { 53 | // use default value if available 54 | httpOpts.params[param.name] = param.defaultvalue 55 | } 56 | } 57 | break 58 | } 59 | // for PUT, POST and PATCH request, only params and body are authorized 60 | case 'PUT': 61 | case 'POST': 62 | case 'PATCH': { 63 | for (let param of (endpoint.params || [])) { 64 | let value = args.shift() 65 | // params should always be a string since they will be replaced in the url 66 | if (typeof value !== 'string' && param.optional === false) { 67 | return reject(new Error(`Expected to receive string argument for ${param.name} to match but got ${value}`)) 68 | } 69 | // replace param in url 70 | if (value) { 71 | // if value is given, use it 72 | httpOpts.url = httpOpts.url.replace(param.name, value) 73 | } else if (param.optional === false && param.defaultvalue !== null) { 74 | // use default value if available 75 | httpOpts.url = httpOpts.url.replace(param.name, param.defaultvalue) 76 | } 77 | } 78 | for (let param of (endpoint.query || [])) { 79 | let value = args.shift() 80 | // query should always be a string since they will be replaced in the url 81 | if (typeof value !== 'string' && param.optional === false) { 82 | return reject(new Error(`Expected to receive string argument for ${param.name} query but got ${value}`)) 83 | } 84 | // set query value 85 | if (value) { 86 | // if value is given, use it 87 | httpOpts.params[param.name] = value 88 | } else if (param.optional === false && param.defaultvalue !== null) { 89 | // use default value if available 90 | httpOpts.params[param.name] = param.defaultvalue 91 | } 92 | } 93 | // if we don't have any arguments, break 94 | if (args.length === 0) break 95 | let data = args[0] 96 | if (typeof data !== 'object' && endpoint.body.length > 0) { 97 | return reject(new Error(`Expected to receive an object for post data but received ${typeof data}`)) 98 | } 99 | for (let field of (endpoint.body || [])) { 100 | let isSubfield = field.name.includes('[]') === true 101 | 102 | // verify that the mandatory field are here 103 | if (!isDefined(data[field.name]) && isSubfield === false && field.optional === false && field.defaultvalue === null) { 104 | return reject(new Error(`Missing mandatory field ${field.name} to make a POST request on ${endpoint.route.name}`)) 105 | } 106 | // verify that the mandatory field are the good type 107 | if (typeof data[field.name] !== field.type && isSubfield === false && field.optional === false && field.defaultvalue === null) { // eslint-disable-line 108 | return reject(new Error(`Invalid type for field ${field.name}, expected ${field.type} but got ${typeof data[field.name]}`)) 109 | } 110 | 111 | // add it to the request only when its present 112 | if (isDefined(data[field.name])) { 113 | httpOpts.data[field.name] = data[field.name] 114 | } 115 | 116 | // or else its not optional and has a default value 117 | if (field.optional === false && field.defaultvalue !== null) { 118 | httpOpts.data[field.name] = field.defaultvalue 119 | } 120 | } 121 | break 122 | } 123 | // DELETE can have params or query parameters 124 | case 'DELETE': { 125 | for (let param of (endpoint.params || [])) { 126 | let value = args.shift() 127 | // params should always be a string since they will be replaced in the url 128 | if (typeof value !== 'string' && param.optional === false) { 129 | return reject(new Error(`Expected to receive string argument for ${param.name} to match but got ${value}`)) 130 | } 131 | // replace param in url 132 | if (value) { 133 | // if value is given, use it 134 | httpOpts.url = httpOpts.url.replace(param.name, value) 135 | } else if (param.optional === false && param.defaultvalue !== null) { 136 | // use default value if available 137 | httpOpts.url = httpOpts.url.replace(param.name, param.defaultvalue) 138 | } 139 | } 140 | for (let param of (endpoint.query || [])) { 141 | let value = args.shift() 142 | // query should always be a string 143 | if (typeof value !== 'string' && param.optional === false) { 144 | return reject(new Error(`Expected to receive string argument for ${param.name} query but got ${value}`)) 145 | } 146 | // replace param in url 147 | if (value) { 148 | // if value is given, use it 149 | httpOpts.params[param.name] = value 150 | } else if (param.optional === false && param.defaultvalue !== null) { 151 | // use default value if available 152 | httpOpts.params[param.name] = param.defaultvalue 153 | } 154 | } 155 | break 156 | } 157 | default: { 158 | return reject(new Error(`Invalid endpoint declaration, invalid method ${endpoint.route.type} found`)) 159 | } 160 | } 161 | return resolve(httpOpts) 162 | }) 163 | } 164 | } 165 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /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/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 ul { 202 | padding: 0 10px; 203 | } 204 | 205 | nav > ul > li > a { 206 | color: #606; 207 | } 208 | 209 | nav ul ul { 210 | margin-bottom: 10px 211 | } 212 | 213 | nav ul ul + ul { 214 | margin-top: -10px; 215 | } 216 | 217 | nav ul ul a { 218 | color: hsl(207, 1%, 60%); 219 | border-left: 1px solid hsl(207, 10%, 86%); 220 | } 221 | 222 | nav ul ul a, 223 | nav ul ul a:active { 224 | padding-left: 20px 225 | } 226 | 227 | nav h2 { 228 | font-size: 12px; 229 | margin: 0; 230 | padding: 0; 231 | } 232 | 233 | nav > h2 > a { 234 | display: block; 235 | margin: 10px 0 -10px; 236 | color: #606 !important; 237 | } 238 | 239 | footer { 240 | color: hsl(0, 0%, 28%); 241 | margin-left: 250px; 242 | display: block; 243 | padding: 15px; 244 | font-style: italic; 245 | font-size: 90%; 246 | } 247 | 248 | .ancestors { 249 | color: #999 250 | } 251 | 252 | .ancestors a { 253 | color: #999 !important; 254 | } 255 | 256 | .clear { 257 | clear: both 258 | } 259 | 260 | .important { 261 | font-weight: bold; 262 | color: #950B02; 263 | } 264 | 265 | .yes-def { 266 | text-indent: -1000px 267 | } 268 | 269 | .type-signature { 270 | color: #CA79CA 271 | } 272 | 273 | .type-signature:last-child { 274 | color: #eee; 275 | } 276 | 277 | .name, .signature { 278 | font-family: Consolas, Monaco, 'Andale Mono', monospace 279 | } 280 | 281 | .signature { 282 | color: #fc83ff; 283 | } 284 | 285 | .details { 286 | margin-top: 6px; 287 | border-left: 2px solid #DDD; 288 | line-height: 20px; 289 | font-size: 14px; 290 | } 291 | 292 | .details dt { 293 | width: 120px; 294 | float: left; 295 | padding-left: 10px; 296 | } 297 | 298 | .details dd { 299 | margin-left: 70px; 300 | margin-top: 6px; 301 | margin-bottom: 6px; 302 | } 303 | 304 | .details ul { 305 | margin: 0 306 | } 307 | 308 | .details ul { 309 | list-style-type: none 310 | } 311 | 312 | .details pre.prettyprint { 313 | margin: 0 314 | } 315 | 316 | .details .object-value { 317 | padding-top: 0 318 | } 319 | 320 | .description { 321 | margin-bottom: 1em; 322 | margin-top: 1em; 323 | } 324 | 325 | .code-caption { 326 | font-style: italic; 327 | font-size: 107%; 328 | margin: 0; 329 | } 330 | 331 | .prettyprint { 332 | font-size: 14px; 333 | overflow: auto; 334 | } 335 | 336 | .prettyprint.source { 337 | width: inherit; 338 | line-height: 18px; 339 | display: block; 340 | background-color: #0d152a; 341 | color: #aeaeae; 342 | } 343 | 344 | .prettyprint code { 345 | line-height: 18px; 346 | display: block; 347 | background-color: #0d152a; 348 | color: #4D4E53; 349 | } 350 | 351 | .prettyprint > code { 352 | padding: 15px; 353 | } 354 | 355 | .prettyprint .linenums code { 356 | padding: 0 15px 357 | } 358 | 359 | .prettyprint .linenums li:first-of-type code { 360 | padding-top: 15px 361 | } 362 | 363 | .prettyprint code span.line { 364 | display: inline-block 365 | } 366 | 367 | .prettyprint.linenums { 368 | padding-left: 70px; 369 | -webkit-user-select: none; 370 | -moz-user-select: none; 371 | -ms-user-select: none; 372 | user-select: none; 373 | } 374 | 375 | .prettyprint.linenums ol { 376 | padding-left: 0 377 | } 378 | 379 | .prettyprint.linenums li { 380 | border-left: 3px #34446B solid; 381 | } 382 | 383 | .prettyprint.linenums li.selected, .prettyprint.linenums li.selected * { 384 | background-color: #34446B; 385 | } 386 | 387 | .prettyprint.linenums li * { 388 | -webkit-user-select: text; 389 | -moz-user-select: text; 390 | -ms-user-select: text; 391 | user-select: text; 392 | } 393 | 394 | .params, .props { 395 | border-spacing: 0; 396 | border: 1px solid #ddd; 397 | border-collapse: collapse; 398 | border-radius: 3px; 399 | box-shadow: 0 1px 3px rgba(0,0,0,0.1); 400 | width: 100%; 401 | font-size: 14px; 402 | margin: 1em 0; 403 | } 404 | 405 | .params .type { 406 | white-space: nowrap; 407 | } 408 | 409 | .params code { 410 | white-space: pre; 411 | } 412 | 413 | .params td, .params .name, .props .name, .name code { 414 | color: #4D4E53; 415 | font-family: Consolas, Monaco, 'Andale Mono', monospace; 416 | font-size: 100%; 417 | } 418 | 419 | .params td, .params th, .props td, .props th { 420 | margin: 0px; 421 | text-align: left; 422 | vertical-align: top; 423 | padding: 10px; 424 | display: table-cell; 425 | } 426 | 427 | .params td { 428 | border-top: 1px solid #eee 429 | } 430 | 431 | .params thead tr, .props thead tr { 432 | background-color: #fff; 433 | font-weight: bold; 434 | } 435 | 436 | .params .params thead tr, .props .props thead tr { 437 | background-color: #fff; 438 | font-weight: bold; 439 | } 440 | 441 | .params td.description > p:first-child, .props td.description > p:first-child { 442 | margin-top: 0; 443 | padding-top: 0; 444 | } 445 | 446 | .params td.description > p:last-child, .props td.description > p:last-child { 447 | margin-bottom: 0; 448 | padding-bottom: 0; 449 | } 450 | 451 | span.param-type, .params td .param-type, .param-type dd { 452 | color: #606; 453 | font-family: Consolas, Monaco, 'Andale Mono', monospace 454 | } 455 | 456 | .param-type dt, .param-type dd { 457 | display: inline-block 458 | } 459 | 460 | .param-type { 461 | margin: 14px 0; 462 | } 463 | 464 | .disabled { 465 | color: #454545 466 | } 467 | 468 | /* navicon button */ 469 | .navicon-button { 470 | display: none; 471 | position: relative; 472 | padding: 2.0625rem 1.5rem; 473 | transition: 0.25s; 474 | cursor: pointer; 475 | -webkit-user-select: none; 476 | -moz-user-select: none; 477 | -ms-user-select: none; 478 | user-select: none; 479 | opacity: .8; 480 | } 481 | .navicon-button .navicon:before, .navicon-button .navicon:after { 482 | transition: 0.25s; 483 | } 484 | .navicon-button:hover { 485 | transition: 0.5s; 486 | opacity: 1; 487 | } 488 | .navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after { 489 | transition: 0.25s; 490 | } 491 | .navicon-button:hover .navicon:before { 492 | top: .825rem; 493 | } 494 | .navicon-button:hover .navicon:after { 495 | top: -.825rem; 496 | } 497 | 498 | /* navicon */ 499 | .navicon { 500 | position: relative; 501 | width: 2.5em; 502 | height: .3125rem; 503 | background: #000; 504 | transition: 0.3s; 505 | border-radius: 2.5rem; 506 | } 507 | .navicon:before, .navicon:after { 508 | display: block; 509 | content: ""; 510 | height: .3125rem; 511 | width: 2.5rem; 512 | background: #000; 513 | position: absolute; 514 | z-index: -1; 515 | transition: 0.3s 0.25s; 516 | border-radius: 1rem; 517 | } 518 | .navicon:before { 519 | top: .625rem; 520 | } 521 | .navicon:after { 522 | top: -.625rem; 523 | } 524 | 525 | /* open */ 526 | .nav-trigger:checked + label:not(.steps) .navicon:before, 527 | .nav-trigger:checked + label:not(.steps) .navicon:after { 528 | top: 0 !important; 529 | } 530 | 531 | .nav-trigger:checked + label .navicon:before, 532 | .nav-trigger:checked + label .navicon:after { 533 | transition: 0.5s; 534 | } 535 | 536 | /* Minus */ 537 | .nav-trigger:checked + label { 538 | -webkit-transform: scale(0.75); 539 | transform: scale(0.75); 540 | } 541 | 542 | /* × and + */ 543 | .nav-trigger:checked + label.plus .navicon, 544 | .nav-trigger:checked + label.x .navicon { 545 | background: transparent; 546 | } 547 | 548 | .nav-trigger:checked + label.plus .navicon:before, 549 | .nav-trigger:checked + label.x .navicon:before { 550 | -webkit-transform: rotate(-45deg); 551 | transform: rotate(-45deg); 552 | background: #FFF; 553 | } 554 | 555 | .nav-trigger:checked + label.plus .navicon:after, 556 | .nav-trigger:checked + label.x .navicon:after { 557 | -webkit-transform: rotate(45deg); 558 | transform: rotate(45deg); 559 | background: #FFF; 560 | } 561 | 562 | .nav-trigger:checked + label.plus { 563 | -webkit-transform: scale(0.75) rotate(45deg); 564 | transform: scale(0.75) rotate(45deg); 565 | } 566 | 567 | .nav-trigger:checked ~ nav { 568 | left: 0 !important; 569 | } 570 | 571 | .nav-trigger:checked ~ .overlay { 572 | display: block; 573 | } 574 | 575 | .nav-trigger { 576 | position: fixed; 577 | top: 0; 578 | clip: rect(0, 0, 0, 0); 579 | } 580 | 581 | .overlay { 582 | display: none; 583 | position: fixed; 584 | top: 0; 585 | bottom: 0; 586 | left: 0; 587 | right: 0; 588 | width: 100%; 589 | height: 100%; 590 | background: hsla(0, 0%, 0%, 0.5); 591 | z-index: 1; 592 | } 593 | 594 | @media only screen and (min-width: 320px) and (max-width: 680px) { 595 | body { 596 | overflow-x: hidden; 597 | } 598 | 599 | nav { 600 | background: #FFF; 601 | width: 250px; 602 | height: 100%; 603 | position: fixed; 604 | top: 0; 605 | right: 0; 606 | bottom: 0; 607 | left: -250px; 608 | z-index: 3; 609 | padding: 0 10px; 610 | transition: left 0.2s; 611 | } 612 | 613 | .navicon-button { 614 | display: inline-block; 615 | position: fixed; 616 | top: 1.5em; 617 | right: 0; 618 | z-index: 2; 619 | } 620 | 621 | #main { 622 | width: 100%; 623 | min-width: 360px; 624 | } 625 | 626 | #main h1.page-title { 627 | margin: 1em 0; 628 | } 629 | 630 | #main section { 631 | padding: 0; 632 | } 633 | 634 | footer { 635 | margin-left: 0; 636 | } 637 | } 638 | 639 | /** Add a '#' to static members */ 640 | [data-type="member"] a::before { 641 | content: '#'; 642 | display: inline-block; 643 | margin-left: -14px; 644 | margin-right: 5px; 645 | } 646 | -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Home - Documentation 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |

20 | 21 | 22 | 23 | 24 | 27 | 28 |

29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 |

54 | 55 |
56 | 57 | 60 | 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /docs/Node.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Node - Documentation 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |

20 | 21 | 22 | 23 | 24 | 27 | 28 |

29 | 30 |

Node

31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |

39 | 40 |

41 | 42 |

43 | Node 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 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 |

97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 |

Methods

112 | 113 | 114 | 115 | 116 | 117 | 118 |

(route) getDefaultNode()

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 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 |

165 |

Route:

166 | 167 | 168 | 169 | 170 | 171 | 172 |

Method	Path
GET	/api/node/default

173 | Return default node 174 |

Response:

175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 |

Name	Type	Description
node	Object	Return node object

193 |

194 | 195 | 196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 |

226 | 227 |

228 | 229 | 230 | 231 | 232 |

233 | 234 |
235 | 236 | 239 | 240 | 241 | 242 | 243 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PM2.io API Client for Javascript 2 | 3 | This module lets you implement a fully customizable PM2.io client, receiving live data from the PM2.io API. 4 | 5 | ## Install 6 | 7 | With NPM: 8 | 9 | ```bash 10 | $ npm install @pm2/js-api --save 11 | ``` 12 | 13 | Or get the raw library for browser here: 14 | 15 | [https://unpkg.com/@pm2/js-api](https://unpkg.com/@pm2/js-api) 16 | 17 | ## Usage 18 | 19 | To use this client you need to first requiring it into your code and creating a new instance : 20 | 21 | ```javascript 22 | const PM2IO = require('@pm2/js-api') 23 | 24 | let client = new PM2IO() 25 | ``` 26 | 27 | Then you'll to tell the client how you want to authenticate, you have the choice : 28 | 29 | - First the `standalone` flow, you just need to enter a refresh token and it will works 30 | ```javascript 31 | client.use('standalone', { 32 | refresh_token: 'token' 33 | }) 34 | ``` 35 | 36 | - Secondly, the `browser` flow, you have a custom keymetrics application and you want to authenticate of the behalf for any user (in this flow you need to be inside a browser) : 37 | ```javascript 38 | client.use('browser', { 39 | client_id: 'my-oauth-client-id' 40 | }) 41 | ``` 42 | 43 | - Thirdly, the `embed` flow, you have a custom keymetrics application and you want to authenticate of the behalf of any user (you need to be in a nodejs process, for example a CLI) : 44 | ```javascript 45 | client.use('embed', { 46 | client_id: 'my-oauth-client-id' 47 | }) 48 | ``` 49 | 50 | After that, you can do whatever call you want just keep in mind each call return a Promise (the client will handle authentication) : 51 | ```javascript 52 | client.user.retrieve() 53 | .then((response) => { 54 | // see https://github.com/mzabriskie/axios#response-schema 55 | // for the content of response 56 | }).catch((err) => { 57 | // see https://github.com/mzabriskie/axios#handling-errors 58 | // for the content of err 59 | }) 60 | ``` 61 | 62 | ## Example 63 | 64 | ```javascript 65 | const PM2IO = require('@pm2/js-api') 66 | 67 | let client = new PM2IO().use('standalone', { 68 | refresh_token: 'token' 69 | }) 70 | 71 | // retrieve our buckets 72 | client.bucket.retrieveAll() 73 | .then((res) => { 74 | // find our bucket 75 | let bucket = res.data.find(bucket => bucket.name === 'Keymetrics') 76 | 77 | // connect to realtime data of a bucket 78 | client.realtime.subscribe(bucket._id).catch(console.error) 79 | 80 | // attach handler on specific realtime data 81 | client.realtime.on(`${bucket.public_id}:connected`, () => console.log('connected to realtime')) 82 | client.realtime.on(`${bucket.public_id}:*:status`, (data) => console.log(data.server_name)) 83 | 84 | // we can also unsubscribe from a bucket realtime data 85 | setTimeout(() => { 86 | client.realtime.unsubscribe(bucket._id).catch(console.error) 87 | }, 5000) 88 | }) 89 | .catch(console.error) 90 | ``` 91 | 92 | ### Realtime 93 | 94 | All realtime data are broadcasted with the following pattern : 95 | 96 | ``` 97 | bucket_public_id:server_name:data_method 98 | ``` 99 | 100 | For example : 101 | 102 | ```javascript 103 | // here i listen on the status data for 104 | // the server "my_server" on the bucket with 105 | // the public id 4398545 106 | client.realtime.on(`4398545:my_server:status`, (data) => { 107 | console.log(data.server_name)) 108 | } 109 | ``` 110 | 111 | #### Events available 112 | 113 | | Event | Description | 114 | |-------|-------------| 115 | | mediator:blacklist | Used to broadcast updated process blacklisted | 116 | | human:event | Events sent via pmx.emit() | 117 | | process:exception | Issues from pm2 or apm | 118 | | logs | Logs | 119 | | status | Status sent by apm or pm2 | 120 | | metric | Metric sent by apm/collectors | 121 | | axm:transaction:outlier | Outlier for transaction tracing | 122 | | process:event | Event from pm2 (restart...) | 123 | | profiling | Profiling packet with profiling link | 124 | | axm:scoped_action:stream | Stream from scoped action | 125 | | axm:scoped_action:end | End of scoped action | 126 | | axm:scoped_action:error | Error for a scoped action | 127 | | pm2:scoped:end | End for pm2 scoped | 128 | | pm2:scoped:stream | Stream from pm2 scoped | 129 | | pm2:scoped:error | Error from pm2 scoped | 130 | | trace-span | Span for distributed tracing | 131 | | axm:transaction | Transaction for transaction tracing | 132 | | trigger:pm2:result | Result from a pm2 action | 133 | | trigger:action:success | Success from a custom action | 134 | | trigger:action:failure | Error from a customer action | 135 | | axm:reply | Reply from a custom action | 136 | 137 | ## Route definition 138 | 139 | ``` 140 | client.actions.triggerAction -> POST /api/bucket/:id/actions/trigger 141 | client.actions.triggerPM2Action -> POST /api/bucket/:id/actions/triggerPM2 142 | client.actions.triggerScopedAction -> POST /api/bucket/:id/actions/triggerScopedAction 143 | client.bucket.sendFeedback -> PUT /api/bucket/:id/feedback 144 | client.bucket.retrieveUsers -> GET /api/bucket/:id/users_authorized 145 | client.bucket.currentRole -> GET /api/bucket/:id/current_role 146 | client.bucket.setNotificationState -> POST /api/bucket/:id/manage_notif 147 | client.bucket.inviteUser -> POST /api/bucket/:id/add_user 148 | client.bucket.removeInvitation -> DELETE /api/bucket/:id/invitation 149 | client.bucket.removeUser -> POST /api/bucket/:id/remove_user 150 | client.bucket.setUserRole -> POST /api/bucket/:id/promote_user 151 | client.bucket.retrieveAll -> GET /api/bucket/ 152 | client.bucket.create -> POST /api/bucket/create_classic 153 | client.bucket.claimTrial -> PUT /api/bucket/:id/start_trial 154 | client.bucket.upgrade -> POST /api/bucket/:id/upgrade 155 | client.bucket.retrieve -> GET /api/bucket/:id 156 | client.bucket.update -> PUT /api/bucket/:id 157 | client.bucket.retrieveServers -> GET /api/bucket/:id/meta_servers 158 | client.bucket.getSubscription -> GET /api/bucket/:id/subscription 159 | client.bucket.destroy -> DELETE /api/bucket/:id 160 | client.bucket.transferOwnership -> POST /api/bucket/:id/transfer_ownership 161 | client.bucket.retrieveCharges -> GET /api/bucket/:id/payment/charges 162 | client.bucket.updateUserOptions -> PUT /api/bucket/:id/user_options 163 | client.bucket.alert.update -> POST /api/bucket/:id/alerts/update 164 | client.bucket.alert.updateSlack -> POST /api/bucket/:id/alerts/updateSlack 165 | client.bucket.alert.updateWebhooks -> POST /api/bucket/:id/alerts/updateWebhooks 166 | client.bucket.alert.create -> POST /api/bucket/:id/alerts 167 | client.bucket.alert.delete -> DELETE /api/bucket/:id/alerts/:alert 168 | client.bucket.alert.list -> GET /api/bucket/:id/alerts/ 169 | client.bucket.alert.updateAlert -> PUT /api/bucket/:id/alerts/:alert 170 | client.bucket.alert.get -> GET /api/bucket/:id/alerts/:alert 171 | client.bucket.alert.triggerSample -> POST /api/bucket/:id/alerts/:alert/sample 172 | client.bucket.alert.analyzer.list -> POST /api/bucket/:id/alerts/analyzer 173 | client.bucket.alert.analyzer.editState -> PUT /api/bucket/:id/alerts/analyzer/:alert 174 | client.bucket.alert.analyzer.updateConfig -> PUT /api/bucket/:id/alerts/analyzer/:analyzer/config 175 | client.bucket.billing.subscribe -> POST /api/bucket/:id/payment/subscribe 176 | client.bucket.billing.startTrial -> PUT /api/bucket/:id/payment/trial 177 | client.bucket.billing.getInvoices -> GET /api/bucket/:id/payment/invoices 178 | client.bucket.billing.getReceipts -> GET /api/bucket/:id/payment/receipts 179 | client.bucket.billing.getSubcription -> GET /api/bucket/:id/payment/subscription 180 | client.bucket.billing.getSubcriptionState -> GET /api/bucket/:id/payment/subscription/state 181 | client.bucket.billing.attachCreditCard -> POST /api/bucket/:id/payment/cards 182 | client.bucket.billing.fetchCreditCards -> GET /api/bucket/:id/payment/cards 183 | client.bucket.billing.fetchCreditCard -> GET /api/bucket/:id/payment/card/:card_id 184 | client.bucket.billing.fetchDefaultCreditCard -> GET /api/bucket/:id/payment/card 185 | client.bucket.billing.updateCreditCard -> PUT /api/bucket/:id/payment/card 186 | client.bucket.billing.deleteCreditCard -> DELETE /api/bucket/:id/payment/card/:card_id 187 | client.bucket.billing.setDefaultCard -> POST /api/bucket/:id/payment/card/:card_id/default 188 | client.bucket.billing.fetchMetadata -> GET /api/bucket/:id/payment 189 | client.bucket.billing.updateMetadata -> PUT /api/bucket/:id/payment 190 | client.bucket.billing.attachBankAccount -> POST /api/bucket/:id/payment/banks 191 | client.bucket.billing.fetchBankAccount -> GET /api/bucket/:id/payment/banks 192 | client.bucket.billing.deleteBankAccount -> DELETE /api/bucket/:id/payment/banks 193 | client.data.dependencies.retrieve -> POST /api/bucket/:id/data/dependencies/ 194 | client.data.events.retrieve -> POST /api/bucket/:id/data/events 195 | client.data.events.retrieveMetadatas -> GET /api/bucket/:id/data/eventsKeysByApp 196 | client.data.events.retrieveHistogram -> POST /api/bucket/:id/data/events/stats 197 | client.data.events.deleteAll -> DELETE /api/bucket/:id/data/events/delete_all 198 | client.data.exceptions.retrieve -> POST /api/bucket/:id/data/exceptions 199 | client.data.exceptions.retrieveSummary -> GET /api/bucket/:id/data/exceptions/summary 200 | client.data.exceptions.deleteAll -> POST /api/bucket/:id/data/exceptions/delete_all 201 | client.data.exceptions.delete -> POST /api/bucket/:id/data/exceptions/delete 202 | client.data.issues.list -> POST /api/bucket/:id/data/issues/list 203 | client.data.issues.listOccurencesForIdentifier -> GET /api/bucket/:id/data/issues/occurrences/:identifier 204 | client.data.issues.getReplay -> GET /api/bucket/:id/data/issues/replay/:uuid 205 | client.data.issues.retrieveHistogram -> POST /api/bucket/:id/data/issues/histogram 206 | client.data.issues.findOccurences -> POST /api/bucket/:id/data/issues/ocurrences 207 | client.data.issues.search -> POST /api/bucket/:id/data/issues/search 208 | client.data.issues.summary -> GET /api/bucket/:id/data/issues/summary/:aggregateBy 209 | client.data.issues.deleteAll -> DELETE /api/bucket/:id/data/issues 210 | client.data.issues.delete -> DELETE /api/bucket/:id/data/issues/:identifier 211 | client.data.logs.retrieve -> POST /api/bucket/:id/data/logs 212 | client.data.logs.retrieveHistogram -> POST /api/bucket/:id/data/logs/histogram 213 | client.data.metrics.retrieveAggregations -> POST /api/bucket/:id/data/metrics/aggregations 214 | client.data.metrics.retrieveHistogram -> POST /api/bucket/:id/data/metrics/histogram 215 | client.data.metrics.retrieveList -> POST /api/bucket/:id/data/metrics/list 216 | client.data.metrics.retrieveMetadatas -> POST /api/bucket/:id/data/metrics 217 | client.data.outliers.retrieve -> POST /api/bucket/:id/data/outliers/ 218 | client.data.processes.retrieveEvents -> POST /api/bucket/:id/data/processEvents 219 | client.data.processes.retrieveDeployments -> POST /api/bucket/:id/data/processEvents/deployments 220 | client.data.profiling.retrieve -> GET /api/bucket/:id/data/profilings/:filename 221 | client.data.profiling.download -> GET /api/bucket/:id/data/profilings/:filename/download 222 | client.data.profiling.list -> POST /api/bucket/:id/data/profilings 223 | client.data.profiling.delete -> DELETE /api/bucket/:id/data/profilings/:filename 224 | client.data.status.retrieve -> GET /api/bucket/:id/data/status 225 | client.data.status.retrieveBlacklisted -> GET /api/bucket/:id/data/status/blacklisted 226 | client.data.transactions.retrieveHistogram -> POST /api/bucket/:id/data/transactions/v2/histogram 227 | client.data.transactions.retrieveSummary -> POST /api/bucket/:id/data/transactions/v2/summary 228 | client.data.transactions.delete -> POST /api/bucket/:id/data/transactions/v2/delete 229 | client.dashboard.retrieveAll -> GET /api/bucket/:id/dashboard/ 230 | client.dashboard.retrieve -> GET /api/bucket/:id/dashboard/:dashid 231 | client.dashboard.remove -> DELETE /api/bucket/:id/dashboard/:dashid 232 | client.dashboard.update -> POST /api/bucket/:id/dashboard/:dashId 233 | client.dashboard.create -> PUT /api/bucket/:id/dashboard/ 234 | client.misc.listChangelogArticles -> GET /api/misc/changelog 235 | client.misc.retrievePM2Version -> GET /api/misc/release/pm2 236 | client.misc.retrieveNodeRelease -> GET /api/misc/release/nodejs/:version 237 | client.misc.retrievePlans -> GET /api/misc/plans 238 | client.misc.retrieveCoupon -> POST /api/misc/stripe/retrieveCoupon 239 | client.misc.retrieveCompany -> POST /api/misc/stripe/retrieveCompany 240 | client.misc.retrieveVAT -> POST /api/misc/stripe/retrieveVat 241 | client.orchestration.selfSend -> POST /api/bucket/:id/balance 242 | client.bucket.server.deleteServer -> POST /api/bucket/:id/data/deleteServer 243 | client.tokens.retrieve -> GET /api/users/token/ 244 | client.tokens.remove -> DELETE /api/users/token/:id 245 | client.tokens.create -> PUT /api/users/token/ 246 | client.user.retrieve -> GET /api/users/isLogged 247 | client.user.show -> GET /api/users/show/:id 248 | client.user.update -> POST /api/users/update 249 | client.user.delete -> DELETE /api/users/delete 250 | client.user.attachCreditCard -> POST /api/users/payment/ 251 | client.user.listSubscriptions -> GET /api/users/payment/subcriptions 252 | client.user.listCharges -> GET /api/users/payment/charges 253 | client.user.fetchCreditCard -> GET /api/users/payment/card/:card_id 254 | client.user.fetchDefaultCreditCard -> GET /api/users/payment/card 255 | client.user.updateCreditCard -> PUT /api/users/payment/card 256 | client.user.deleteCreditCard -> DELETE /api/users/payment/card/:card_id 257 | client.user.setDefaultCard -> POST /api/users/payment/card/:card_id/default 258 | client.user.fetchMetadata -> GET /api/users/payment/card/stripe_metadata 259 | client.user.updateMetadata -> PUT /api/users/payment/stripe_metadata 260 | client.user.otp.retrieve -> GET /api/users/otp 261 | client.user.otp.enable -> POST /api/users/otp 262 | client.user.otp.disable -> DELETE /api/users/otp 263 | client.user.providers.retrieve -> GET /api/users/integrations 264 | client.user.providers.add -> POST /api/users/integrations 265 | client.user.providers.remove -> DELETE /api/users/integrations/:name 266 | client.bucket.webcheck.listMetrics -> GET /api/bucket/:id/webchecks/metrics 267 | client.bucket.webcheck.listRegions -> GET /api/bucket/:id/webchecks/regions 268 | client.bucket.webcheck.getMetrics -> POST /api/bucket/:id/webchecks/:webcheck/metrics 269 | client.bucket.webcheck.list -> GET /api/bucket/:id/webchecks 270 | client.bucket.webcheck.get -> GET /api/bucket/:id/webchecks/:webcheck 271 | client.bucket.webcheck.create -> POST /api/bucket/:id/webchecks 272 | client.bucket.webcheck.update -> PUT /api/bucket/:id/webchecks/:webcheck 273 | client.bucket.webcheck.delete -> DELETE /api/bucket/:id/webchecks/:webcheck 274 | client.auth.retrieveToken -> POST /api/oauth/token 275 | client.auth.requestNewPassword -> POST /api/oauth/reset_password 276 | client.auth.sendEmailLink -> POST /api/oauth/send_email_link 277 | client.auth.validEmail -> GET /api/oauth/valid_email/:token 278 | client.auth.register -> GET /api/oauth/register 279 | client.auth.revoke -> POST /api/oauth/revoke 280 | client.data.traces.list -> POST /api/bucket/:id/data/traces 281 | client.data.traces.retrieve -> GET /api/bucket/:id/data/traces/:trace 282 | client.data.traces.getServices -> GET /api/bucket/:id/data/traces/services 283 | client.data.traces.getTags -> GET /api/bucket/:id/data/traces/tags 284 | client.data.traces.getHistogramByTag -> POST /api/bucket/:id/data/traces/histogram/tag 285 | client.data.notifications.list -> POST /api/bucket/:id/data/notifications 286 | client.data.notifications.retrieve -> GET /api/bucket/:id/data/notifications/:notification 287 | client.bucket.application.list -> GET /api/bucket/:id/applications 288 | client.bucket.application.get -> GET /api/bucket/:id/applications/:application 289 | client.bucket.application.create -> POST /api/bucket/:id/applications 290 | client.bucket.application.update -> PUT /api/bucket/:id/applications/:application 291 | client.bucket.application.delete -> DELETE /api/bucket/:id/applications/:application 292 | client.bucket.application.getPreview -> GET /api/bucket/:id/applications/:application/preview 293 | client.bucket.application.getReports -> GET /api/bucket/:id/applications/:application/report 294 | ``` 295 | 296 | ## Local Backend 297 | 298 | - Create token in user setting then: 299 | 300 | ### Standalone logging 301 | 302 | ```javascript 303 | const PM2IO = require('@pm2/js-api') 304 | 305 | let io = new PM2IO({ 306 | services: { 307 | API: 'http://cl1.km.io:3000', 308 | OAUTH: 'http://cl1.km.io:3100' 309 | } 310 | }).use('standalone', { 311 | refresh_token: 'refresh-token' 312 | }) 313 | ``` 314 | 315 | ### Browser logging 316 | 317 | ```javascript 318 | const PM2IO = require('@pm2/js-api') 319 | 320 | let io = new PM2IO({ 321 | OAUTH_CLIENT_ID: '5413907556', 322 | services: { 323 | API: 'http://cl1.km.io:3000', 324 | OAUTH: 'http://cl1.km.io:3100' 325 | } 326 | }).use('standalone', { 327 | refresh_token: 'refresh-token' 328 | }) 329 | ``` 330 | 331 | ## Tasks 332 | 333 | ``` 334 | # Browserify + Babelify to ES5 (output to ./dist/keymetrics.es5.js) 335 | $ npm run build 336 | # Browserify + Babelify + Uglify (output to ./dist/keymetrics.min.js) 337 | $ npm run dist 338 | # Generate documentation 339 | $ npm run doc 340 | ``` 341 | 342 | ## License 343 | 344 | Apache 2.0 345 | 346 | ## Release 347 | 348 | ## Release 349 | 350 | To release a new version, first install [gren](https://github.com/github-tools/github-release-notes) : 351 | ```bash 352 | yarn global add github-release-notes 353 | ``` 354 | 355 | Push a commit in github with the new version you want to release : 356 | ``` 357 | git commit -am "version: major|minor|patch bump to X.X.X" 358 | ``` 359 | 360 | Care for the **versionning**, we use the [semver versioning](https://semver.org/) currently. Please be careful about the version when pushing a new package. 361 | 362 | Then tag a version with git : 363 | ```bash 364 | git tag -s vX.X.X 365 | ``` 366 | 367 | Push the tag into github (this will trigger the publish to npm) : 368 | ``` 369 | git push origin vX.X.X 370 | ``` 371 | 372 | To finish update the changelog of the release on github with `gren` (be sure that gren has selected the right tags): 373 | ``` 374 | gren release -o -D commits -u keymetrics -r pm2-io-js-api 375 | ``` 376 | -------------------------------------------------------------------------------- /src/network.js: -------------------------------------------------------------------------------- 1 | 2 | 'use strict' 3 | 4 | const extrareqp2 = require('extrareqp2') 5 | const AuthStrategy = require('./auth_strategies/strategy') 6 | const constants = require('../constants') 7 | const logger = require('debug')('kmjs:network') 8 | const loggerHttp = require('debug')('kmjs:network:http') 9 | const loggerWS = require('debug')('kmjs:network:ws') 10 | const WS = require('./utils/websocket') 11 | const EventEmitter = require('eventemitter2') 12 | const async = require('async') 13 | 14 | const BUFFERIZED = -1 15 | 16 | module.exports = class NetworkWrapper { 17 | constructor (km, opts) { 18 | logger('init network manager') 19 | opts.baseURL = opts.services.API 20 | this.opts = opts 21 | this.opts.maxRedirects = 0 22 | this.tokens = { 23 | refresh_token: null, 24 | access_token: null 25 | } 26 | this.km = km 27 | this._queue = [] 28 | this._extrareqp2 = extrareqp2.create(opts) 29 | this._websockets = [] 30 | this._endpoints = new Map() 31 | this._bucketFilters = new Map() 32 | 33 | this.apiDateLag = 0 34 | 35 | this.realtime = new EventEmitter({ 36 | wildcard: true, 37 | delimiter: ':', 38 | newListener: false, 39 | maxListeners: 100 40 | }) 41 | // https://github.com/EventEmitter2/EventEmitter2/issues/214 42 | const self = this 43 | const realtimeOn = this.realtime.on 44 | this.realtime.on = function () { 45 | self.editSocketFilters('push', arguments[0]) 46 | return realtimeOn.apply(self.realtime, arguments) 47 | } 48 | const realtimeOff = this.realtime.off 49 | this.realtime.off = function () { 50 | self.editSocketFilters('remove', arguments[0]) 51 | return realtimeOff.apply(self.realtime, arguments) 52 | } 53 | this.realtime.subscribe = this.subscribe.bind(this) 54 | this.realtime.unsubscribe = this.unsubscribe.bind(this) 55 | this.authenticated = false 56 | this._setupDateLag() 57 | } 58 | 59 | _setupDateLag () { 60 | const updateApiDateLag = response => { 61 | if (response && response.headers && response.headers.date) { 62 | const headerDate = new Date(response.headers.date) 63 | const clientDate = new Date() 64 | 65 | // The header date is likely to be truncated to the second, so truncate the client date too 66 | headerDate.setMilliseconds(0) 67 | clientDate.setMilliseconds(0) 68 | 69 | this.apiDateLag = headerDate - clientDate 70 | } 71 | } 72 | 73 | this._extrareqp2.interceptors.response.use( 74 | response => { 75 | updateApiDateLag(response) 76 | return response 77 | }, 78 | error => { 79 | updateApiDateLag(error.response) 80 | return Promise.reject(error) 81 | } 82 | ) 83 | } 84 | 85 | _queueUpdater () { 86 | if (this.authenticated === false) return 87 | 88 | if (this._queue.length > 0) { 89 | logger(`Emptying requests queue (size: ${this._queue.length})`) 90 | } 91 | 92 | // when we are authenticated we can clear the queue 93 | while (this._queue.length > 0) { 94 | let promise = this._queue.shift() 95 | // make the request 96 | this.request(promise.request).then(promise.resolve, promise.reject) 97 | } 98 | } 99 | 100 | /** 101 | * Resolve the endpoint of the node to make the request to 102 | * because each bucket might be on a different node 103 | * @param {String} bucketID the bucket id 104 | * 105 | * @return {Promise} 106 | */ 107 | _resolveBucketEndpoint (bucketID) { 108 | if (!bucketID) return Promise.reject(new Error(`Missing argument : bucketID`)) 109 | 110 | if (!this._endpoints.has(bucketID)) { 111 | const promise = this._extrareqp2.request({ 112 | url: `/api/bucket/${bucketID}`, 113 | method: 'GET', 114 | headers: { 115 | Authorization: `Bearer ${this.tokens.access_token}` 116 | } 117 | }) 118 | .then((res) => { 119 | return res.data.node.endpoints.web 120 | }) 121 | .catch((e) => { 122 | this._endpoints.delete(bucketID) 123 | throw e 124 | }) 125 | 126 | this._endpoints.set(bucketID, promise) 127 | } 128 | 129 | return this._endpoints.get(bucketID) 130 | } 131 | 132 | /** 133 | * Send a http request 134 | * @param {Object} opts 135 | * @param {String} [opts.method=GET] http method 136 | * @param {String} opts.url the full URL 137 | * @param {Object} [opts.data] body data 138 | * @param {Object} [opts.params] url params 139 | * 140 | * @return {Promise} 141 | */ 142 | request (httpOpts) { 143 | return new Promise((resolve, reject) => { 144 | async.series([ 145 | // verify that we don't need to buffer the request because authentication 146 | next => { 147 | if (this.authenticated === true || httpOpts.authentication === false) return next() 148 | 149 | loggerHttp(`Queued request to ${httpOpts.url}`) 150 | this._queue.push({ 151 | resolve, 152 | reject, 153 | request: httpOpts 154 | }) 155 | // we need to stop the flow here 156 | return next(BUFFERIZED) 157 | }, 158 | // we need to verify that the baseURL is correct 159 | (next) => { 160 | if (!httpOpts.url.match(/bucket\/[0-9a-fA-F]{24}/)) return next() 161 | // parse the bucket id from URL 162 | let bucketID = httpOpts.url.split('/')[3] 163 | // we need to retrieve where to send the request depending on the backend 164 | this._resolveBucketEndpoint(bucketID) 165 | .then(endpoint => { 166 | httpOpts.baseURL = endpoint 167 | // then continue the flow 168 | return next() 169 | }).catch(next) 170 | }, 171 | // if the request has not been bufferized, make the request 172 | next => { 173 | // super trick to transform a promise response to a callback 174 | const successNext = res => next(null, res) 175 | loggerHttp(`Making request to ${httpOpts.url}`) 176 | 177 | if (!httpOpts.headers) { 178 | httpOpts.headers = {} 179 | } 180 | httpOpts.headers.Authorization = `Bearer ${this.tokens.access_token}` 181 | 182 | this._extrareqp2.request(httpOpts) 183 | .then(successNext) 184 | .catch((error) => { 185 | let response = error.response 186 | // we only need to handle when code is 401 (which mean unauthenticated) 187 | if (response && response.status !== 401) return next(response) 188 | loggerHttp(`Got unautenticated response, buffering request from now ...`) 189 | 190 | // we tell the client to not send authenticated request anymore 191 | this.authenticated = false 192 | 193 | loggerHttp(`Asking to the oauth flow to retrieve new tokens`) 194 | 195 | var q = () => { 196 | this.oauth_flow.retrieveTokens(this.km, (err, data) => { 197 | // if it fail, we fail the whole request 198 | if (err) { 199 | loggerHttp(`Failed to retrieve new tokens : ${err.message || err}`) 200 | return next(response) 201 | } 202 | // if its good, we try to update the tokens 203 | loggerHttp(`Succesfully retrieved new tokens`) 204 | this._updateTokens(null, data, (err, authenticated) => { 205 | // if it fail, we fail the whole request 206 | if (err) return next(response) 207 | // then we can rebuffer the request 208 | loggerHttp(`Re-buffering call to ${httpOpts.url} since authenticated now`) 209 | httpOpts.headers.Authorization = `Bearer ${this.tokens.access_token}` 210 | return this._extrareqp2.request(httpOpts).then(successNext).catch(next) 211 | }) 212 | }) 213 | } 214 | if (httpOpts.url == this.opts.services.OAUTH + '/api/oauth/token') { 215 | // Avoid infinite recursive loop to retrieveToken 216 | return setTimeout(q.bind(this), 500) 217 | } 218 | q() 219 | }) 220 | } 221 | ], (err, results) => { 222 | // if the flow is stoped because the request has been 223 | // buferred, we don't need to do anything 224 | if (err === BUFFERIZED) return 225 | return err ? reject(err) : resolve(results[2]) 226 | }) 227 | }) 228 | } 229 | 230 | /** 231 | * Update the access token used by all the networking clients 232 | * @param {Error} err if any erro 233 | * @param {String} accessToken the token you want to use 234 | * @param {Function} [cb] invoked with 235 | * @private 236 | */ 237 | _updateTokens (err, data, cb) { 238 | if (err) { 239 | console.error('Error while retrieving tokens:', err) 240 | // Try to logout/login user 241 | this.oauth_flow.deleteTokens(this.km) 242 | return console.error(err.response ? err.response.data : err.stack) 243 | } 244 | if (!data || !data.access_token || !data.refresh_token) throw new Error('Invalid tokens') 245 | 246 | this.tokens = data 247 | 248 | loggerHttp(`Registered new access_token : ${data.access_token}`) 249 | this._websockets.forEach(websocket => websocket.updateAuthorization(data.access_token)) 250 | this._extrareqp2.defaults.headers.common['Authorization'] = `Bearer ${data.access_token}` 251 | this._extrareqp2.request({ 252 | url: '/api/bucket', 253 | method: 'GET', 254 | headers: { 255 | Authorization: `Bearer ${data.access_token}` 256 | } 257 | }).then((res) => { 258 | loggerHttp(`Cached ${res.data.length} buckets for current user`) 259 | this.authenticated = true 260 | this._queueUpdater() 261 | return typeof cb === 'function' ? cb(null, true) : null 262 | }).catch((err) => { 263 | console.error('Error while retrieving buckets') 264 | console.error(err.response ? err.response.data : err) 265 | return typeof cb === 'function' ? cb(err) : null 266 | }) 267 | } 268 | 269 | /** 270 | * Specify a strategy to use when authenticating to server 271 | * @param {String|Function} flow the name of the flow to use or a custom implementation 272 | * @param {Object} [opts] 273 | * @param {String} [opts.client_id] the OAuth client ID to use to identify the application 274 | * default to the one defined when instancing Keymetrics and fallback to 795984050 (custom tokens) 275 | * @throws invalid use of this function, either the flow don't exist or isn't correctly implemented 276 | */ 277 | useStrategy (flow, opts) { 278 | if (!opts) opts = {} 279 | // if client not provided here, use the one given in the instance 280 | if (!opts.client_id) { 281 | opts.client_id = this.opts.OAUTH_CLIENT_ID 282 | } 283 | 284 | // in the case of flow being a custom implementation 285 | if (typeof flow === 'object') { 286 | this.oauth_flow = flow 287 | if (!this.oauth_flow.retrieveTokens || !this.oauth_flow.deleteTokens) { 288 | throw new Error('You must implement the Strategy interface to use it') 289 | } 290 | return this.oauth_flow.retrieveTokens(this.km, this._updateTokens.bind(this)) 291 | } 292 | // otherwise fallback on the flow that are implemented 293 | if (typeof AuthStrategy.implementations(flow) === 'undefined') { 294 | throw new Error(`The flow named ${flow} doesn't exist`) 295 | } 296 | let flowMeta = AuthStrategy.implementations(flow) 297 | 298 | // verify that the environnement condition is meet 299 | if (flowMeta.condition && constants.ENVIRONNEMENT !== flowMeta.condition) { 300 | throw new Error(`The flow ${flow} is reserved for ${flowMeta.condition} environment`) 301 | } 302 | let FlowImpl = flowMeta.nodule 303 | this.oauth_flow = new FlowImpl(opts) 304 | return this.oauth_flow.retrieveTokens(this.km, this._updateTokens.bind(this)) 305 | } 306 | 307 | editSocketFilters (type, event) { 308 | if (event.indexOf('**') === 0) throw new Error('You need to provide a bucket public id.') 309 | event = event.split(':') 310 | const bucketPublicId = event[0] 311 | const filter = event.slice(2).join(':') 312 | const socket = this._websockets.find(socket => socket.bucketPublic === bucketPublicId) 313 | if (!this._bucketFilters.has(bucketPublicId)) this._bucketFilters.set(bucketPublicId, []) 314 | const filters = this._bucketFilters.get(bucketPublicId) 315 | 316 | if (type === 'push') { 317 | filters.push(filter) 318 | } else { 319 | filters.splice(filters.indexOf(filter), 1) 320 | } 321 | 322 | if (!socket) return 323 | socket.send(JSON.stringify({ 324 | action: 'sub', 325 | public_id: bucketPublicId, 326 | filters: Array.from(new Set(filters)) // avoid duplicates 327 | })) 328 | } 329 | 330 | /** 331 | * Subscribe to realtime from bucket 332 | * @param {String} bucketId bucket id 333 | * @param {Object} [opts] 334 | * 335 | * @return {Promise} 336 | */ 337 | subscribe (bucketId, opts) { 338 | return new Promise((resolve, reject) => { 339 | logger(`Request endpoints for ${bucketId}`) 340 | this.km.bucket.retrieve(bucketId) 341 | .then((res) => { 342 | let bucket = res.data 343 | let connected = false 344 | 345 | const endpoints = bucket.node.endpoints 346 | let endpoint = endpoints.realtime || endpoints.web 347 | endpoint = endpoint.replace('http', 'ws') 348 | if (this.opts.IS_DEBUG) { 349 | endpoint = endpoint.replace(':3000', ':4020') 350 | } 351 | loggerWS(`Found endpoint for ${bucketId} : ${endpoint}`) 352 | 353 | // connect websocket client to the realtime endpoint 354 | let socket = new WS(`${endpoint}/primus`, this.tokens.access_token) 355 | socket.bucketPublic = bucket.public_id 356 | socket.connected = false 357 | socket.bucket = bucketId 358 | 359 | let keepAliveHandler = function () { 360 | socket.ping() 361 | } 362 | let keepAliveInterval = null 363 | 364 | let onConnect = () => { 365 | logger(`Connected to ws endpoint : ${endpoint} (bucket: ${bucketId})`) 366 | socket.connected = true 367 | this.realtime.emit(`${bucket.public_id}:connected`) 368 | 369 | socket.send(JSON.stringify({ 370 | action: 'sub', 371 | public_id: bucket.public_id, 372 | filters: Array.from(new Set(this._bucketFilters.get(bucket.public_id))) // avoid duplicates 373 | })) 374 | 375 | if (keepAliveInterval !== null) { 376 | clearInterval(keepAliveInterval) 377 | keepAliveInterval = null 378 | } 379 | keepAliveInterval = setInterval(keepAliveHandler.bind(this), 5000) 380 | if (!connected) { 381 | connected = true 382 | return resolve(socket) 383 | } 384 | } 385 | socket.onmaxreconnect = _ => { 386 | if (!connected) { 387 | connected = true 388 | return reject(new Error('Connection timeout')) 389 | } 390 | } 391 | socket.onopen = onConnect 392 | 393 | socket.onunexpectedresponse = (req, res) => { 394 | if (res.statusCode === 401) { 395 | return this.oauth_flow.retrieveTokens(this.km, (err, data) => { 396 | if (err) return logger(`Failed to retrieve tokens for ws: ${err.message}`) 397 | logger(`Succesfully retrieved new tokens for ws`) 398 | this._updateTokens(null, data, (err, authenticated) => { 399 | if (err) return logger(`Failed to update tokens for ws: ${err.message}`) 400 | return socket._tryReconnect() 401 | }) 402 | }) 403 | } 404 | return socket._tryReconnect() 405 | } 406 | socket.onerror = (err) => { 407 | loggerWS(`Error on ${endpoint} (bucket: ${bucketId})`) 408 | loggerWS(err) 409 | 410 | this.realtime.emit(`${bucket.public_id}:error`, err) 411 | } 412 | 413 | socket.onclose = () => { 414 | logger(`Closing ws connection ${endpoint} (bucket: ${bucketId})`) 415 | socket.connected = false 416 | this.realtime.emit(`${bucket.public_id}:disconnected`) 417 | 418 | if (keepAliveInterval !== null) { 419 | clearInterval(keepAliveInterval) 420 | keepAliveInterval = null 421 | } 422 | } 423 | 424 | // broadcast in the bus 425 | socket.onmessage = (msg) => { 426 | loggerWS(`Received message for bucket ${bucketId} (${(msg.data.length / 1000).toFixed(1)} Kb)`) 427 | let data = null 428 | try { 429 | data = JSON.parse(msg.data) 430 | } catch (e) { 431 | return loggerWS(`Receive not json message for bucket ${bucketId}`) 432 | } 433 | let packet = data.data[1] 434 | Object.keys(packet).forEach((event) => { 435 | if (event === 'server_name') return 436 | this.realtime.emit(`${bucket.public_id}:${packet.server_name || 'none'}:${event}`, packet[event]) 437 | }) 438 | } 439 | 440 | this._websockets.push(socket) 441 | }).catch(reject) 442 | }) 443 | } 444 | 445 | /** 446 | * Unsubscribe realtime from bucket 447 | * @param {String} bucketId bucket id 448 | * @param {Object} [opts] 449 | * 450 | * @return {Promise} 451 | */ 452 | unsubscribe (bucketId, opts) { 453 | return new Promise((resolve, reject) => { 454 | logger(`Unsubscribe from realtime for ${bucketId}`) 455 | let socket = this._websockets.find(socket => socket.bucket === bucketId) 456 | if (!socket) { 457 | return reject(new Error(`Realtime wasn't connected to ${bucketId}`)) 458 | } 459 | socket.close(1000, 'Disconnecting') 460 | logger(`Succesfully unsubscribed from realtime for ${bucketId}`) 461 | return resolve() 462 | }) 463 | } 464 | } 465 | -------------------------------------------------------------------------------- /docs/global.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Global - Documentation 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |

20 | 21 | 22 | 23 | 24 | 27 | 28 |

29 | 30 |

Global

31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |

39 | 40 |

41 | 42 |

43 | 44 |

45 | 46 | 47 |

48 | 49 |

50 |

51 | 52 | 53 | 54 |

97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 |

Methods

112 | 113 | 114 | 115 | 116 | 117 | 118 |

setupServer(server, bucket, data, ip, cb)

119 | 120 | 121 | 122 | 123 | 124 | 125 |

165 | Used by plans v1 to handle pricing 166 |

167 | 168 | 169 | 170 | 171 | 172 | 173 | 174 | 175 | 176 | 177 | 178 |

Parameters:

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 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 260 | 261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | 283 | 284 | 285 | 286 | 287 | 288 | 289 | 290 | 291 | 292 | 293 | 294 | 295 | 296 | 297 | 298 | 306 | 307 | 308 | 309 | 310 | 311 | 312 | 313 | 314 | 315 | 316 |

Name	Type	Description
`server`	207 \| 208 \| 209 \| Object 210 \| 211 \| 212 \| 213 \|	Bucket's server model
`bucket`	230 \| 231 \| 232 \| Object 233 \| 234 \| 235 \| 236 \|	Bucket model
`data`	253 \| 254 \| 255 \| Object 256 \| 257 \| 258 \| 259 \|	Server metadata
`ip`	276 \| 277 \| 278 \| String 279 \| 280 \| 281 \| 282 \|	Server IP
`cb`	299 \| 300 \| 301 \| function 302 \| 303 \| 304 \| 305 \|	Callback called with

317 | 318 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 329 | 330 | 331 | 332 | 333 | 334 | 335 | 336 | 337 | 338 | 339 |

340 | 341 |

342 | 343 | 344 | 345 | 346 |

347 | 348 |
349 | 350 | 353 | 354 | 355 | 356 | 357 | -------------------------------------------------------------------------------- /docs/Orchestration.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Orchestration - Documentation 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |

20 | 21 | 22 | 23 | 24 | 27 | 28 |

29 | 30 |

Orchestration

31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |

39 | 40 |

41 | 42 |

43 | Orchestration 44 |

45 | 46 | 47 |

48 | 49 |

50 |

51 | 52 | 53 | 54 |

97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 |

Methods

112 | 113 | 114 | 115 | 116 | 117 | 118 |

(route) selfSend()

119 | 120 | 121 | 122 | 123 | 124 | 125 |

165 |

Route:

166 | 167 | 168 | 169 | 170 | 171 | 172 |

Method	Path
POST	/api/bucket/:id/balance

173 | Self balance the bucket to new node 174 |

Authentication

175 |

A authentication is needed to access this endpoint

176 |

Header Parameters:

177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 |

Name	Type	Description
Authorization	String	bearer access token issued for the user

195 |

Response:

196 | 197 | 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 |

Name	Type	Description
migration	Object	is equal true if succesfull

214 |

Response Code:

215 | 216 | 217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 |

Type	Description
500	balancing error
403	already on new node or not premium
200	succesfully balanced the bucket

245 |

246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 | 260 | 261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | 276 | 277 |

278 | 279 |

280 | 281 | 282 | 283 | 284 |

285 | 286 |
287 | 288 | 291 | 292 | 293 | 294 | 295 | -------------------------------------------------------------------------------- /docs/Bucket.server.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | server - Documentation 6 | 7 | 8 | 9 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 |

20 | 21 | 22 | 23 | 24 | 27 | 28 |

29 | 30 |

server

31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |

39 | 40 |

41 | 42 |

43 | Bucket. 44 | 45 | server 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 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 |

99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 |

Methods

114 | 115 | 116 | 117 | 118 | 119 | 120 |

(route) deleteServer(:id)

121 | 122 | 123 | 124 | 125 | 126 | 127 |

128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | 160 | 161 | 162 | 163 | 164 | 165 | 166 |

167 |

Route:

168 | 169 | 170 | 171 | 172 | 173 | 174 |

Method	Path
POST	/api/bucket/:id/data/deleteServer

175 | Delete server 176 |

Authentication

177 |

A authentication is needed to access this endpoint

178 |

Body Parameters:

179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | 196 |

Name	Type	Description
server_name	String	the name of server

197 |

Header Parameters:

198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 |

Name	Type	Description
Authorization	String	bearer access token issued for the user

216 |

Route Parameters:

217 | 218 | 219 | 220 | 221 | 222 | 223 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 |

Name	Type	Description
:id	String	bucket id

235 |

Response:

236 | 237 | 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | 254 | 255 | 256 | 257 | 258 | 259 |

Name	Type	Description
success	Boolean	can be true or false
msg	String	response

260 |

Response Code:

261 | 262 | 263 | 264 | 265 | 266 | 267 | 268 | 269 | 270 | 271 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 279 | 280 | 281 | 282 | 283 | 284 | 285 | 286 | 287 | 288 | 289 | 290 | 291 | 292 | 293 | 294 | 295 | 296 |

Type	Description
500	database error
406	require an action before delete
400	missing or invalid parameters
200	successfully deleted

297 |

298 | 299 | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | 309 |

Parameters:

310 | 311 | 312 | 313 | 314 | 315 | 316 | 317 | 318 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 329 | 330 | 331 | 332 | 333 | 334 | 335 | 336 | 337 | 340 | 341 | 342 | 343 | 344 | 345 | 346 | 347 | 348 | 349 | 350 |

Name	Type	Description
`:id`	338 \| 339 \|	bucket id

351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | 361 | 362 | 363 | 364 | 365 | 366 | 367 | 368 | 369 | 370 | 371 | 372 | 373 |

374 | 375 |

376 | 377 | 378 | 379 | 380 |

381 | 382 |
383 | 384 | 387 | 388 | 389 | 390 | 391 | --------------------------------------------------------------------------------