diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..366d4ba --- /dev/null +++ b/.eslintignore @@ -0,0 +1,4 @@ +.git/* +coverage/* +doc/* +node_modules/* diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..ff6478f --- /dev/null +++ b/.eslintrc @@ -0,0 +1,8 @@ +{ + "extends": "airbnb/base", + "rules": { + "strict": 0, + "valid-jsdoc" : 2, + "no-eval": 0 + } +} diff --git a/Dockerfile b/Dockerfile index 0020ee7..6870963 100644 --- a/Dockerfile +++ b/Dockerfile @@ -15,8 +15,7 @@ ENV NODE_ENV=production \ JIRA_REGEX=([A-Z]{1}[A-Z0-9]+\-[0-9]+) \ JIRA_SPRINT_FIELD= \ SLACK_TOKEN=xoxb-foo \ - SLACK_AUTO_RECONNECT=true \ - SLACK_AUTO_MARK=true + SLACK_AUTO_RECONNECT=true ADD . /usr/src/myapp @@ -24,4 +23,4 @@ WORKDIR /usr/src/myapp RUN ["npm", "install"] -CMD ["npm", "start"] \ No newline at end of file +CMD ["npm", "start"] diff --git a/README.md b/README.md index 4b84010..3cd365c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ This slack bot will listen on any channel it's on for JIRA tickets. It will look ## Install 1. Clone this [repository](https://github.com/shaunburdick/slack-jirabot.git) 2. `npm install` -3. Copy `./release/js/config.default.js` to `./release/js/config.js` and [fill it out](#configjs) +3. Copy `./config.default.js` to `./config.js` and [fill it out](#configjs) 4. `npm start` ## Test @@ -41,7 +41,6 @@ The config file should be filled out as follows: - slack: - token: string, Your slack token - autoReconnect: boolean, Reconnect on disconnect - - autoMark: boolean, Mark messages as read - usermap: - Map a JIRA username to a Slack username @@ -67,7 +66,6 @@ You can set the configuration of the bot by using environment variables. _ENVIRO - _JIRA_SPRINT_FIELD_=, if using greenhopper, set the custom field that holds sprint information (customfield_xxxxx) - _SLACK_TOKEN_=xoxb-foo, Your Slack Token - _SLACK_AUTO_RECONNECT_=true, Reconnect on disconnect -- _SLACK_AUTO_MARK_=true, Mark messages as read Set them using the `-e` flag while running docker: diff --git a/app.js b/app.js new file mode 100644 index 0000000..09e83ec --- /dev/null +++ b/app.js @@ -0,0 +1,35 @@ +'use strict'; + +const logger = require('./lib/logger')(); +const redact = require('redact-object'); +const Bot = require('./lib/bot'); +const Config = require('./lib/config'); + +let bot; +let config; + +/** + * Load config + */ +const rawConfig = (() => { + let retVal; + try { + retVal = require('./config'); + } catch (exception) { + retVal = require('./config.default'); + } + + return retVal; +})(); + +try { + config = Config.parse(rawConfig); +} catch (error) { + logger.error('Could not parse config', error); + process.exit(1); +} + +logger.info('Using the following configuration:', redact(config, ['token', 'pass'])); + +bot = new Bot(config); +bot.start(); diff --git a/config.default.js b/config.default.js new file mode 100644 index 0000000..a490764 --- /dev/null +++ b/config.default.js @@ -0,0 +1,24 @@ +'use strict'; + +const config = { + jira: { + protocol: 'https', + host: 'jira.yourhost.domain', + port: 443, + base: '', + user: 'username', + pass: 'password', + apiVersion: 'latest', + verbose: false, + strictSSL: false, + regex: /([A-Z]{1}[A-Z0-9]+\-[0-9]+)/g, + sprintField: '', + customFields: {}, + }, + slack: { + token: 'xoxb-Your-Token', + autoReconnect: true, + }, + usermap: {}, +}; +module.exports = config; diff --git a/gulpfile.js b/gulpfile.js deleted file mode 100644 index cdcacfb..0000000 --- a/gulpfile.js +++ /dev/null @@ -1,32 +0,0 @@ -var gulp = require('gulp'); -var ts = require('gulp-typescript'); -var del = require('del'); -var watch = require('gulp-watch'); -var batch = require('gulp-batch') - -gulp.task('default', ['build', 'watch']); - -gulp.task('build', ['clean'], function() { - var tsResult = gulp.src('src/**/*.ts') - .pipe(ts({ - // noImplicitAny: true, - noEmitOnError: true, - target: 'ES5', - module: 'commonjs' - })); - - return tsResult.js.pipe(gulp.dest('release/js')); -}); - -gulp.task('clean', function(cb) { - del([ - 'release/**/*', - '!release/js/config.js' - ], cb); -}); - -gulp.task('watch', function() { - watch('src/**/*', batch(function(ev, done) { - gulp.start('build', done); - })); -}); \ No newline at end of file diff --git a/lib/bot.js b/lib/bot.js new file mode 100644 index 0000000..3d34da8 --- /dev/null +++ b/lib/bot.js @@ -0,0 +1,391 @@ +'use strict'; + +const JiraApi = require('jira').JiraApi; +const Botkit = require('botkit'); +const moment = require('moment'); +const logger = require('./logger')(); + +/** + * @module Bot + */ +class Bot { + /** + * Constructor. + * + * @constructor + * @param {Config} config The final configuration for the bot + */ + constructor(config) { + this.config = config; + /* hold tickets and last time responded to */ + this.ticketBuffer = new Map(); + + /* Length of buffer to prevent ticket from being responded to */ + this.TICKET_BUFFER_LENGTH = 300000; + + this.controller = Botkit.slackbot(); + + this.jira = new JiraApi( + config.jira.protocol, + config.jira.host, + config.jira.port, + config.jira.user, + config.jira.pass, + config.jira.apiVersion, + config.jira.verbose, + config.jira.strictSSL, + null, + config.jira.base + ); + } + + /** + * Build a response string about an issue. + * + * @param {Issue} issue the issue object returned by JIRA + * @return {Attachment} The response attachment. + */ + issueResponse(issue) { + const response = { + fallback: `No summary found for ${issue.key}`, + }; + const created = moment(issue.fields.created); + const updated = moment(issue.fields.updated); + + response.text = this.formatIssueDescription(issue.fields.description); + response.mrkdwn_in = ['text']; // Parse text as markdown + response.fallback = issue.fields.summary; + response.pretext = `Here is some information on ${issue.key}`; + response.title = issue.fields.summary; + response.title_link = this.buildIssueLink(issue.key); + response.fields = []; + response.fields.push({ + title: 'Created', + value: created.calendar(), + short: true, + }); + response.fields.push({ + title: 'Updated', + value: updated.calendar(), + short: true, + }); + response.fields.push({ + title: 'Status', + value: issue.fields.status.name, + short: true, + }); + response.fields.push({ + title: 'Priority', + value: issue.fields.priority.name, + short: true, + }); + response.fields.push({ + title: 'Reporter', + value: (this.jira2Slack(issue.fields.reporter.name) || issue.fields.reporter.displayName), + short: true, + }); + let assignee = 'Unassigned'; + if (issue.fields.assignee) { + assignee = (this.jira2Slack(issue.fields.assignee.name) || issue.fields.assignee.displayName); + } + response.fields.push({ + title: 'Assignee', + value: assignee, + short: true, + }); + // Sprint fields + if (this.config.jira.sprintField) { + response.fields.push({ + title: 'Sprint', + value: (this.parseSprint(issue.fields[this.config.jira.sprintField]) || 'Not Assigned'), + short: false, + }); + } + // Custom fields + if (this.config.jira.customFields && Object.keys(this.config.jira.customFields).length) { + for (const customField in this.config.jira.customFields) { + if (this.config.jira.customFields.hasOwnProperty(customField)) { + let fieldVal = null; + // Do some simple guarding before eval + if (!/[;&\|\(\)]/.test(customField)) { + try { + fieldVal = eval(`issue.fields.${customField}`); + } catch (e) { + fieldVal = `Error while reading ${customField}`; + } + } else { + fieldVal = `Invalid characters in ${customField}`; + } + fieldVal = fieldVal || `Unable to read ${customField}`; + response.fields.push({ + title: this.config.jira.customFields[customField], + value: fieldVal, + short: false, + }); + } + } + } + return response; + } + + /** + * Format a ticket description for display. + * * Truncate to 1000 characters + * * Replace any {quote} with ``` + * * If there is no description, add a default value + * + * @param {string} description The raw description + * @return {string} the formatted description + */ + formatIssueDescription(description) { + const desc = description || 'Ticket does not contain a description'; + return desc.replace(/\{(quote|code)\}/g, '```'); + } + + /** + * Construct a link to an issue based on the issueKey and config + * + * @param {string} issueKey The issueKey for the issue + * @return {string} The constructed link + */ + buildIssueLink(issueKey) { + let base = '/browse/'; + if (this.config.jira.base) { + // Strip preceeding and trailing forward slash + base = '/' + this.config.jira.base.replace(/^\/|\/$/g, '') + base; + } + return this.config.jira.protocol + '://' + + this.config.jira.host + ':' + this.config.jira.port + + base + issueKey; + } + + /** + * Parses the sprint name of a ticket. + * If the ticket is in more than one sprint + * A. Shame on you + * B. This will take the last one + * + * @param {string[]} customField The contents of the greenhopper custom field + * @return {string} The name of the sprint or '' + */ + parseSprint(customField) { + let retVal = ''; + if (customField && customField.length > 0) { + const sprintString = customField.pop(); + const matches = sprintString.match(/\,name=([^,]+)\,/); + if (matches && matches[1]) { + retVal = matches[1]; + } + } + return retVal; + } + + /** + * Lookup a JIRA username and return their Slack username + * Meh... Trying to come up with a better system for this feature + * + * @param {string} username the JIRA username + * @return {string} The slack username or '' + */ + jira2Slack(username) { + let retVal = ''; + if (this.config.usermap[username]) { + retVal = `@${this.config.usermap[username]}`; + } + return retVal; + } + + /** + * Parse out JIRA tickets from a message. + * This will return unique tickets that haven't been + * responded with recently. + * + * @param {string} channel the channel the message came from + * @param {string} message the message to search in + * @return {string[]} an array of tickets, empty if none found + */ + parseTickets(channel, message) { + const retVal = []; + if (!channel || !message) { + return retVal; + } + const uniques = {}; + const found = message.match(this.config.jira.regex); + const now = Date.now(); + let ticketHash; + if (found && found.length) { + found.forEach((ticket) => { + ticketHash = this.hashTicket(channel, ticket); + if ( + !uniques.hasOwnProperty(ticket) + && (now - (this.ticketBuffer.get(ticketHash) || 0) > this.TICKET_BUFFER_LENGTH) + ) { + retVal.push(ticket); + uniques[ticket] = 1; + this.ticketBuffer.set(ticketHash, now); + } + }); + } + return retVal; + } + + /** + * Hashes the channel + ticket combo. + * + * @param {string} channel The name of the channel + * @param {string} ticket The name of the ticket + * @return {string} The unique hash + */ + hashTicket(channel, ticket) { + return channel + '-' + ticket; + } + + /** + * Remove any tickets from the buffer if they are past the length + * + * @return {null} nada + */ + cleanupTicketBuffer() { + const now = Date.now(); + logger.debug('Cleaning Ticket Buffer'); + this.ticketBuffer.forEach((time, key) => { + if (now - time > this.TICKET_BUFFER_LENGTH) { + logger.debug(`Deleting ${key}`); + this.ticketBuffer.delete(key); + } + }); + } + + /** + * Function to be called on slack open + * + * @param {object} payload Connection payload + * @return {Bot} returns itself + */ + slackOpen(payload) { + const channels = []; + const groups = []; + const mpims = []; + + logger.info(`Welcome to Slack. You are @${payload.self.name} of ${payload.team.name}`); + + if (payload.channels) { + payload.channels.forEach((channel) => { + if (channel.is_member) { + channels.push(`#${channel.name}`); + } + }); + + logger.info(`You are in: ${channels.join(', ')}`); + } + + if (payload.groups) { + payload.groups.forEach((group) => { + groups.push(`${group.name}`); + }); + + logger.info(`Groups: ${groups.join(', ')}`); + } + + if (payload.mpims) { + payload.mpims.forEach((mpim) => { + mpims.push(`${mpim.name}`); + }); + + logger.info(`Multi-person IMs: ${mpims.join(', ')}`); + } + + return this; + } + + /** + * Handle an incoming message + * @param {object} message The incoming message from Slack + * @returns {null} nada + */ + handleMessage(message) { + const response = { + as_user: true, + attachments: [], + }; + + if (message.type === 'message' && message.text) { + const found = this.parseTickets(message.channel, message.text); + if (found && found.length) { + logger.info(`Detected ${found.join(',')}`); + found.forEach((issueId) => { + this.jira.findIssue(issueId, (error, issue) => { + if (!error) { + response.attachments = [this.issueResponse(issue)]; + this.bot.reply(message, response, (err) => { + if (err) { + logger.error('Unable to respond', err); + } else { + logger.info(`@${this.slack.identity.name} responded with`, response); + } + }); + } else { + logger.error(`Got an error trying to find ${issueId}`, error); + } + }); + }); + } else { + // nothing to do + } + } else { + logger.info(`@${this.bot.identity.name} could not respond.`); + } + } + + /** + * Start the bot + * + * @return {Bot} returns itself + */ + start() { + this.controller.on( + 'direct_mention,mention,ambient', + (bot, message) => { + this.handleMessage(message); + } + ); + + this.controller.on('rtm_close', () => { + logger.info('The RTM api just closed'); + + if (this.config.slack.autoReconnect) { + this.connect(); + } + }); + + this.connect(); + + setInterval(() => { + this.cleanupTicketBuffer(); + }, 60000); + + return this; + } + + /** + * Connect to the RTM + * @return {Bot} this + */ + connect() { + this.bot = this.controller.spawn({ + token: this.config.slack.token, + no_unreads: true, + mpim_aware: true, + }).startRTM((err, bot, payload) => { + if (err) { + logger.error('Error starting bot!', err); + } + + this.slackOpen(payload); + }); + + return this; + } +} + +module.exports = Bot; diff --git a/lib/config.js b/lib/config.js new file mode 100644 index 0000000..5c4949f --- /dev/null +++ b/lib/config.js @@ -0,0 +1,53 @@ +'use strict'; + +/** + * Parse a boolean from a string + * + * @param {string} string A string to parse into a boolean + * @return {mixed} Either a boolean or the original value + */ +function parseBool(string) { + if (typeof string === 'string') { + return /^(true|1)$/i.test(string); + } + + return string; +} + +/** + * Parses and enhances config object + * + * @param {object} config the raw object from file + * @return {object} the paresed config object + * @throws Error if it cannot parse object + */ +function parse(config) { + if (typeof config !== 'object') { + throw new Error('Config is not an object'); + } + + /** + * Pull config from ENV if set + */ + config.jira.protocol = process.env.JIRA_PROTOCOL || config.jira.protocol; + config.jira.host = process.env.JIRA_HOST || config.jira.host; + config.jira.port = parseInt(process.env.JIRA_PORT, 10) || config.jira.port; + config.jira.base = process.env.JIRA_BASE || config.jira.base; + config.jira.user = process.env.JIRA_USER || config.jira.user; + config.jira.pass = process.env.JIRA_PASS || config.jira.pass; + config.jira.apiVersion = process.env.JIRA_API_VERSION || config.jira.apiVersion; + config.jira.verbose = parseBool(process.env.JIRA_VERBOSE) || config.jira.verbose; + config.jira.strictSSL = parseBool(process.env.JIRA_STRICT_SSL) || config.jira.strictSSL; + config.jira.regex = process.env.JIRA_REGEX ? new RegExp(process.env.JIRA_REGEX, 'g') : config.jira.regex; + config.jira.sprintField = process.env.JIRA_SPRINT_FIELD || config.jira.sprintField; + + config.slack.token = process.env.SLACK_TOKEN || config.slack.token; + config.slack.autoReconnect = parseBool(process.env.SLACK_AUTO_RECONNECT) || config.slack.autoReconnect; + + return config; +} + +module.exports = { + parse, + parseBool, +}; diff --git a/lib/logger.js b/lib/logger.js new file mode 100644 index 0000000..59cb50b --- /dev/null +++ b/lib/logger.js @@ -0,0 +1,23 @@ +'use strict'; + +const winston = require('winston'); + +/** + * Returns a function that will generate a preconfigured instance of winston. + * + * @return {function} A preconfigured instance of winston + */ +module.exports = () => { + const logger = new winston.Logger({ + transports: [ + new (winston.transports.Console)({ + timestamp: true, + prettyPrint: true, + handleExceptions: true, + }), + ], + }); + logger.cli(); + + return logger; +}; diff --git a/package.json b/package.json index 0d16981..dec45e4 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,14 @@ { "name": "slack-jirabot", - "version": "1.4.0", + "version": "2.0.0", "description": "Slackbot for interacting with JIRA", - "main": "release/js/app.js", + "main": "app.js", "private": true, "scripts": { - "start": "node release/js/app.js", - "test": "node_modules/.bin/jasmine-node release/js/spec --verbose --captureExceptions" + "start": "node app.js", + "test": "npm run unit", + "unit": "faucet", + "lint": "eslint ." }, "author": "Shaun Burdick ", "homepage": "http://github.com/shaunburdick/slack-jirabot", @@ -15,18 +17,21 @@ "url": "http://github.com/shaunburdick/slack-jirabot.git" }, "license": "ISC", + "engine": { + "node": "^5.1.0" + }, "dependencies": { - "jira": "git://github.com/shaunburdick/node-jira.git", + "botkit": "0.0.4", + "jira": "^0.9.2", "moment": "^2.10.3", - "slack-client": "^1.4.1", - "winston": "^1.0.0" + "redact-object": "^1.0.1", + "winston": "^2.1.1" }, "devDependencies": { - "del": "^1.2.0", - "gulp": "^3.9.0", - "gulp-batch": "^1.0.5", - "gulp-typescript": "^2.8.3", - "gulp-watch": "^4.2.4", - "jasmine-node": "^1.14.5" + "babel-eslint": "^4.1.6", + "blue-tape": "^0.1.11", + "eslint": "^1.10.3", + "eslint-config-airbnb": "^2.1.1", + "faucet": "0.0.1" } } diff --git a/release/js/app.js b/release/js/app.js deleted file mode 100644 index fa086d2..0000000 --- a/release/js/app.js +++ /dev/null @@ -1,33 +0,0 @@ -/// -var logger = require('./lib/logger'); -var Bot = require('./lib/bot'); -var config = (function () { - var retVal; - try { - retVal = require('./config'); - } - catch (e) { - retVal = require('./config.default'); - } - return retVal; -}()); -/** - * Pull config from ENV if set - */ -config.jira.protocol = process.env.JIRA_PROTOCOL || config.jira.protocol; -config.jira.host = process.env.JIRA_HOST || config.jira.host; -config.jira.port = process.env.JIRA_PORT || config.jira.port; -config.jira.base = process.env.JIRA_BASE || config.jira.base; -config.jira.user = process.env.JIRA_USER || config.jira.user; -config.jira.pass = process.env.JIRA_PASS || config.jira.pass; -config.jira.apiVersion = process.env.JIRA_API_VERSION || config.jira.apiVersion; -config.jira.verbose = process.env.JIRA_VERBOSE || config.jira.verbose; -config.jira.strictSSL = process.env.JIRA_STRICT_SSL || config.jira.strictSSL; -config.jira.regex = process.env.JIRA_REGEX ? new RegExp(process.env.JIRA_REGEX, 'g') : config.jira.regex; -config.jira.sprintField = process.env.JIRA_SPRINT_FIELD || config.jira.sprintField; -config.slack.token = process.env.SLACK_TOKEN || config.slack.token; -config.slack.autoReconnect = process.env.SLACK_AUTO_RECONNECT || config.slack.autoReconnect; -config.slack.autoMark = process.env.SLACK_AUTO_MARK || config.slack.autoMark; -logger.info("Using the following configuration:", config); -var bot = new Bot(config); -bot.start(); diff --git a/release/js/config.default.js b/release/js/config.default.js deleted file mode 100644 index 913ab3d..0000000 --- a/release/js/config.default.js +++ /dev/null @@ -1,23 +0,0 @@ -var config = { - jira: { - protocol: 'https', - host: 'jira.yourhost.domain', - port: 443, - base: '', - user: 'username', - pass: 'password', - apiVersion: 'latest', - verbose: false, - strictSSL: false, - regex: /([A-Z]{1}[A-Z0-9]+\-[0-9]+)/g, - sprintField: '', - customFields: {} - }, - slack: { - token: 'xoxb-Your-Token', - autoReconnect: true, - autoMark: true // Mark messages as read - }, - usermap: {} -}; -module.exports = config; diff --git a/release/js/lib/AttachmentInterface.js b/release/js/lib/AttachmentInterface.js deleted file mode 100644 index 73e06b9..0000000 --- a/release/js/lib/AttachmentInterface.js +++ /dev/null @@ -1 +0,0 @@ -/// diff --git a/release/js/lib/ConfigInterface.js b/release/js/lib/ConfigInterface.js deleted file mode 100644 index 73e06b9..0000000 --- a/release/js/lib/ConfigInterface.js +++ /dev/null @@ -1 +0,0 @@ -/// diff --git a/release/js/lib/bot.js b/release/js/lib/bot.js deleted file mode 100644 index 217a395..0000000 --- a/release/js/lib/bot.js +++ /dev/null @@ -1,322 +0,0 @@ -/// -var JiraApi = require('jira').JiraApi, Slack = require('slack-client'); -var moment = require('moment'); -var logger = require('./logger'); -var Bot = (function () { - /** - * Constructor. - * - * @param {Config} config The final configuration for the bot - */ - function Bot(config) { - this.config = config; - /* hold tickets and last time responded to */ - this.ticketBuffer = {}; - /* Length of buffer to prevent ticket from being responded to */ - this.TICKET_BUFFER_LENGTH = 300000; - this.slack = new Slack(config.slack.token, config.slack.autoReconnect, config.slack.autoMark); - this.jira = new JiraApi(config.jira.protocol, config.jira.host, config.jira.port, config.jira.user, config.jira.pass, config.jira.apiVersion, config.jira.verbose, config.jira.strictSSL, null, config.jira.base); - } - /** - * Build a response string about an issue. - * - * @param {Issue} issue the issue object returned by JIRA - * @return {Attachment} The response attachment. - */ - Bot.prototype.issueResponse = function (issue) { - var response = { - fallback: "No summary found for " + issue.key - }; - var created = moment(issue['fields']['created']); - var updated = moment(issue['fields']['updated']); - response.text = this.formatIssueDescription(issue['fields']['description']); - response.mrkdwn_in = ['text']; // Parse text as markdown - response.fallback = issue['fields']['summary']; - response.pretext = "Here is some information on " + issue.key; - response.title = issue['fields']['summary']; - response.title_link = this.buildIssueLink(issue.key); - response.fields = []; - response.fields.push({ - title: "Created", - value: created.calendar(), - short: true - }); - response.fields.push({ - title: "Updated", - value: updated.calendar(), - short: true - }); - response.fields.push({ - title: "Status", - value: issue['fields']['status']['name'], - short: true - }); - response.fields.push({ - title: "Priority", - value: issue['fields']['priority']['name'], - short: true - }); - response.fields.push({ - title: "Reporter", - value: (this.JIRA2Slack(issue['fields']['reporter'].name) || issue['fields']['reporter'].displayName), - short: true - }); - var assignee = 'Unassigned'; - if (issue['fields']['assignee']) { - assignee = (this.JIRA2Slack(issue['fields']['assignee'].name) || issue['fields']['assignee'].displayName); - } - response.fields.push({ - title: "Assignee", - value: assignee, - short: true - }); - // Sprint fields - if (this.config.jira.sprintField) { - response.fields.push({ - title: "Sprint", - value: (this.parseSprint(issue['fields'][this.config.jira.sprintField]) || 'Not Assigned'), - short: false - }); - } - // Custom fields - if (this.config.jira.customFields && Object.keys(this.config.jira.customFields).length) { - for (var customField in this.config.jira.customFields) { - var fieldVal = null; - // Do some simple guarding before eval - if (!/[;&\|\(\)]/.test(customField)) { - try { - fieldVal = eval("issue.fields." + customField); - } - catch (e) { - fieldVal = "Error while reading " + customField; - } - } - else { - fieldVal = "Invalid characters in " + customField; - } - fieldVal = fieldVal || "Unable to read " + customField; - response.fields.push({ - title: this.config.jira.customFields[customField], - value: fieldVal, - short: false - }); - } - } - return response; - }; - /** - * Format a ticket description for display. - * * Truncate to 1000 characters - * * Replace any {quote} with ``` - * * If there is no description, add a default value - * - * @param string description The raw description - * @return string the formatted description - */ - Bot.prototype.formatIssueDescription = function (description) { - if (!description) { - description = 'Ticket does not contain a description'; - } - return description - .replace(/\{(quote|code)\}/g, '```'); - }; - /** - * Construct a link to an issue based on the issueKey and config - * - * @param string issueKey The issueKey for the issue - * @return string The constructed link - */ - Bot.prototype.buildIssueLink = function (issueKey) { - var base = '/browse/'; - if (this.config.jira.base) { - // Strip preceeding and trailing forward slash - base = '/' + this.config.jira.base.replace(/^\/|\/$/g, '') + base; - } - return this.config.jira.protocol + '://' - + this.config.jira.host + ':' + this.config.jira.port - + base + issueKey; - }; - /** - * Parses the sprint name of a ticket. - * If the ticket is in more than one sprint - * A. Shame on you - * B. This will take the last one - * - * @param string[] customField The contents of the greenhopper custom field - * @return string The name of the sprint or '' - */ - Bot.prototype.parseSprint = function (customField) { - var retVal = ''; - if (customField && customField.length > 0) { - var sprintString = customField.pop(); - var matches = sprintString.match(/\,name=([^,]+)\,/); - if (matches && matches[1]) { - retVal = matches[1]; - } - } - return retVal; - }; - /** - * Lookup a JIRA username and return their Slack username - * Meh... Trying to come up with a better system for this feature - * - * @param string username the JIRA username - * @return string The slack username or '' - */ - Bot.prototype.JIRA2Slack = function (username) { - var retVal = ''; - if (this.config.usermap[username]) { - retVal = "@" + this.config.usermap[username]; - } - return retVal; - }; - /** - * Parse out JIRA tickets from a message. - * This will return unique tickets that haven't been - * responded with recently. - * - * @param string channel the channel the message came from - * @param string message the message to search in - * @return string[] an array of tickets, empty if none found - */ - Bot.prototype.parseTickets = function (channel, message) { - var retVal = []; - if (!channel || !message) { - return retVal; - } - var uniques = {}; - var found = message.match(this.config.jira.regex); - var now = Date.now(); - var ticketHash; - if (found && found.length) { - for (var x in found) { - ticketHash = this.hashTicket(channel, found[x]); - if (!uniques.hasOwnProperty(found[x]) - && (!this.ticketBuffer.hasOwnProperty(ticketHash) - || (now - this.ticketBuffer[ticketHash]) > this.TICKET_BUFFER_LENGTH)) { - retVal.push(found[x]); - uniques[found[x]] = 1; - this.ticketBuffer[ticketHash] = now; - } - } - } - return retVal; - }; - /** - * Hashes the channel + ticket combo. - * - * @param string channel The name of the channel - * @param string ticket The name of the ticket - * @return string The unique hash - */ - Bot.prototype.hashTicket = function (channel, ticket) { - return channel + "-" + ticket; - }; - /** - * Remove any tickets from the buffer if they are past the length - */ - Bot.prototype.cleanupTicketBuffer = function () { - var now = Date.now(); - for (var x in this.ticketBuffer) { - if (now - this.ticketBuffer[x] > this.TICKET_BUFFER_LENGTH) { - delete this.ticketBuffer[x]; - } - } - }; - /** - * Function to be called on slack open - */ - Bot.prototype.slackOpen = function () { - var unreads = this.slack.getUnreadCount(); - var id; - var channels = []; - var allChannels = this.slack.channels; - for (id in allChannels) { - if (allChannels[id].is_member) { - channels.push("#" + allChannels[id].name); - } - } - var groups = []; - var allGroups = this.slack.groups; - for (id in allGroups) { - if (allGroups[id].is_open && !allGroups[id].is_archived) { - groups.push(allGroups[id].name); - } - } - logger.info("Welcome to Slack. You are @" + this.slack.self.name + " of " + this.slack.team.name); - logger.info("You are in: " + channels.join(', ')); - logger.info("As well as: " + groups.join(', ')); - var messages = unreads === 1 ? 'message' : 'messages'; - logger.info("You have " + unreads + " unread " + messages); - }; - /** - * Handle an incoming message - * @param object message The incoming message from Slack - */ - Bot.prototype.handleMessage = function (message) { - var self = this; - var channel = this.slack.getChannelGroupOrDMByID(message.channel); - var user = this.slack.getUserByID(message.user); - var response = { - "as_user": true, - "attachments": [] - }; - var type = message.type, ts = message.ts, text = message.text; - var channelName = (channel && channel.is_channel) ? '#' : ''; - channelName = channelName + (channel ? channel.name : 'UNKNOWN_CHANNEL'); - var userName = (user && user.name) ? "@" + user.name : "UNKNOWN_USER"; - if (type === 'message' && (text !== null) && (channel !== null)) { - var found = this.parseTickets(channelName, text); - if (found && found.length) { - logger.info("Detected " + found.join(',') + " from " + userName + " in " + channelName); - for (var x in found) { - this.jira.findIssue(found[x], function (error, issue) { - if (!error) { - response.attachments = [self.issueResponse(issue)]; - var result = channel.postMessage(response); - if (result) { - logger.info("@" + self.slack.self.name + " responded with:", response); - } - else { - logger.error('It appears we are disconnected'); - } - } - else { - logger.error("Got an error trying to find " + found[x], error); - } - }); - } - } - else { - } - } - else { - var typeError = type !== 'message' ? "unexpected type " + type + "." : null; - var textError = text === null ? 'text was undefined.' : null; - var channelError = channel === null ? 'channel was undefined.' : null; - var errors = [typeError, textError, channelError].filter(function (element) { - return element !== null; - }).join(' '); - logger.info("@" + this.slack.self.name + " could not respond. " + errors); - } - }; - /** - * Start the bot - */ - Bot.prototype.start = function () { - var self = this; - this.slack.on('open', function () { - self.slackOpen(); - }); - this.slack.on('message', function (message) { - self.handleMessage(message); - }); - this.slack.on('error', function (error) { - logger.error("Error: %s", error); - }); - setInterval(this.cleanupTicketBuffer, 60000); - this.slack.login(); - }; - return Bot; -})(); -module.exports = Bot; diff --git a/release/js/lib/logger.js b/release/js/lib/logger.js deleted file mode 100644 index e9a2904..0000000 --- a/release/js/lib/logger.js +++ /dev/null @@ -1,13 +0,0 @@ -/// -var winston = require('winston'); -var logger = new winston.Logger({ - transports: [ - new (winston.transports.Console)({ - timestamp: true, - prettyPrint: true, - handleExceptions: true - }) - ] -}); -logger.cli(); -module.exports = logger; diff --git a/release/js/spec/bot.spec.js b/release/js/spec/bot.spec.js deleted file mode 100644 index f43fa55..0000000 --- a/release/js/spec/bot.spec.js +++ /dev/null @@ -1,205 +0,0 @@ -/// -var Bot = require('../lib/bot'); -var config_dist = require('../config.default.js'); -describe('Bot', function () { - var config; - beforeEach(function () { - // reset the configuration - config = config_dist; - }); - it('should instantiate and set config', function () { - var bot = new Bot(config); - expect(bot.config).toEqual(config); - }); - describe('Parse/Build Issues', function () { - it('should build issue links correctly', function () { - var bot = new Bot(config); - var issueKey = 'TEST-1'; - var expectedLink = 'https://jira.yourhost.domain:443/browse/' + issueKey; - expect(bot.buildIssueLink(issueKey)).toEqual(expectedLink); - }); - it('should build issue links correctly with base', function () { - config.jira.base = 'foo'; - var bot = new Bot(config); - var issueKey = 'TEST-1'; - var expectedLink = 'https://jira.yourhost.domain:443/foo/browse/' + issueKey; - expect(bot.buildIssueLink(issueKey)).toEqual(expectedLink); - }); - }); - describe('Parsing Fields', function () { - it('should parse a sprint name from greenhopper field', function () { - var bot = new Bot(config); - var sprintName = 'TEST'; - var exampleSprint = [ - 'derpry-derp-derp,name=' + sprintName + ',foo' - ]; - expect(bot.parseSprint(exampleSprint)).toEqual(sprintName); - expect(bot.parseSprint(['busted'])).toBeFalsy(); - }); - it('should parse a sprint name from the last sprint in the greenhopper field', function () { - var bot = new Bot(config); - var sprintName = 'TEST'; - var exampleSprint = [ - 'derpry-derp-derp,name=' + sprintName + '1,foo', - 'derpry-derp-derp,name=' + sprintName + '2,foo', - 'derpry-derp-derp,name=' + sprintName + '3,foo', - ]; - expect(bot.parseSprint(exampleSprint)).toEqual(sprintName + '3'); - }); - it('should translate a jira username to a slack username', function () { - config.usermap = { - 'foo': 'bar', - 'fizz': 'buzz', - 'ping': 'pong' - }; - var bot = new Bot(config); - expect(bot.JIRA2Slack('foo')).toEqual('@bar'); - expect(bot.JIRA2Slack('ping')).toEqual('@pong'); - expect(bot.JIRA2Slack('blap')).toBeFalsy(); - }); - it('should parse unique jira tickets from a message', function () { - var bot = new Bot(config); - expect(bot.parseTickets('Chan', 'blarty blar TEST-1')).toEqual(['TEST-1']); - expect(bot.parseTickets('Chan', 'blarty blar TEST-2 TEST-2')).toEqual(['TEST-2']); - expect(bot.parseTickets('Chan', 'blarty blar TEST-3 TEST-4')).toEqual(['TEST-3', 'TEST-4']); - expect(bot.parseTickets('Chan', 'blarty blar Test-1 Test-1')).toEqual([]); - }); - it('should handle empty message/channel', function () { - var bot = new Bot(config); - expect(bot.parseTickets('Chan', null)).toEqual([]); - expect(bot.parseTickets(null, 'Foo')).toEqual([]); - }); - }); - describe('Ticket Buffering', function () { - it('should populate the ticket buffer', function () { - var bot = new Bot(config); - var ticket = 'TEST-1'; - var channel = 'Test'; - var hash = bot.hashTicket(channel, ticket); - expect(bot.parseTickets(channel, 'foo ' + ticket)).toEqual([ticket]); - expect(bot.ticketBuffer.hasOwnProperty(hash)).toBeTruthy(); - // Expect the ticket to not be repeated - expect(bot.parseTickets(channel, 'foo ' + ticket)).toEqual([]); - }); - it('should respond to the same ticket in different channels', function () { - var bot = new Bot(config); - var ticket = 'TEST-1'; - var channel1 = 'Test1'; - var channel2 = 'Test2'; - expect(bot.parseTickets(channel1, 'foo ' + ticket)).toEqual([ticket]); - expect(bot.parseTickets(channel2, 'foo ' + ticket)).toEqual([ticket]); - }); - it('should cleanup the ticket buffer', function () { - var bot = new Bot(config); - var ticket = 'TEST-1'; - var channel = 'Test'; - var hash = bot.hashTicket(channel, ticket); - expect(bot.parseTickets(channel, 'foo ' + ticket)).toEqual([ticket]); - expect(bot.ticketBuffer.hasOwnProperty(hash)).toBeTruthy(); - // set the Ticket Buffer Length low to trigger the cleanup - bot.TICKET_BUFFER_LENGTH = -1; - bot.cleanupTicketBuffer(); - expect(bot.ticketBuffer.hasOwnProperty(hash)).toBeFalsy(); - }); - }); - describe("Issue Response", function () { - var issue; - beforeEach(function () { - issue = { - key: 'TEST-1', - fields: { - created: '2015-05-01T00:00:00.000', - updated: '2015-05-01T00:01:00.000', - summary: 'Blarty', - description: 'Foo foo foo foo foo foo', - status: { - name: 'Open' - }, - priority: { - name: 'Low' - }, - reporter: { - name: 'bob', - displayName: 'Bob' - }, - assignee: { - name: 'fred', - displayName: 'Fred' - }, - customfield_10000: 'Fizz', - customfield_10001: [ - { value: 'Buzz' } - ] - } - }; - }); - it('should return a default description if empty', function () { - var bot = new Bot(config); - expect(bot.formatIssueDescription('')).toEqual('Ticket does not contain a description'); - }); - it('should replace quotes', function () { - var bot = new Bot(config); - expect(bot.formatIssueDescription('{quote}foo{quote}')) - .toEqual('```foo```'); - }); - it('should replace code blocks', function () { - var bot = new Bot(config); - expect(bot.formatIssueDescription('{code}foo{code}')) - .toEqual('```foo```'); - }); - it('should show custom fields', function () { - var tests = { - cf1: false, - cf2: false, - nope1: false, - nope2: false, - nope3: false - }; - var expected = { - cf1: true, - cf2: true, - nope1: true, - nope2: true, - nope3: true - }; - // Add some custom fields - config.jira.customFields['customfield_10000'] = 'CF1'; - config.jira.customFields['customfield_10001[0].value'] = 'CF2'; - config.jira.customFields['customfield_10003 && exit()'] = 'Nope1'; - config.jira.customFields['customfield_10004; exit()'] = 'Nope2'; - config.jira.customFields['customfield_10005'] = 'Nope3'; - var bot = new Bot(config); - var response = bot.issueResponse(issue); - for (var x in response.fields) { - switch (response.fields[x].title) { - case config.jira.customFields['customfield_10000']: - if (response.fields[x].value == issue.fields['customfield_10000']) { - tests.cf1 = true; - } - break; - case config.jira.customFields['customfield_10001[0].value']: - if (response.fields[x].value == issue.fields['customfield_10001'][0].value) { - tests.cf2 = true; - } - break; - case config.jira.customFields['customfield_10003 && exit()']: - if (response.fields[x].value == 'Invalid characters in customfield_10003 && exit()') { - tests.nope1 = true; - } - break; - case config.jira.customFields['customfield_10004; exit()']: - if (response.fields[x].value == 'Invalid characters in customfield_10004; exit()') { - tests.nope2 = true; - } - break; - case config.jira.customFields['customfield_10005']: - if (response.fields[x].value == 'Unable to read customfield_10005') { - tests.nope3 = true; - } - break; - } - } - expect(tests).toEqual(expected); - }); - }); -}); diff --git a/src/app.ts b/src/app.ts deleted file mode 100644 index 875df4d..0000000 --- a/src/app.ts +++ /dev/null @@ -1,42 +0,0 @@ -/// - -import Config = require('./lib/ConfigInterface'); -import logger = require('./lib/logger'); -import Bot = require('./lib/bot'); - -var config: Config = (function() { - var retVal: Config; - - try { // local config first - retVal = require('./config'); - } catch (e) { // default config - retVal = require('./config.default'); - } - - return retVal; -}()); - -/** - * Pull config from ENV if set - */ -config.jira.protocol = process.env.JIRA_PROTOCOL || config.jira.protocol; -config.jira.host = process.env.JIRA_HOST || config.jira.host; -config.jira.port = process.env.JIRA_PORT || config.jira.port; -config.jira.base = process.env.JIRA_BASE || config.jira.base; -config.jira.user = process.env.JIRA_USER || config.jira.user; -config.jira.pass = process.env.JIRA_PASS || config.jira.pass; -config.jira.apiVersion = process.env.JIRA_API_VERSION || config.jira.apiVersion; -config.jira.verbose = process.env.JIRA_VERBOSE || config.jira.verbose; -config.jira.strictSSL = process.env.JIRA_STRICT_SSL || config.jira.strictSSL; -config.jira.regex = process.env.JIRA_REGEX ? new RegExp(process.env.JIRA_REGEX, 'g') : config.jira.regex; -config.jira.sprintField = process.env.JIRA_SPRINT_FIELD || config.jira.sprintField; - -config.slack.token = process.env.SLACK_TOKEN || config.slack.token; -config.slack.autoReconnect = process.env.SLACK_AUTO_RECONNECT || config.slack.autoReconnect; -config.slack.autoMark = process.env.SLACK_AUTO_MARK || config.slack.autoMark; - -logger.info("Using the following configuration:", config); - -var bot = new Bot(config); - -bot.start(); \ No newline at end of file diff --git a/src/config.default.ts b/src/config.default.ts deleted file mode 100644 index eaa03ba..0000000 --- a/src/config.default.ts +++ /dev/null @@ -1,34 +0,0 @@ -import Config = require('./lib/ConfigInterface'); - -var config: Config = { - jira: { - protocol: 'https', // https or http - host: 'jira.yourhost.domain', // Hostname for JIRA - port: 443, // Usually 80 or 443 - base: '', // If JIRA doesn't sit at the root, put its base directory here - user: 'username', // Username of JIRA user - pass: 'password', // Password of JIRA user - apiVersion: 'latest', // API Version slug - verbose: false, // Verbose logging - strictSSL: false, // Set false for self-signed certificates - regex: /([A-Z]{1}[A-Z0-9]+\-[0-9]+)/g, // The regex to match JIRA Tickets - sprintField: '', // If using greenhopper, set the custom field that holds sprint information (customfield_1xxxx) - customFields: { - // Add any custom fields you would like to display - // customfield_1xxxx: "Custom Title" - // Object custom field: Show a member of object - // "customfield_1xxxx.member": "Custom Title" - } - }, - slack: { - token: 'xoxb-Your-Token', // Your Slack Token - autoReconnect: true, // Reconnect on disconnect - autoMark: true // Mark messages as read - }, - usermap: { - // Map a JIRA username to a Slack username - // "jira-username": "slack-username" - } -}; - -export = config; diff --git a/src/lib/AttachmentInterface.ts b/src/lib/AttachmentInterface.ts deleted file mode 100644 index a02bd3d..0000000 --- a/src/lib/AttachmentInterface.ts +++ /dev/null @@ -1,27 +0,0 @@ -/// - -interface AttachmentFieldInterface { - "title": string; // Priority - "value": string; // High - "short": boolean; // if true, can be placed on same row as others -} - -interface AttachmentInterface { - "fallback": string; // Required plain-text summary of the attachment. - "color"?: string; // html color code - "pretext"?: string; // Optional text that appears above the attachment block - "author_name"?: string; // Bobby Tables - "author_link"?: string; // http://flickr.com/bobby/ - "author_icon"?: string; // http://flickr.com/icons/bobby.jpg - "title"?: string; // Slack API Documentation - "title_link"?: string; // https://api.slack.com/ - "text"?: string; // Optional text that appears within the attachment - - "fields"?: AttachmentFieldInterface[]; - - "image_url"?: string; // http://my-website.com/path/to/image.jpg - "thumb_url"?: string; // http://example.com/path/to/thumb.png - "mrkdwn_in"?: string[]; // ["pretext", "text", "fields"] -} - -export = AttachmentInterface; diff --git a/src/lib/ConfigInterface.ts b/src/lib/ConfigInterface.ts deleted file mode 100644 index a2ca24e..0000000 --- a/src/lib/ConfigInterface.ts +++ /dev/null @@ -1,28 +0,0 @@ -/// - -interface ConfigInterface { - jira: { - protocol: string; - host: string; - port: number; - base: string; - user: string; - pass: string; - apiVersion: string; - verbose: boolean; - strictSSL: boolean; - regex: RegExp; - sprintField: string; - customFields: { [id: string]: string } - } - - slack: { - token: string; - autoReconnect: boolean; - autoMark: boolean; - } - - usermap: { [id: string]: string } -} - -export = ConfigInterface; diff --git a/src/lib/bot.ts b/src/lib/bot.ts deleted file mode 100644 index 32c39c5..0000000 --- a/src/lib/bot.ts +++ /dev/null @@ -1,396 +0,0 @@ -/// - -var JiraApi = require('jira').JiraApi, - Slack = require('slack-client'); - -import moment = require('moment'); -import logger = require('./logger'); -import Config = require('./ConfigInterface'); -import Attachment = require('./AttachmentInterface'); - -interface Issue { - key: string; - id: number; - fields: { - [id: string]: any; - }; -} - -class Bot { - /* hold tickets and last time responded to */ - ticketBuffer: { [id: string]: number } = {}; - - /* Length of buffer to prevent ticket from being responded to */ - TICKET_BUFFER_LENGTH: number = 300000; - - /* Slack object */ - slack: any; - - /* Jira object */ - jira: any; - - /** - * Constructor. - * - * @param {Config} config The final configuration for the bot - */ - constructor (public config: Config) { - this.slack = new Slack( - config.slack.token, - config.slack.autoReconnect, - config.slack.autoMark - ); - - this.jira = new JiraApi( - config.jira.protocol, - config.jira.host, - config.jira.port, - config.jira.user, - config.jira.pass, - config.jira.apiVersion, - config.jira.verbose, - config.jira.strictSSL, - null, // No OAuth yet - config.jira.base - ); - } - - /** - * Build a response string about an issue. - * - * @param {Issue} issue the issue object returned by JIRA - * @return {Attachment} The response attachment. - */ - issueResponse (issue: Issue): Attachment { - var response: Attachment = { - fallback: `No summary found for ${issue.key}` - }; - var created = moment(issue['fields']['created']); - var updated = moment(issue['fields']['updated']); - - response.text = this.formatIssueDescription(issue['fields']['description']); - response.mrkdwn_in = ['text']; // Parse text as markdown - response.fallback = issue['fields']['summary']; - response.pretext = `Here is some information on ${issue.key}`; - response.title = issue['fields']['summary']; - response.title_link = this.buildIssueLink(issue.key); - - response.fields = []; - response.fields.push({ - title: "Created", - value: created.calendar(), - short: true - }); - - response.fields.push({ - title: "Updated", - value: updated.calendar(), - short: true - }); - - response.fields.push({ - title: "Status", - value: issue['fields']['status']['name'], - short: true - }); - - response.fields.push({ - title: "Priority", - value: issue['fields']['priority']['name'], - short: true - }); - - response.fields.push({ - title: "Reporter", - value: (this.JIRA2Slack(issue['fields']['reporter'].name) || issue['fields']['reporter'].displayName), - short: true - }); - - var assignee = 'Unassigned'; - if (issue['fields']['assignee']) { - assignee = (this.JIRA2Slack(issue['fields']['assignee'].name) || issue['fields']['assignee'].displayName); - } - - response.fields.push({ - title: "Assignee", - value: assignee, - short: true - }); - - // Sprint fields - if (this.config.jira.sprintField) { - response.fields.push({ - title: "Sprint", - value: (this.parseSprint(issue['fields'][this.config.jira.sprintField]) || 'Not Assigned'), - short: false - }); - } - - // Custom fields - if (this.config.jira.customFields && Object.keys(this.config.jira.customFields).length) { - for (var customField in this.config.jira.customFields) { - var fieldVal = null; - - // Do some simple guarding before eval - if (!/[;&\|\(\)]/.test(customField)) { - try { - fieldVal = eval(`issue.fields.${customField}`); - } catch (e) { - fieldVal = `Error while reading ${customField}`; - } - } else { - fieldVal = `Invalid characters in ${customField}`; - } - - fieldVal = fieldVal || `Unable to read ${customField}`; - response.fields.push({ - title: this.config.jira.customFields[customField], - value: fieldVal, - short: false - }); - } - } - - return response; - } - - /** - * Format a ticket description for display. - * * Truncate to 1000 characters - * * Replace any {quote} with ``` - * * If there is no description, add a default value - * - * @param string description The raw description - * @return string the formatted description - */ - formatIssueDescription (description: string): string { - if (!description) { - description = 'Ticket does not contain a description'; - } - - return description - .replace(/\{(quote|code)\}/g, '```'); - } - - /** - * Construct a link to an issue based on the issueKey and config - * - * @param string issueKey The issueKey for the issue - * @return string The constructed link - */ - buildIssueLink (issueKey: string): string { - var base = '/browse/'; - if (this.config.jira.base) { - // Strip preceeding and trailing forward slash - base = '/' + this.config.jira.base.replace(/^\/|\/$/g, '') + base; - } - return this.config.jira.protocol + '://' - + this.config.jira.host + ':' + this.config.jira.port - + base + issueKey; - } - - /** - * Parses the sprint name of a ticket. - * If the ticket is in more than one sprint - * A. Shame on you - * B. This will take the last one - * - * @param string[] customField The contents of the greenhopper custom field - * @return string The name of the sprint or '' - */ - parseSprint (customField: string[]): string { - var retVal = ''; - - if (customField && customField.length > 0) { - var sprintString = customField.pop(); - var matches = sprintString.match(/\,name=([^,]+)\,/); - if (matches && matches[1]) { - retVal = matches[1]; - } - } - - return retVal; - } - - /** - * Lookup a JIRA username and return their Slack username - * Meh... Trying to come up with a better system for this feature - * - * @param string username the JIRA username - * @return string The slack username or '' - */ - JIRA2Slack (username: string): string { - var retVal = ''; - - if (this.config.usermap[username]) { - retVal = `@${this.config.usermap[username]}`; - } - - return retVal; - } - - /** - * Parse out JIRA tickets from a message. - * This will return unique tickets that haven't been - * responded with recently. - * - * @param string channel the channel the message came from - * @param string message the message to search in - * @return string[] an array of tickets, empty if none found - */ - parseTickets (channel: string, message: string): string[] { - var retVal: string[] = []; - if (!channel || !message) { - return retVal; - } - - var uniques: { [id: string]: number } = {}; - var found: string[] = message.match(this.config.jira.regex); - var now: number = Date.now(); - var ticketHash: string; - - if (found && found.length) { - for (var x in found) { - ticketHash = this.hashTicket(channel, found[x]); - if ( - !uniques.hasOwnProperty(found[x]) - && ( - !this.ticketBuffer.hasOwnProperty(ticketHash) - || (now - this.ticketBuffer[ticketHash]) > this.TICKET_BUFFER_LENGTH - ) - ) { - retVal.push(found[x]); - uniques[found[x]] = 1; - this.ticketBuffer[ticketHash] = now; - } - } - } - - return retVal; - } - - /** - * Hashes the channel + ticket combo. - * - * @param string channel The name of the channel - * @param string ticket The name of the ticket - * @return string The unique hash - */ - hashTicket (channel:string, ticket:string): string { - return `${channel}-${ticket}`; - } - - /** - * Remove any tickets from the buffer if they are past the length - */ - cleanupTicketBuffer (): void { - var now = Date.now(); - - for (var x in this.ticketBuffer) { - if (now - this.ticketBuffer[x] > this.TICKET_BUFFER_LENGTH) { - delete this.ticketBuffer[x]; - } - } - } - - /** - * Function to be called on slack open - */ - slackOpen (): void { - var unreads = this.slack.getUnreadCount(); - - var id: string; - var channels: string[] = []; - var allChannels = this.slack.channels; - for (id in allChannels) { - if (allChannels[id].is_member) { - channels.push(`#${allChannels[id].name}`); - } - } - - var groups: string[] = []; - var allGroups = this.slack.groups; - for (id in allGroups) { - if (allGroups[id].is_open && !allGroups[id].is_archived) { - groups.push(allGroups[id].name); - } - } - - logger.info(`Welcome to Slack. You are @${this.slack.self.name} of ${this.slack.team.name}`); - logger.info(`You are in: ${channels.join(', ')}`); - logger.info(`As well as: ${groups.join(', ')}`); - var messages = unreads === 1 ? 'message' : 'messages'; - logger.info(`You have ${unreads} unread ${messages}`); - } - - /** - * Handle an incoming message - * @param object message The incoming message from Slack - */ - handleMessage (message: any): void { - var self = this; - var channel = this.slack.getChannelGroupOrDMByID(message.channel); - var user = this.slack.getUserByID(message.user); - var response = { - "as_user": true, - "attachments": [] - }; - var type = message.type, ts = message.ts, text = message.text; - var channelName = (channel && channel.is_channel) ? '#' : ''; - channelName = channelName + (channel ? channel.name : 'UNKNOWN_CHANNEL'); - var userName = (user && user.name) ? `@${user.name}` : "UNKNOWN_USER"; - - if (type === 'message' && (text !== null) && (channel !== null)) { - var found = this.parseTickets(channelName, text); - if (found && found.length) { - logger.info(`Detected ${found.join(',')} from ${userName} in ${channelName}`); - for (var x in found) { - this.jira.findIssue(found[x], function(error: any, issue: Issue) { - if (!error) { - response.attachments = [self.issueResponse(issue)]; - var result = channel.postMessage(response); - if (result) { - logger.info(`@${self.slack.self.name} responded with:`, response); - } else { - logger.error('It appears we are disconnected'); - } - } else { - logger.error(`Got an error trying to find ${found[x]}`, error); - } - }); - } - } else { - // Do nothing - } - } else { - var typeError = type !== 'message' ? `unexpected type ${type}.` : null; - var textError = text === null ? 'text was undefined.' : null; - var channelError = channel === null ? 'channel was undefined.' : null; - var errors = [typeError, textError, channelError].filter(function(element) { - return element !== null; - }).join(' '); - logger.info(`@${this.slack.self.name} could not respond. ${errors}`); - } - } - - /** - * Start the bot - */ - start (): void { - var self = this; - this.slack.on('open', function() { - self.slackOpen(); - }); - this.slack.on('message', function(message: string) { - self.handleMessage(message); - }); - this.slack.on('error', function(error: string) { - logger.error("Error: %s", error); - }); - - setInterval(this.cleanupTicketBuffer, 60000); - this.slack.login(); - } -} - -export = Bot; diff --git a/src/lib/logger.ts b/src/lib/logger.ts deleted file mode 100644 index 191c0ec..0000000 --- a/src/lib/logger.ts +++ /dev/null @@ -1,16 +0,0 @@ -/// - -import winston = require('winston'); - -var logger: winston.LoggerInstance = new winston.Logger({ - transports: [ - new (winston.transports.Console)({ - timestamp: true, - prettyPrint: true, - handleExceptions: true - }) - ] -}); -logger.cli(); - -export = logger; \ No newline at end of file diff --git a/src/spec/bot.spec.ts b/src/spec/bot.spec.ts deleted file mode 100644 index a5e91d3..0000000 --- a/src/spec/bot.spec.ts +++ /dev/null @@ -1,249 +0,0 @@ -/// - -import Bot = require('../lib/bot'); -import Config = require('../lib/ConfigInterface'); -var config_dist: Config = require('../config.default.js'); - -describe ('Bot', () => { - var config: Config; - - beforeEach(() => { - // reset the configuration - config = config_dist; - }); - - it ('should instantiate and set config', () => { - var bot = new Bot(config); - expect(bot.config).toEqual(config); - }); - - describe('Parse/Build Issues', () => { - it ('should build issue links correctly', () => { - var bot = new Bot(config); - - var issueKey = 'TEST-1'; - var expectedLink = 'https://jira.yourhost.domain:443/browse/' + issueKey; - - expect(bot.buildIssueLink(issueKey)).toEqual(expectedLink); - }); - - it ('should build issue links correctly with base', () => { - config.jira.base = 'foo'; - var bot = new Bot(config); - - var issueKey = 'TEST-1'; - var expectedLink = 'https://jira.yourhost.domain:443/foo/browse/' + issueKey; - - expect(bot.buildIssueLink(issueKey)).toEqual(expectedLink); - }); - }); - - describe('Parsing Fields', () => { - it ('should parse a sprint name from greenhopper field', function() { - var bot = new Bot(config); - - var sprintName = 'TEST'; - var exampleSprint = [ - 'derpry-derp-derp,name='+sprintName+',foo' - ]; - - expect(bot.parseSprint(exampleSprint)).toEqual(sprintName); - expect(bot.parseSprint(['busted'])).toBeFalsy() - }); - - it ('should parse a sprint name from the last sprint in the greenhopper field', () => { - var bot = new Bot(config); - - var sprintName = 'TEST'; - var exampleSprint = [ - 'derpry-derp-derp,name='+sprintName+'1,foo', - 'derpry-derp-derp,name='+sprintName+'2,foo', - 'derpry-derp-derp,name='+sprintName+'3,foo', - ]; - - expect(bot.parseSprint(exampleSprint)).toEqual(sprintName+'3'); - }); - - it ('should translate a jira username to a slack username', () => { - config.usermap = { - 'foo': 'bar', - 'fizz': 'buzz', - 'ping': 'pong' - } - var bot = new Bot(config); - - expect(bot.JIRA2Slack('foo')).toEqual('@bar'); - expect(bot.JIRA2Slack('ping')).toEqual('@pong'); - expect(bot.JIRA2Slack('blap')).toBeFalsy(); - }); - - it ('should parse unique jira tickets from a message', () => { - var bot = new Bot(config); - - expect(bot.parseTickets('Chan', 'blarty blar TEST-1')).toEqual(['TEST-1']); - expect(bot.parseTickets('Chan', 'blarty blar TEST-2 TEST-2')).toEqual(['TEST-2']); - expect(bot.parseTickets('Chan', 'blarty blar TEST-3 TEST-4')).toEqual(['TEST-3', 'TEST-4']); - expect(bot.parseTickets('Chan', 'blarty blar Test-1 Test-1')).toEqual([]); - }); - - it ('should handle empty message/channel', () => { - var bot = new Bot(config); - - expect(bot.parseTickets('Chan', null)).toEqual([]); - expect(bot.parseTickets(null, 'Foo')).toEqual([]); - }); - }); - - describe('Ticket Buffering', () => { - it ('should populate the ticket buffer', () => { - var bot = new Bot(config); - var ticket = 'TEST-1'; - var channel = 'Test'; - var hash = bot.hashTicket(channel, ticket); - - expect(bot.parseTickets(channel, 'foo ' + ticket)).toEqual([ticket]); - expect(bot.ticketBuffer.hasOwnProperty(hash)).toBeTruthy(); - // Expect the ticket to not be repeated - expect(bot.parseTickets(channel, 'foo ' + ticket)).toEqual([]); - }); - - it ('should respond to the same ticket in different channels', () => { - var bot = new Bot(config); - var ticket = 'TEST-1'; - var channel1 = 'Test1'; - var channel2 = 'Test2'; - - expect(bot.parseTickets(channel1, 'foo ' + ticket)).toEqual([ticket]); - expect(bot.parseTickets(channel2, 'foo ' + ticket)).toEqual([ticket]); - }); - - it ('should cleanup the ticket buffer', () => { - var bot = new Bot(config); - var ticket = 'TEST-1'; - var channel = 'Test'; - var hash = bot.hashTicket(channel, ticket); - - expect(bot.parseTickets(channel, 'foo ' + ticket)).toEqual([ticket]); - expect(bot.ticketBuffer.hasOwnProperty(hash)).toBeTruthy(); - - // set the Ticket Buffer Length low to trigger the cleanup - bot.TICKET_BUFFER_LENGTH = -1; - bot.cleanupTicketBuffer(); - expect(bot.ticketBuffer.hasOwnProperty(hash)).toBeFalsy(); - }); - }); - - describe("Issue Response", () => { - var issue; - - beforeEach(() => { - issue = { - key: 'TEST-1', - fields: { - created: '2015-05-01T00:00:00.000', - updated: '2015-05-01T00:01:00.000', - summary: 'Blarty', - description: 'Foo foo foo foo foo foo', - status: { - name: 'Open' - }, - priority: { - name: 'Low' - }, - reporter: { - name: 'bob', - displayName: 'Bob' - }, - assignee: { - name: 'fred', - displayName: 'Fred' - }, - customfield_10000: 'Fizz', - customfield_10001: [ - { value: 'Buzz' } - ] - } - }; - }); - - it ('should return a default description if empty', () => { - var bot = new Bot(config); - - expect(bot.formatIssueDescription('')).toEqual('Ticket does not contain a description'); - }); - - it ('should replace quotes', () => { - var bot = new Bot(config); - - expect(bot.formatIssueDescription('{quote}foo{quote}')) - .toEqual('```foo```'); - }); - - it ('should replace code blocks', () => { - var bot = new Bot(config); - - expect(bot.formatIssueDescription('{code}foo{code}')) - .toEqual('```foo```'); - }); - - it ('should show custom fields', () => { - var tests = { - cf1: false, - cf2: false, - nope1: false, - nope2: false, - nope3: false - }; - - var expected = { - cf1: true, - cf2: true, - nope1: true, - nope2: true, - nope3: true - }; - - // Add some custom fields - config.jira.customFields['customfield_10000'] = 'CF1'; - config.jira.customFields['customfield_10001[0].value'] = 'CF2'; - config.jira.customFields['customfield_10003 && exit()'] = 'Nope1'; - config.jira.customFields['customfield_10004; exit()'] = 'Nope2'; - config.jira.customFields['customfield_10005'] = 'Nope3'; - - var bot = new Bot(config); - var response = bot.issueResponse(issue); - - for (var x in response.fields) { - switch (response.fields[x].title) { - case config.jira.customFields['customfield_10000']: - if (response.fields[x].value == issue.fields['customfield_10000']) { - tests.cf1 = true; - } - break; - case config.jira.customFields['customfield_10001[0].value']: - if (response.fields[x].value == issue.fields['customfield_10001'][0].value) { - tests.cf2 = true; - } - break; - case config.jira.customFields['customfield_10003 && exit()']: - if (response.fields[x].value == 'Invalid characters in customfield_10003 && exit()') { - tests.nope1 = true; - } - break; - case config.jira.customFields['customfield_10004; exit()']: - if (response.fields[x].value == 'Invalid characters in customfield_10004; exit()') { - tests.nope2 = true; - } - break; - case config.jira.customFields['customfield_10005']: - if (response.fields[x].value == 'Unable to read customfield_10005') { - tests.nope3 = true; - } - break; - } - - } - expect(tests).toEqual(expected); - }); - }); -}); diff --git a/src/tsconfig.json b/src/tsconfig.json deleted file mode 100644 index fe7a486..0000000 --- a/src/tsconfig.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "version": "1.5.0-alpha", - "compileOnSave": false, - "compilerOptions": { - "target": "es5", - "module": "commonjs", - "declaration": false, - "noImplicitAny": false, - "removeComments": true, - "noLib": false, - "preserveConstEnums": true, - "suppressImplicitAnyIndexErrors": true - }, - "filesGlob": [ - "./**/*.ts", - "!./node_modules/**/*.ts" - ], - "files": [ - "./app.ts", - "./config.default.ts", - "./lib/AttachmentInterface.ts", - "./lib/ConfigInterface.ts", - "./lib/bot.ts", - "./lib/logger.ts", - "./spec/bot.spec.ts", - "./typings/jasmine/jasmine.d.ts", - "./typings/moment/moment-node.d.ts", - "./typings/moment/moment.d.ts", - "./typings/node/node.d.ts", - "./typings/tsd.d.ts", - "./typings/winston/winston.d.ts" - ] -} diff --git a/src/tsd.json b/src/tsd.json deleted file mode 100644 index 1e44349..0000000 --- a/src/tsd.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "version": "v4", - "repo": "borisyankov/DefinitelyTyped", - "ref": "master", - "path": "typings", - "bundle": "typings/tsd.d.ts", - "installed": { - "winston/winston.d.ts": { - "commit": "7f07bd88d1083e995a0dae317a333c9641320cc8" - }, - "node/node.d.ts": { - "commit": "7f07bd88d1083e995a0dae317a333c9641320cc8" - }, - "jasmine/jasmine.d.ts": { - "commit": "7f07bd88d1083e995a0dae317a333c9641320cc8" - }, - "moment/moment.d.ts": { - "commit": "7f07bd88d1083e995a0dae317a333c9641320cc8" - }, - "moment/moment-node.d.ts": { - "commit": "7f07bd88d1083e995a0dae317a333c9641320cc8" - } - } -} diff --git a/src/typings/jasmine/jasmine.d.ts b/src/typings/jasmine/jasmine.d.ts deleted file mode 100644 index 581353b..0000000 --- a/src/typings/jasmine/jasmine.d.ts +++ /dev/null @@ -1,496 +0,0 @@ -// Type definitions for Jasmine 2.2 -// Project: http://jasmine.github.io/ -// Definitions by: Boris Yankov , Theodore Brown , David Pärsson -// Definitions: https://github.com/borisyankov/DefinitelyTyped - - -// For ddescribe / iit use : https://github.com/borisyankov/DefinitelyTyped/blob/master/karma-jasmine/karma-jasmine.d.ts - -declare function describe(description: string, specDefinitions: () => void): void; -declare function fdescribe(description: string, specDefinitions: () => void): void; -declare function xdescribe(description: string, specDefinitions: () => void): void; - -declare function it(expectation: string, assertion?: () => void, timeout?: number): void; -declare function it(expectation: string, assertion?: (done: () => void) => void, timeout?: number): void; -declare function fit(expectation: string, assertion?: () => void, timeout?: number): void; -declare function fit(expectation: string, assertion?: (done: () => void) => void, timeout?: number): void; -declare function xit(expectation: string, assertion?: () => void, timeout?: number): void; -declare function xit(expectation: string, assertion?: (done: () => void) => void, timeout?: number): void; - -/** If you call the function pending anywhere in the spec body, no matter the expectations, the spec will be marked pending. */ -declare function pending(reason?: string): void; - -declare function beforeEach(action: () => void, timeout?: number): void; -declare function beforeEach(action: (done: () => void) => void, timeout?: number): void; -declare function afterEach(action: () => void, timeout?: number): void; -declare function afterEach(action: (done: () => void) => void, timeout?: number): void; - -declare function beforeAll(action: () => void, timeout?: number): void; -declare function beforeAll(action: (done: () => void) => void, timeout?: number): void; -declare function afterAll(action: () => void, timeout?: number): void; -declare function afterAll(action: (done: () => void) => void, timeout?: number): void; - -declare function expect(spy: Function): jasmine.Matchers; -declare function expect(actual: any): jasmine.Matchers; - -declare function fail(e?: any): void; - -declare function spyOn(object: any, method: string): jasmine.Spy; - -declare function runs(asyncMethod: Function): void; -declare function waitsFor(latchMethod: () => boolean, failureMessage?: string, timeout?: number): void; -declare function waits(timeout?: number): void; - -declare module jasmine { - - var clock: () => Clock; - - function any(aclass: any): Any; - function anything(): Any; - function arrayContaining(sample: any[]): ArrayContaining; - function objectContaining(sample: any): ObjectContaining; - function createSpy(name: string, originalFn?: Function): Spy; - function createSpyObj(baseName: string, methodNames: any[]): any; - function createSpyObj(baseName: string, methodNames: any[]): T; - function pp(value: any): string; - function getEnv(): Env; - function addCustomEqualityTester(equalityTester: CustomEqualityTester): void; - function addMatchers(matchers: CustomMatcherFactories): void; - function stringMatching(str: string): Any; - function stringMatching(str: RegExp): Any; - - interface Any { - - new (expectedClass: any): any; - - jasmineMatches(other: any): boolean; - jasmineToString(): string; - } - - // taken from TypeScript lib.core.es6.d.ts, applicable to CustomMatchers.contains() - interface ArrayLike { - length: number; - [n: number]: T; - } - - interface ArrayContaining { - new (sample: any[]): any; - - asymmetricMatch(other: any): boolean; - jasmineToString(): string; - } - - interface ObjectContaining { - new (sample: any): any; - - jasmineMatches(other: any, mismatchKeys: any[], mismatchValues: any[]): boolean; - jasmineToString(): string; - } - - interface Block { - - new (env: Env, func: SpecFunction, spec: Spec): any; - - execute(onComplete: () => void): void; - } - - interface WaitsBlock extends Block { - new (env: Env, timeout: number, spec: Spec): any; - } - - interface WaitsForBlock extends Block { - new (env: Env, timeout: number, latchFunction: SpecFunction, message: string, spec: Spec): any; - } - - interface Clock { - install(): void; - uninstall(): void; - /** Calls to any registered callback are triggered when the clock is ticked forward via the jasmine.clock().tick function, which takes a number of milliseconds. */ - tick(ms: number): void; - mockDate(date?: Date): void; - } - - interface CustomEqualityTester { - (first: any, second: any): boolean; - } - - interface CustomMatcher { - compare(actual: T, expected: T): CustomMatcherResult; - compare(actual: any, expected: any): CustomMatcherResult; - } - - interface CustomMatcherFactory { - (util: MatchersUtil, customEqualityTesters: Array): CustomMatcher; - } - - interface CustomMatcherFactories { - [index: string]: CustomMatcherFactory; - } - - interface CustomMatcherResult { - pass: boolean; - message: string; - } - - interface MatchersUtil { - equals(a: any, b: any, customTesters?: Array): boolean; - contains(haystack: ArrayLike | string, needle: any, customTesters?: Array): boolean; - buildFailureMessage(matcherName: string, isNot: boolean, actual: any, ...expected: Array): string; - } - - interface Env { - setTimeout: any; - clearTimeout: void; - setInterval: any; - clearInterval: void; - updateInterval: number; - - currentSpec: Spec; - - matchersClass: Matchers; - - version(): any; - versionString(): string; - nextSpecId(): number; - addReporter(reporter: Reporter): void; - execute(): void; - describe(description: string, specDefinitions: () => void): Suite; - // ddescribe(description: string, specDefinitions: () => void): Suite; Not a part of jasmine. Angular team adds these - beforeEach(beforeEachFunction: () => void): void; - beforeAll(beforeAllFunction: () => void): void; - currentRunner(): Runner; - afterEach(afterEachFunction: () => void): void; - afterAll(afterAllFunction: () => void): void; - xdescribe(desc: string, specDefinitions: () => void): XSuite; - it(description: string, func: () => void): Spec; - // iit(description: string, func: () => void): Spec; Not a part of jasmine. Angular team adds these - xit(desc: string, func: () => void): XSpec; - compareRegExps_(a: RegExp, b: RegExp, mismatchKeys: string[], mismatchValues: string[]): boolean; - compareObjects_(a: any, b: any, mismatchKeys: string[], mismatchValues: string[]): boolean; - equals_(a: any, b: any, mismatchKeys: string[], mismatchValues: string[]): boolean; - contains_(haystack: any, needle: any): boolean; - addCustomEqualityTester(equalityTester: CustomEqualityTester): void; - addMatchers(matchers: CustomMatcherFactories): void; - specFilter(spec: Spec): boolean; - } - - interface FakeTimer { - - new (): any; - - reset(): void; - tick(millis: number): void; - runFunctionsWithinRange(oldMillis: number, nowMillis: number): void; - scheduleFunction(timeoutKey: any, funcToCall: () => void, millis: number, recurring: boolean): void; - } - - interface HtmlReporter { - new (): any; - } - - interface HtmlSpecFilter { - new (): any; - } - - interface Result { - type: string; - } - - interface NestedResults extends Result { - description: string; - - totalCount: number; - passedCount: number; - failedCount: number; - - skipped: boolean; - - rollupCounts(result: NestedResults): void; - log(values: any): void; - getItems(): Result[]; - addResult(result: Result): void; - passed(): boolean; - } - - interface MessageResult extends Result { - values: any; - trace: Trace; - } - - interface ExpectationResult extends Result { - matcherName: string; - passed(): boolean; - expected: any; - actual: any; - message: string; - trace: Trace; - } - - interface Trace { - name: string; - message: string; - stack: any; - } - - interface PrettyPrinter { - - new (): any; - - format(value: any): void; - iterateObject(obj: any, fn: (property: string, isGetter: boolean) => void): void; - emitScalar(value: any): void; - emitString(value: string): void; - emitArray(array: any[]): void; - emitObject(obj: any): void; - append(value: any): void; - } - - interface StringPrettyPrinter extends PrettyPrinter { - } - - interface Queue { - - new (env: any): any; - - env: Env; - ensured: boolean[]; - blocks: Block[]; - running: boolean; - index: number; - offset: number; - abort: boolean; - - addBefore(block: Block, ensure?: boolean): void; - add(block: any, ensure?: boolean): void; - insertNext(block: any, ensure?: boolean): void; - start(onComplete?: () => void): void; - isRunning(): boolean; - next_(): void; - results(): NestedResults; - } - - interface Matchers { - - new (env: Env, actual: any, spec: Env, isNot?: boolean): any; - - env: Env; - actual: any; - spec: Env; - isNot?: boolean; - message(): any; - - toBe(expected: any): boolean; - toEqual(expected: any): boolean; - toMatch(expected: any): boolean; - toBeDefined(): boolean; - toBeUndefined(): boolean; - toBeNull(): boolean; - toBeNaN(): boolean; - toBeTruthy(): boolean; - toBeFalsy(): boolean; - toHaveBeenCalled(): boolean; - toHaveBeenCalledWith(...params: any[]): boolean; - toContain(expected: any): boolean; - toBeLessThan(expected: any): boolean; - toBeGreaterThan(expected: any): boolean; - toBeCloseTo(expected: any, precision: any): boolean; - toContainHtml(expected: string): boolean; - toContainText(expected: string): boolean; - toThrow(expected?: any): boolean; - toThrowError(expected?: any, message?: string): boolean; - not: Matchers; - - Any: Any; - } - - interface Reporter { - reportRunnerStarting(runner: Runner): void; - reportRunnerResults(runner: Runner): void; - reportSuiteResults(suite: Suite): void; - reportSpecStarting(spec: Spec): void; - reportSpecResults(spec: Spec): void; - log(str: string): void; - } - - interface MultiReporter extends Reporter { - addReporter(reporter: Reporter): void; - } - - interface Runner { - - new (env: Env): any; - - execute(): void; - beforeEach(beforeEachFunction: SpecFunction): void; - afterEach(afterEachFunction: SpecFunction): void; - beforeAll(beforeAllFunction: SpecFunction): void; - afterAll(afterAllFunction: SpecFunction): void; - finishCallback(): void; - addSuite(suite: Suite): void; - add(block: Block): void; - specs(): Spec[]; - suites(): Suite[]; - topLevelSuites(): Suite[]; - results(): NestedResults; - } - - interface SpecFunction { - (spec?: Spec): void; - } - - interface SuiteOrSpec { - id: number; - env: Env; - description: string; - queue: Queue; - } - - interface Spec extends SuiteOrSpec { - - new (env: Env, suite: Suite, description: string): any; - - suite: Suite; - - afterCallbacks: SpecFunction[]; - spies_: Spy[]; - - results_: NestedResults; - matchersClass: Matchers; - - getFullName(): string; - results(): NestedResults; - log(arguments: any): any; - runs(func: SpecFunction): Spec; - addToQueue(block: Block): void; - addMatcherResult(result: Result): void; - expect(actual: any): any; - waits(timeout: number): Spec; - waitsFor(latchFunction: SpecFunction, timeoutMessage?: string, timeout?: number): Spec; - fail(e?: any): void; - getMatchersClass_(): Matchers; - addMatchers(matchersPrototype: CustomMatcherFactories): void; - finishCallback(): void; - finish(onComplete?: () => void): void; - after(doAfter: SpecFunction): void; - execute(onComplete?: () => void): any; - addBeforesAndAftersToQueue(): void; - explodes(): void; - spyOn(obj: any, methodName: string, ignoreMethodDoesntExist: boolean): Spy; - removeAllSpies(): void; - } - - interface XSpec { - id: number; - runs(): void; - } - - interface Suite extends SuiteOrSpec { - - new (env: Env, description: string, specDefinitions: () => void, parentSuite: Suite): any; - - parentSuite: Suite; - - getFullName(): string; - finish(onComplete?: () => void): void; - beforeEach(beforeEachFunction: SpecFunction): void; - afterEach(afterEachFunction: SpecFunction): void; - beforeAll(beforeAllFunction: SpecFunction): void; - afterAll(afterAllFunction: SpecFunction): void; - results(): NestedResults; - add(suiteOrSpec: SuiteOrSpec): void; - specs(): Spec[]; - suites(): Suite[]; - children(): any[]; - execute(onComplete?: () => void): void; - } - - interface XSuite { - execute(): void; - } - - interface Spy { - (...params: any[]): any; - - identity: string; - and: SpyAnd; - calls: Calls; - mostRecentCall: { args: any[]; }; - argsForCall: any[]; - wasCalled: boolean; - } - - interface SpyAnd { - /** By chaining the spy with and.callThrough, the spy will still track all calls to it but in addition it will delegate to the actual implementation. */ - callThrough(): Spy; - /** By chaining the spy with and.returnValue, all calls to the function will return a specific value. */ - returnValue(val: any): void; - /** By chaining the spy with and.callFake, all calls to the spy will delegate to the supplied function. */ - callFake(fn: Function): Spy; - /** By chaining the spy with and.throwError, all calls to the spy will throw the specified value. */ - throwError(msg: string): void; - /** When a calling strategy is used for a spy, the original stubbing behavior can be returned at any time with and.stub. */ - stub(): Spy; - } - - interface Calls { - /** By chaining the spy with calls.any(), will return false if the spy has not been called at all, and then true once at least one call happens. **/ - any(): boolean; - /** By chaining the spy with calls.count(), will return the number of times the spy was called **/ - count(): number; - /** By chaining the spy with calls.argsFor(), will return the arguments passed to call number index **/ - argsFor(index: number): any[]; - /** By chaining the spy with calls.allArgs(), will return the arguments to all calls **/ - allArgs(): any[]; - /** By chaining the spy with calls.all(), will return the context (the this) and arguments passed all calls **/ - all(): CallInfo[]; - /** By chaining the spy with calls.mostRecent(), will return the context (the this) and arguments for the most recent call **/ - mostRecent(): CallInfo; - /** By chaining the spy with calls.first(), will return the context (the this) and arguments for the first call **/ - first(): CallInfo; - /** By chaining the spy with calls.reset(), will clears all tracking for a spy **/ - reset(): void; - } - - interface CallInfo { - /** The context (the this) for the call */ - object: any; - /** All arguments passed to the call */ - args: any[]; - } - - interface Util { - inherit(childClass: Function, parentClass: Function): any; - formatException(e: any): any; - htmlEscape(str: string): string; - argsToArray(args: any): any; - extend(destination: any, source: any): any; - } - - interface JsApiReporter extends Reporter { - - started: boolean; - finished: boolean; - result: any; - messages: any; - - new (): any; - - suites(): Suite[]; - summarize_(suiteOrSpec: SuiteOrSpec): any; - results(): any; - resultsForSpec(specId: any): any; - log(str: any): any; - resultsForSpecs(specIds: any): any; - summarizeResult_(result: any): any; - } - - interface Jasmine { - Spec: Spec; - clock: Clock; - util: Util; - } - - export var HtmlReporter: HtmlReporter; - export var HtmlSpecFilter: HtmlSpecFilter; - export var DEFAULT_TIMEOUT_INTERVAL: number; -} diff --git a/src/typings/moment/moment-node.d.ts b/src/typings/moment/moment-node.d.ts deleted file mode 100644 index b109893..0000000 --- a/src/typings/moment/moment-node.d.ts +++ /dev/null @@ -1,479 +0,0 @@ -// Type definitions for Moment.js 2.8.0 -// Project: https://github.com/timrwood/moment -// Definitions by: Michael Lakerveld , Aaron King , Hiroki Horiuchi , Dick van den Brink , Adi Dahiya , Matt Brooks -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -declare module moment { - - interface MomentInput { - - /** Year */ - years?: number; - /** Year */ - year?: number; - /** Year */ - y?: number; - - /** Month */ - months?: number; - /** Month */ - month?: number; - /** Month */ - M?: number; - - /** Day/Date */ - days?: number; - /** Day/Date */ - day?: number; - /** Day/Date */ - date?: number; - /** Day/Date */ - d?: number; - - /** Hour */ - hours?: number; - /** Hour */ - hour?: number; - /** Hour */ - h?: number; - - /** Minute */ - minutes?: number; - /** Minute */ - minute?: number; - /** Minute */ - m?: number; - - /** Second */ - seconds?: number; - /** Second */ - second?: number; - /** Second */ - s?: number; - - /** Millisecond */ - milliseconds?: number; - /** Millisecond */ - millisecond?: number; - /** Millisecond */ - ms?: number; - - } - - interface Duration { - - humanize(withSuffix?: boolean): string; - - as(units: string): number; - - milliseconds(): number; - asMilliseconds(): number; - - seconds(): number; - asSeconds(): number; - - minutes(): number; - asMinutes(): number; - - hours(): number; - asHours(): number; - - days(): number; - asDays(): number; - - months(): number; - asMonths(): number; - - years(): number; - asYears(): number; - - add(n: number, p: string): Duration; - add(n: number): Duration; - add(d: Duration): Duration; - - subtract(n: number, p: string): Duration; - subtract(n: number): Duration; - subtract(d: Duration): Duration; - - toISOString(): string; - toJSON(): string; - - } - - interface Moment { - - format(format: string): string; - format(): string; - - fromNow(withoutSuffix?: boolean): string; - - startOf(unitOfTime: string): Moment; - endOf(unitOfTime: string): Moment; - - /** - * Mutates the original moment by adding time. (deprecated in 2.8.0) - * - * @param unitOfTime the unit of time you want to add (eg "years" / "hours" etc) - * @param amount the amount you want to add - */ - add(unitOfTime: string, amount: number): Moment; - /** - * Mutates the original moment by adding time. - * - * @param amount the amount you want to add - * @param unitOfTime the unit of time you want to add (eg "years" / "hours" etc) - */ - add(amount: number, unitOfTime: string): Moment; - /** - * Mutates the original moment by adding time. Note that the order of arguments can be flipped. - * - * @param amount the amount you want to add - * @param unitOfTime the unit of time you want to add (eg "years" / "hours" etc) - */ - add(amount: string, unitOfTime: string): Moment; - /** - * Mutates the original moment by adding time. - * - * @param objectLiteral an object literal that describes multiple time units {days:7,months:1} - */ - add(objectLiteral: MomentInput): Moment; - /** - * Mutates the original moment by adding time. - * - * @param duration a length of time - */ - add(duration: Duration): Moment; - - /** - * Mutates the original moment by subtracting time. (deprecated in 2.8.0) - * - * @param unitOfTime the unit of time you want to subtract (eg "years" / "hours" etc) - * @param amount the amount you want to subtract - */ - subtract(unitOfTime: string, amount: number): Moment; - /** - * Mutates the original moment by subtracting time. - * - * @param unitOfTime the unit of time you want to subtract (eg "years" / "hours" etc) - * @param amount the amount you want to subtract - */ - subtract(amount: number, unitOfTime: string): Moment; - /** - * Mutates the original moment by subtracting time. Note that the order of arguments can be flipped. - * - * @param amount the amount you want to add - * @param unitOfTime the unit of time you want to subtract (eg "years" / "hours" etc) - */ - subtract(amount: string, unitOfTime: string): Moment; - /** - * Mutates the original moment by subtracting time. - * - * @param objectLiteral an object literal that describes multiple time units {days:7,months:1} - */ - subtract(objectLiteral: MomentInput): Moment; - /** - * Mutates the original moment by subtracting time. - * - * @param duration a length of time - */ - subtract(duration: Duration): Moment; - - calendar(): string; - calendar(start: Moment): string; - - clone(): Moment; - - /** - * @return Unix timestamp, or milliseconds since the epoch. - */ - valueOf(): number; - - local(): Moment; // current date/time in local mode - - utc(): Moment; // current date/time in UTC mode - - isValid(): boolean; - invalidAt(): number; - - year(y: number): Moment; - year(): number; - quarter(): number; - quarter(q: number): Moment; - month(M: number): Moment; - month(M: string): Moment; - month(): number; - day(d: number): Moment; - day(d: string): Moment; - day(): number; - date(d: number): Moment; - date(): number; - hour(h: number): Moment; - hour(): number; - hours(h: number): Moment; - hours(): number; - minute(m: number): Moment; - minute(): number; - minutes(m: number): Moment; - minutes(): number; - second(s: number): Moment; - second(): number; - seconds(s: number): Moment; - seconds(): number; - millisecond(ms: number): Moment; - millisecond(): number; - milliseconds(ms: number): Moment; - milliseconds(): number; - weekday(): number; - weekday(d: number): Moment; - isoWeekday(): number; - isoWeekday(d: number): Moment; - weekYear(): number; - weekYear(d: number): Moment; - isoWeekYear(): number; - isoWeekYear(d: number): Moment; - week(): number; - week(d: number): Moment; - weeks(): number; - weeks(d: number): Moment; - isoWeek(): number; - isoWeek(d: number): Moment; - isoWeeks(): number; - isoWeeks(d: number): Moment; - weeksInYear(): number; - isoWeeksInYear(): number; - dayOfYear(): number; - dayOfYear(d: number): Moment; - - from(f: Moment|string|number|Date|number[], suffix?: boolean): string; - to(f: Moment|string|number|Date|number[], suffix?: boolean): string; - - diff(b: Moment): number; - diff(b: Moment, unitOfTime: string): number; - diff(b: Moment, unitOfTime: string, round: boolean): number; - - toArray(): number[]; - toDate(): Date; - toISOString(): string; - toJSON(): string; - unix(): number; - - isLeapYear(): boolean; - zone(): number; - zone(b: number): Moment; - zone(b: string): Moment; - utcOffset(): number; - utcOffset(b: number): Moment; - utcOffset(b: string): Moment; - daysInMonth(): number; - isDST(): boolean; - - isBefore(): boolean; - isBefore(b: Moment|string|number|Date|number[], granularity?: string): boolean; - - isAfter(): boolean; - isAfter(b: Moment|string|number|Date|number[], granularity?: string): boolean; - - isSame(b: Moment|string|number|Date|number[], granularity?: string): boolean; - isBetween(a: Moment|string|number|Date|number[], b: Moment|string|number|Date|number[], granularity?: string): boolean; - - // Deprecated as of 2.8.0. - lang(language: string): Moment; - lang(reset: boolean): Moment; - lang(): MomentLanguage; - - locale(language: string): Moment; - locale(reset: boolean): Moment; - locale(): string; - - localeData(language: string): Moment; - localeData(reset: boolean): Moment; - localeData(): MomentLanguage; - - // Deprecated as of 2.7.0. - max(date: Moment|string|number|Date|any[]): Moment; - max(date: string, format: string): Moment; - - // Deprecated as of 2.7.0. - min(date: Moment|string|number|Date|any[]): Moment; - min(date: string, format: string): Moment; - - get(unit: string): number; - set(unit: string, value: number): Moment; - - } - - interface MomentCalendar { - - lastDay: any; - sameDay: any; - nextDay: any; - lastWeek: any; - nextWeek: any; - sameElse: any; - - } - - interface BaseMomentLanguage { - months ?: any; - monthsShort ?: any; - weekdays ?: any; - weekdaysShort ?: any; - weekdaysMin ?: any; - relativeTime ?: MomentRelativeTime; - meridiem ?: (hour: number, minute: number, isLowercase: boolean) => string; - calendar ?: MomentCalendar; - ordinal ?: (num: number) => string; - } - - interface MomentLanguage extends BaseMomentLanguage { - longDateFormat?: MomentLongDateFormat; - } - - interface MomentLanguageData extends BaseMomentLanguage { - /** - * @param formatType should be L, LL, LLL, LLLL. - */ - longDateFormat(formatType: string): string; - } - - interface MomentLongDateFormat { - - L: string; - LL: string; - LLL: string; - LLLL: string; - LT: string; - l?: string; - ll?: string; - lll?: string; - llll?: string; - lt?: string; - - } - - interface MomentRelativeTime { - - future: any; - past: any; - s: any; - m: any; - mm: any; - h: any; - hh: any; - d: any; - dd: any; - M: any; - MM: any; - y: any; - yy: any; - - } - - interface MomentStatic { - - version: string; - fn: Moment; - - (): Moment; - (date: number): Moment; - (date: number[]): Moment; - (date: string, format?: string, strict?: boolean): Moment; - (date: string, format?: string, language?: string, strict?: boolean): Moment; - (date: string, formats: string[], strict?: boolean): Moment; - (date: string, formats: string[], language?: string, strict?: boolean): Moment; - (date: string, specialFormat: () => void, strict?: boolean): Moment; - (date: string, specialFormat: () => void, language?: string, strict?: boolean): Moment; - (date: string, formatsIncludingSpecial: any[], strict?: boolean): Moment; - (date: string, formatsIncludingSpecial: any[], language?: string, strict?: boolean): Moment; - (date: Date): Moment; - (date: Moment): Moment; - (date: Object): Moment; - - utc(): Moment; - utc(date: number): Moment; - utc(date: number[]): Moment; - utc(date: string, format?: string, strict?: boolean): Moment; - utc(date: string, format?: string, language?: string, strict?: boolean): Moment; - utc(date: string, formats: string[], strict?: boolean): Moment; - utc(date: string, formats: string[], language?: string, strict?: boolean): Moment; - utc(date: Date): Moment; - utc(date: Moment): Moment; - utc(date: Object): Moment; - - unix(timestamp: number): Moment; - - invalid(parsingFlags?: Object): Moment; - isMoment(): boolean; - isMoment(m: any): boolean; - isDate(m: any): boolean; - isDuration(): boolean; - isDuration(d: any): boolean; - - // Deprecated in 2.8.0. - lang(language?: string): string; - lang(language?: string, definition?: MomentLanguage): string; - - locale(language?: string): string; - locale(language?: string[]): string; - locale(language?: string, definition?: MomentLanguage): string; - - localeData(language?: string): MomentLanguageData; - - longDateFormat: any; - relativeTime: any; - meridiem: (hour: number, minute: number, isLowercase: boolean) => string; - calendar: any; - ordinal: (num: number) => string; - - duration(milliseconds: Number): Duration; - duration(num: Number, unitOfTime: string): Duration; - duration(input: MomentInput): Duration; - duration(object: any): Duration; - duration(): Duration; - - parseZone(date: string): Moment; - - months(): string[]; - months(index: number): string; - months(format: string): string[]; - months(format: string, index: number): string; - monthsShort(): string[]; - monthsShort(index: number): string; - monthsShort(format: string): string[]; - monthsShort(format: string, index: number): string; - - weekdays(): string[]; - weekdays(index: number): string; - weekdays(format: string): string[]; - weekdays(format: string, index: number): string; - weekdaysShort(): string[]; - weekdaysShort(index: number): string; - weekdaysShort(format: string): string[]; - weekdaysShort(format: string, index: number): string; - weekdaysMin(): string[]; - weekdaysMin(index: number): string; - weekdaysMin(format: string): string[]; - weekdaysMin(format: string, index: number): string; - - min(moments: Moment[]): Moment; - max(moments: Moment[]): Moment; - - normalizeUnits(unit: string): string; - relativeTimeThreshold(threshold: string): number|boolean; - relativeTimeThreshold(threshold: string, limit:number): boolean; - - /** - * Constant used to enable explicit ISO_8601 format parsing. - */ - ISO_8601(): void; - - defaultFormat: string; - - } - -} - -declare module 'moment' { - var moment: moment.MomentStatic; - export = moment; -} diff --git a/src/typings/moment/moment.d.ts b/src/typings/moment/moment.d.ts deleted file mode 100644 index 78b0901..0000000 --- a/src/typings/moment/moment.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -// Type definitions for Moment.js 2.8.0 -// Project: https://github.com/timrwood/moment -// Definitions by: Michael Lakerveld , Aaron King , Hiroki Horiuchi , Dick van den Brink , Adi Dahiya , Matt Brooks -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -/// - -declare var moment: moment.MomentStatic; diff --git a/src/typings/node/node.d.ts b/src/typings/node/node.d.ts deleted file mode 100644 index b7edca1..0000000 --- a/src/typings/node/node.d.ts +++ /dev/null @@ -1,2079 +0,0 @@ -// Type definitions for Node.js v0.12.0 -// Project: http://nodejs.org/ -// Definitions by: Microsoft TypeScript , DefinitelyTyped -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -/************************************************ -* * -* Node.js v0.12.0 API * -* * -************************************************/ - -// compat for TypeScript 1.5.3 -// if you use with --target es3 or --target es5 and use below definitions, -// use the lib.es6.d.ts that is bundled with TypeScript 1.5.3. -interface MapConstructor {} -interface WeakMapConstructor {} -interface SetConstructor {} -interface WeakSetConstructor {} - -/************************************************ -* * -* GLOBAL * -* * -************************************************/ -declare var process: NodeJS.Process; -declare var global: NodeJS.Global; - -declare var __filename: string; -declare var __dirname: string; - -declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; -declare function clearTimeout(timeoutId: NodeJS.Timer): void; -declare function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; -declare function clearInterval(intervalId: NodeJS.Timer): void; -declare function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; -declare function clearImmediate(immediateId: any): void; - -interface NodeRequireFunction { - (id: string): any; -} - -interface NodeRequire extends NodeRequireFunction { - resolve(id:string): string; - cache: any; - extensions: any; - main: any; -} - -declare var require: NodeRequire; - -interface NodeModule { - exports: any; - require: NodeRequireFunction; - id: string; - filename: string; - loaded: boolean; - parent: any; - children: any[]; -} - -declare var module: NodeModule; - -// Same as module.exports -declare var exports: any; -declare var SlowBuffer: { - new (str: string, encoding?: string): Buffer; - new (size: number): Buffer; - new (size: Uint8Array): Buffer; - new (array: any[]): Buffer; - prototype: Buffer; - isBuffer(obj: any): boolean; - byteLength(string: string, encoding?: string): number; - concat(list: Buffer[], totalLength?: number): Buffer; -}; - - -// Buffer class -interface Buffer extends NodeBuffer {} - -/** - * Raw data is stored in instances of the Buffer class. - * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. - * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' - */ -declare var Buffer: { - /** - * Allocates a new buffer containing the given {str}. - * - * @param str String to store in buffer. - * @param encoding encoding to use, optional. Default is 'utf8' - */ - new (str: string, encoding?: string): Buffer; - /** - * Allocates a new buffer of {size} octets. - * - * @param size count of octets to allocate. - */ - new (size: number): Buffer; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: Uint8Array): Buffer; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: any[]): Buffer; - prototype: Buffer; - /** - * Returns true if {obj} is a Buffer - * - * @param obj object to test. - */ - isBuffer(obj: any): boolean; - /** - * Returns true if {encoding} is a valid encoding argument. - * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' - * - * @param encoding string to test. - */ - isEncoding(encoding: string): boolean; - /** - * Gives the actual byte length of a string. encoding defaults to 'utf8'. - * This is not the same as String.prototype.length since that returns the number of characters in a string. - * - * @param string string to test. - * @param encoding encoding used to evaluate (defaults to 'utf8') - */ - byteLength(string: string, encoding?: string): number; - /** - * Returns a buffer which is the result of concatenating all the buffers in the list together. - * - * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. - * If the list has exactly one item, then the first item of the list is returned. - * If the list has more than one item, then a new Buffer is created. - * - * @param list An array of Buffer objects to concatenate - * @param totalLength Total length of the buffers when concatenated. - * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. - */ - concat(list: Buffer[], totalLength?: number): Buffer; - /** - * The same as buf1.compare(buf2). - */ - compare(buf1: Buffer, buf2: Buffer): number; -}; - -/************************************************ -* * -* GLOBAL INTERFACES * -* * -************************************************/ -declare module NodeJS { - export interface ErrnoException extends Error { - errno?: number; - code?: string; - path?: string; - syscall?: string; - stack?: string; - } - - export interface EventEmitter { - addListener(event: string, listener: Function): EventEmitter; - on(event: string, listener: Function): EventEmitter; - once(event: string, listener: Function): EventEmitter; - removeListener(event: string, listener: Function): EventEmitter; - removeAllListeners(event?: string): EventEmitter; - setMaxListeners(n: number): void; - listeners(event: string): Function[]; - emit(event: string, ...args: any[]): boolean; - } - - export interface ReadableStream extends EventEmitter { - readable: boolean; - read(size?: number): string|Buffer; - setEncoding(encoding: string): void; - pause(): void; - resume(): void; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: string): void; - unshift(chunk: Buffer): void; - wrap(oldStream: ReadableStream): ReadableStream; - } - - export interface WritableStream extends EventEmitter { - writable: boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - } - - export interface ReadWriteStream extends ReadableStream, WritableStream {} - - export interface Process extends EventEmitter { - stdout: WritableStream; - stderr: WritableStream; - stdin: ReadableStream; - argv: string[]; - execPath: string; - abort(): void; - chdir(directory: string): void; - cwd(): string; - env: any; - exit(code?: number): void; - getgid(): number; - setgid(id: number): void; - setgid(id: string): void; - getuid(): number; - setuid(id: number): void; - setuid(id: string): void; - version: string; - versions: { - http_parser: string; - node: string; - v8: string; - ares: string; - uv: string; - zlib: string; - openssl: string; - }; - config: { - target_defaults: { - cflags: any[]; - default_configuration: string; - defines: string[]; - include_dirs: string[]; - libraries: string[]; - }; - variables: { - clang: number; - host_arch: string; - node_install_npm: boolean; - node_install_waf: boolean; - node_prefix: string; - node_shared_openssl: boolean; - node_shared_v8: boolean; - node_shared_zlib: boolean; - node_use_dtrace: boolean; - node_use_etw: boolean; - node_use_openssl: boolean; - target_arch: string; - v8_no_strict_aliasing: number; - v8_use_snapshot: boolean; - visibility: string; - }; - }; - kill(pid: number, signal?: string): void; - pid: number; - title: string; - arch: string; - platform: string; - memoryUsage(): { rss: number; heapTotal: number; heapUsed: number; }; - nextTick(callback: Function): void; - umask(mask?: number): number; - uptime(): number; - hrtime(time?:number[]): number[]; - - // Worker - send?(message: any, sendHandle?: any): void; - } - - export interface Global { - Array: typeof Array; - ArrayBuffer: typeof ArrayBuffer; - Boolean: typeof Boolean; - Buffer: typeof Buffer; - DataView: typeof DataView; - Date: typeof Date; - Error: typeof Error; - EvalError: typeof EvalError; - Float32Array: typeof Float32Array; - Float64Array: typeof Float64Array; - Function: typeof Function; - GLOBAL: Global; - Infinity: typeof Infinity; - Int16Array: typeof Int16Array; - Int32Array: typeof Int32Array; - Int8Array: typeof Int8Array; - Intl: typeof Intl; - JSON: typeof JSON; - Map: MapConstructor; - Math: typeof Math; - NaN: typeof NaN; - Number: typeof Number; - Object: typeof Object; - Promise: Function; - RangeError: typeof RangeError; - ReferenceError: typeof ReferenceError; - RegExp: typeof RegExp; - Set: SetConstructor; - String: typeof String; - Symbol: Function; - SyntaxError: typeof SyntaxError; - TypeError: typeof TypeError; - URIError: typeof URIError; - Uint16Array: typeof Uint16Array; - Uint32Array: typeof Uint32Array; - Uint8Array: typeof Uint8Array; - Uint8ClampedArray: Function; - WeakMap: WeakMapConstructor; - WeakSet: WeakSetConstructor; - clearImmediate: (immediateId: any) => void; - clearInterval: (intervalId: NodeJS.Timer) => void; - clearTimeout: (timeoutId: NodeJS.Timer) => void; - console: typeof console; - decodeURI: typeof decodeURI; - decodeURIComponent: typeof decodeURIComponent; - encodeURI: typeof encodeURI; - encodeURIComponent: typeof encodeURIComponent; - escape: (str: string) => string; - eval: typeof eval; - global: Global; - isFinite: typeof isFinite; - isNaN: typeof isNaN; - parseFloat: typeof parseFloat; - parseInt: typeof parseInt; - process: Process; - root: Global; - setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => any; - setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; - setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; - undefined: typeof undefined; - unescape: (str: string) => string; - gc: () => void; - } - - export interface Timer { - ref() : void; - unref() : void; - } -} - -/** - * @deprecated - */ -interface NodeBuffer { - [index: number]: number; - write(string: string, offset?: number, length?: number, encoding?: string): number; - toString(encoding?: string, start?: number, end?: number): string; - toJSON(): any; - length: number; - equals(otherBuffer: Buffer): boolean; - compare(otherBuffer: Buffer): number; - copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; - slice(start?: number, end?: number): Buffer; - writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number; - readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number; - readIntLE(offset: number, byteLength: number, noAssert?: boolean): number; - readIntBE(offset: number, byteLength: number, noAssert?: boolean): number; - readUInt8(offset: number, noAsset?: boolean): number; - readUInt16LE(offset: number, noAssert?: boolean): number; - readUInt16BE(offset: number, noAssert?: boolean): number; - readUInt32LE(offset: number, noAssert?: boolean): number; - readUInt32BE(offset: number, noAssert?: boolean): number; - readInt8(offset: number, noAssert?: boolean): number; - readInt16LE(offset: number, noAssert?: boolean): number; - readInt16BE(offset: number, noAssert?: boolean): number; - readInt32LE(offset: number, noAssert?: boolean): number; - readInt32BE(offset: number, noAssert?: boolean): number; - readFloatLE(offset: number, noAssert?: boolean): number; - readFloatBE(offset: number, noAssert?: boolean): number; - readDoubleLE(offset: number, noAssert?: boolean): number; - readDoubleBE(offset: number, noAssert?: boolean): number; - writeUInt8(value: number, offset: number, noAssert?: boolean): void; - writeUInt16LE(value: number, offset: number, noAssert?: boolean): void; - writeUInt16BE(value: number, offset: number, noAssert?: boolean): void; - writeUInt32LE(value: number, offset: number, noAssert?: boolean): void; - writeUInt32BE(value: number, offset: number, noAssert?: boolean): void; - writeInt8(value: number, offset: number, noAssert?: boolean): void; - writeInt16LE(value: number, offset: number, noAssert?: boolean): void; - writeInt16BE(value: number, offset: number, noAssert?: boolean): void; - writeInt32LE(value: number, offset: number, noAssert?: boolean): void; - writeInt32BE(value: number, offset: number, noAssert?: boolean): void; - writeFloatLE(value: number, offset: number, noAssert?: boolean): void; - writeFloatBE(value: number, offset: number, noAssert?: boolean): void; - writeDoubleLE(value: number, offset: number, noAssert?: boolean): void; - writeDoubleBE(value: number, offset: number, noAssert?: boolean): void; - fill(value: any, offset?: number, end?: number): void; -} - -/************************************************ -* * -* MODULES * -* * -************************************************/ -declare module "buffer" { - export var INSPECT_MAX_BYTES: number; -} - -declare module "querystring" { - export function stringify(obj: any, sep?: string, eq?: string): string; - export function parse(str: string, sep?: string, eq?: string, options?: { maxKeys?: number; }): any; - export function escape(str: string): string; - export function unescape(str: string): string; -} - -declare module "events" { - export class EventEmitter implements NodeJS.EventEmitter { - static listenerCount(emitter: EventEmitter, event: string): number; - - addListener(event: string, listener: Function): EventEmitter; - on(event: string, listener: Function): EventEmitter; - once(event: string, listener: Function): EventEmitter; - removeListener(event: string, listener: Function): EventEmitter; - removeAllListeners(event?: string): EventEmitter; - setMaxListeners(n: number): void; - listeners(event: string): Function[]; - emit(event: string, ...args: any[]): boolean; - } -} - -declare module "http" { - import * as events from "events"; - import * as net from "net"; - import * as stream from "stream"; - - export interface Server extends events.EventEmitter { - listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server; - listen(port: number, hostname?: string, callback?: Function): Server; - listen(path: string, callback?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - close(cb?: any): Server; - address(): { port: number; family: string; address: string; }; - maxHeadersCount: number; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ServerRequest extends IncomingMessage { - connection: net.Socket; - } - export interface ServerResponse extends events.EventEmitter, stream.Writable { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - writeContinue(): void; - writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void; - writeHead(statusCode: number, headers?: any): void; - statusCode: number; - statusMessage: string; - setHeader(name: string, value: string): void; - sendDate: boolean; - getHeader(name: string): string; - removeHeader(name: string): void; - write(chunk: any, encoding?: string): any; - addTrailers(headers: any): void; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - export interface ClientRequest extends events.EventEmitter, stream.Writable { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - write(chunk: any, encoding?: string): void; - abort(): void; - setTimeout(timeout: number, callback?: Function): void; - setNoDelay(noDelay?: boolean): void; - setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - export interface IncomingMessage extends events.EventEmitter, stream.Readable { - httpVersion: string; - headers: any; - rawHeaders: string[]; - trailers: any; - rawTrailers: any; - setTimeout(msecs: number, callback: Function): NodeJS.Timer; - /** - * Only valid for request obtained from http.Server. - */ - method?: string; - /** - * Only valid for request obtained from http.Server. - */ - url?: string; - /** - * Only valid for response obtained from http.ClientRequest. - */ - statusCode?: number; - /** - * Only valid for response obtained from http.ClientRequest. - */ - statusMessage?: string; - socket: net.Socket; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ClientResponse extends IncomingMessage { } - - export interface AgentOptions { - /** - * Keep sockets around in a pool to be used by other requests in the future. Default = false - */ - keepAlive?: boolean; - /** - * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. - * Only relevant if keepAlive is set to true. - */ - keepAliveMsecs?: number; - /** - * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity - */ - maxSockets?: number; - /** - * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. - */ - maxFreeSockets?: number; - } - - export class Agent { - maxSockets: number; - sockets: any; - requests: any; - - constructor(opts?: AgentOptions); - - /** - * Destroy any sockets that are currently in use by the agent. - * It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, - * then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, - * sockets may hang open for quite a long time before the server terminates them. - */ - destroy(): void; - } - - export var METHODS: string[]; - - export var STATUS_CODES: { - [errorCode: number]: string; - [errorCode: string]: string; - }; - export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) =>void ): Server; - export function createClient(port?: number, host?: string): any; - export function request(options: any, callback?: (res: IncomingMessage) => void): ClientRequest; - export function get(options: any, callback?: (res: IncomingMessage) => void): ClientRequest; - export var globalAgent: Agent; -} - -declare module "cluster" { - import * as child from "child_process"; - import * as events from "events"; - - export interface ClusterSettings { - exec?: string; - args?: string[]; - silent?: boolean; - } - - export class Worker extends events.EventEmitter { - id: string; - process: child.ChildProcess; - suicide: boolean; - send(message: any, sendHandle?: any): void; - kill(signal?: string): void; - destroy(signal?: string): void; - disconnect(): void; - } - - export var settings: ClusterSettings; - export var isMaster: boolean; - export var isWorker: boolean; - export function setupMaster(settings?: ClusterSettings): void; - export function fork(env?: any): Worker; - export function disconnect(callback?: Function): void; - export var worker: Worker; - export var workers: Worker[]; - - // Event emitter - export function addListener(event: string, listener: Function): void; - export function on(event: string, listener: Function): any; - export function once(event: string, listener: Function): void; - export function removeListener(event: string, listener: Function): void; - export function removeAllListeners(event?: string): void; - export function setMaxListeners(n: number): void; - export function listeners(event: string): Function[]; - export function emit(event: string, ...args: any[]): boolean; -} - -declare module "zlib" { - import * as stream from "stream"; - export interface ZlibOptions { chunkSize?: number; windowBits?: number; level?: number; memLevel?: number; strategy?: number; dictionary?: any; } - - export interface Gzip extends stream.Transform { } - export interface Gunzip extends stream.Transform { } - export interface Deflate extends stream.Transform { } - export interface Inflate extends stream.Transform { } - export interface DeflateRaw extends stream.Transform { } - export interface InflateRaw extends stream.Transform { } - export interface Unzip extends stream.Transform { } - - export function createGzip(options?: ZlibOptions): Gzip; - export function createGunzip(options?: ZlibOptions): Gunzip; - export function createDeflate(options?: ZlibOptions): Deflate; - export function createInflate(options?: ZlibOptions): Inflate; - export function createDeflateRaw(options?: ZlibOptions): DeflateRaw; - export function createInflateRaw(options?: ZlibOptions): InflateRaw; - export function createUnzip(options?: ZlibOptions): Unzip; - - export function deflate(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function deflateSync(buf: Buffer, options?: ZlibOptions): any; - export function deflateRaw(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function deflateRawSync(buf: Buffer, options?: ZlibOptions): any; - export function gzip(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function gzipSync(buf: Buffer, options?: ZlibOptions): any; - export function gunzip(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function gunzipSync(buf: Buffer, options?: ZlibOptions): any; - export function inflate(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function inflateSync(buf: Buffer, options?: ZlibOptions): any; - export function inflateRaw(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function inflateRawSync(buf: Buffer, options?: ZlibOptions): any; - export function unzip(buf: Buffer, callback: (error: Error, result: any) =>void ): void; - export function unzipSync(buf: Buffer, options?: ZlibOptions): any; - - // Constants - export var Z_NO_FLUSH: number; - export var Z_PARTIAL_FLUSH: number; - export var Z_SYNC_FLUSH: number; - export var Z_FULL_FLUSH: number; - export var Z_FINISH: number; - export var Z_BLOCK: number; - export var Z_TREES: number; - export var Z_OK: number; - export var Z_STREAM_END: number; - export var Z_NEED_DICT: number; - export var Z_ERRNO: number; - export var Z_STREAM_ERROR: number; - export var Z_DATA_ERROR: number; - export var Z_MEM_ERROR: number; - export var Z_BUF_ERROR: number; - export var Z_VERSION_ERROR: number; - export var Z_NO_COMPRESSION: number; - export var Z_BEST_SPEED: number; - export var Z_BEST_COMPRESSION: number; - export var Z_DEFAULT_COMPRESSION: number; - export var Z_FILTERED: number; - export var Z_HUFFMAN_ONLY: number; - export var Z_RLE: number; - export var Z_FIXED: number; - export var Z_DEFAULT_STRATEGY: number; - export var Z_BINARY: number; - export var Z_TEXT: number; - export var Z_ASCII: number; - export var Z_UNKNOWN: number; - export var Z_DEFLATED: number; - export var Z_NULL: number; -} - -declare module "os" { - export function tmpdir(): string; - export function hostname(): string; - export function type(): string; - export function platform(): string; - export function arch(): string; - export function release(): string; - export function uptime(): number; - export function loadavg(): number[]; - export function totalmem(): number; - export function freemem(): number; - export function cpus(): { model: string; speed: number; times: { user: number; nice: number; sys: number; idle: number; irq: number; }; }[]; - export function networkInterfaces(): any; - export var EOL: string; -} - -declare module "https" { - import * as tls from "tls"; - import * as events from "events"; - import * as http from "http"; - - export interface ServerOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - crl?: any; - ciphers?: string; - honorCipherOrder?: boolean; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: any; - SNICallback?: (servername: string) => any; - } - - export interface RequestOptions { - host?: string; - hostname?: string; - port?: number; - path?: string; - method?: string; - headers?: any; - auth?: string; - agent?: any; - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - ciphers?: string; - rejectUnauthorized?: boolean; - } - - export interface Agent { - maxSockets: number; - sockets: any; - requests: any; - } - export var Agent: { - new (options?: RequestOptions): Agent; - }; - export interface Server extends tls.Server { } - export function createServer(options: ServerOptions, requestListener?: Function): Server; - export function request(options: RequestOptions, callback?: (res: http.IncomingMessage) =>void ): http.ClientRequest; - export function get(options: RequestOptions, callback?: (res: http.IncomingMessage) =>void ): http.ClientRequest; - export var globalAgent: Agent; -} - -declare module "punycode" { - export function decode(string: string): string; - export function encode(string: string): string; - export function toUnicode(domain: string): string; - export function toASCII(domain: string): string; - export var ucs2: ucs2; - interface ucs2 { - decode(string: string): string; - encode(codePoints: number[]): string; - } - export var version: any; -} - -declare module "repl" { - import * as stream from "stream"; - import * as events from "events"; - - export interface ReplOptions { - prompt?: string; - input?: NodeJS.ReadableStream; - output?: NodeJS.WritableStream; - terminal?: boolean; - eval?: Function; - useColors?: boolean; - useGlobal?: boolean; - ignoreUndefined?: boolean; - writer?: Function; - } - export function start(options: ReplOptions): events.EventEmitter; -} - -declare module "readline" { - import * as events from "events"; - import * as stream from "stream"; - - export interface ReadLine extends events.EventEmitter { - setPrompt(prompt: string): void; - prompt(preserveCursor?: boolean): void; - question(query: string, callback: Function): void; - pause(): void; - resume(): void; - close(): void; - write(data: any, key?: any): void; - } - export interface ReadLineOptions { - input: NodeJS.ReadableStream; - output: NodeJS.WritableStream; - completer?: Function; - terminal?: boolean; - } - export function createInterface(options: ReadLineOptions): ReadLine; -} - -declare module "vm" { - export interface Context { } - export interface Script { - runInThisContext(): void; - runInNewContext(sandbox?: Context): void; - } - export function runInThisContext(code: string, filename?: string): void; - export function runInNewContext(code: string, sandbox?: Context, filename?: string): void; - export function runInContext(code: string, context: Context, filename?: string): void; - export function createContext(initSandbox?: Context): Context; - export function createScript(code: string, filename?: string): Script; -} - -declare module "child_process" { - import * as events from "events"; - import * as stream from "stream"; - - export interface ChildProcess extends events.EventEmitter { - stdin: stream.Writable; - stdout: stream.Readable; - stderr: stream.Readable; - pid: number; - kill(signal?: string): void; - send(message: any, sendHandle?: any): void; - disconnect(): void; - unref(): void; - } - - export function spawn(command: string, args?: string[], options?: { - cwd?: string; - stdio?: any; - custom?: any; - env?: any; - detached?: boolean; - }): ChildProcess; - export function exec(command: string, options: { - cwd?: string; - stdio?: any; - customFds?: any; - env?: any; - encoding?: string; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - }, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function exec(command: string, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function execFile(file: string, - callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function execFile(file: string, args?: string[], - callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function execFile(file: string, args?: string[], options?: { - cwd?: string; - stdio?: any; - customFds?: any; - env?: any; - encoding?: string; - timeout?: number; - maxBuffer?: string; - killSignal?: string; - }, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function fork(modulePath: string, args?: string[], options?: { - cwd?: string; - env?: any; - encoding?: string; - }): ChildProcess; - export function execSync(command: string, options?: { - cwd?: string; - input?: string|Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - encoding?: string; - }): ChildProcess; - export function execFileSync(command: string, args?: string[], options?: { - cwd?: string; - input?: string|Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - encoding?: string; - }): ChildProcess; -} - -declare module "url" { - export interface Url { - href: string; - protocol: string; - auth: string; - hostname: string; - port: string; - host: string; - pathname: string; - search: string; - query: any; // string | Object - slashes: boolean; - hash?: string; - path?: string; - } - - export interface UrlOptions { - protocol?: string; - auth?: string; - hostname?: string; - port?: string; - host?: string; - pathname?: string; - search?: string; - query?: any; - hash?: string; - path?: string; - } - - export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url; - export function format(url: UrlOptions): string; - export function resolve(from: string, to: string): string; -} - -declare module "dns" { - export function lookup(domain: string, family: number, callback: (err: Error, address: string, family: number) =>void ): string; - export function lookup(domain: string, callback: (err: Error, address: string, family: number) =>void ): string; - export function resolve(domain: string, rrtype: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolve(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolve4(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolve6(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolveMx(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolveTxt(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolveSrv(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolveNs(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function resolveCname(domain: string, callback: (err: Error, addresses: string[]) =>void ): string[]; - export function reverse(ip: string, callback: (err: Error, domains: string[]) =>void ): string[]; -} - -declare module "net" { - import * as stream from "stream"; - - export interface Socket extends stream.Duplex { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - connect(port: number, host?: string, connectionListener?: Function): void; - connect(path: string, connectionListener?: Function): void; - bufferSize: number; - setEncoding(encoding?: string): void; - write(data: any, encoding?: string, callback?: Function): void; - destroy(): void; - pause(): void; - resume(): void; - setTimeout(timeout: number, callback?: Function): void; - setNoDelay(noDelay?: boolean): void; - setKeepAlive(enable?: boolean, initialDelay?: number): void; - address(): { port: number; family: string; address: string; }; - unref(): void; - ref(): void; - - remoteAddress: string; - remoteFamily: string; - remotePort: number; - localAddress: string; - localPort: number; - bytesRead: number; - bytesWritten: number; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - - export var Socket: { - new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket; - }; - - export interface Server extends Socket { - listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server; - listen(path: string, listeningListener?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - close(callback?: Function): Server; - address(): { port: number; family: string; address: string; }; - maxConnections: number; - connections: number; - } - export function createServer(connectionListener?: (socket: Socket) =>void ): Server; - export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) =>void ): Server; - export function connect(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; - export function connect(port: number, host?: string, connectionListener?: Function): Socket; - export function connect(path: string, connectionListener?: Function): Socket; - export function createConnection(options: { allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; - export function createConnection(port: number, host?: string, connectionListener?: Function): Socket; - export function createConnection(path: string, connectionListener?: Function): Socket; - export function isIP(input: string): number; - export function isIPv4(input: string): boolean; - export function isIPv6(input: string): boolean; -} - -declare module "dgram" { - import * as events from "events"; - - interface RemoteInfo { - address: string; - port: number; - size: number; - } - - interface AddressInfo { - address: string; - family: string; - port: number; - } - - export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; - - interface Socket extends events.EventEmitter { - send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void; - bind(port: number, address?: string, callback?: () => void): void; - close(): void; - address(): AddressInfo; - setBroadcast(flag: boolean): void; - setMulticastTTL(ttl: number): void; - setMulticastLoopback(flag: boolean): void; - addMembership(multicastAddress: string, multicastInterface?: string): void; - dropMembership(multicastAddress: string, multicastInterface?: string): void; - } -} - -declare module "fs" { - import * as stream from "stream"; - import * as events from "events"; - - interface Stats { - isFile(): boolean; - isDirectory(): boolean; - isBlockDevice(): boolean; - isCharacterDevice(): boolean; - isSymbolicLink(): boolean; - isFIFO(): boolean; - isSocket(): boolean; - dev: number; - ino: number; - mode: number; - nlink: number; - uid: number; - gid: number; - rdev: number; - size: number; - blksize: number; - blocks: number; - atime: Date; - mtime: Date; - ctime: Date; - } - - interface FSWatcher extends events.EventEmitter { - close(): void; - } - - export interface ReadStream extends stream.Readable { - close(): void; - } - export interface WriteStream extends stream.Writable { - close(): void; - bytesWritten: number; - } - - /** - * Asynchronous rename. - * @param oldPath - * @param newPath - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function rename(oldPath: string, newPath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /** - * Synchronous rename - * @param oldPath - * @param newPath - */ - export function renameSync(oldPath: string, newPath: string): void; - export function truncate(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncate(path: string, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncateSync(path: string, len?: number): void; - export function ftruncate(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function ftruncate(fd: number, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function ftruncateSync(fd: number, len?: number): void; - export function chown(path: string, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chownSync(path: string, uid: number, gid: number): void; - export function fchown(fd: number, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchownSync(fd: number, uid: number, gid: number): void; - export function lchown(path: string, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchownSync(path: string, uid: number, gid: number): void; - export function chmod(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmod(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmodSync(path: string, mode: number): void; - export function chmodSync(path: string, mode: string): void; - export function fchmod(fd: number, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchmod(fd: number, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchmodSync(fd: number, mode: number): void; - export function fchmodSync(fd: number, mode: string): void; - export function lchmod(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmod(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmodSync(path: string, mode: number): void; - export function lchmodSync(path: string, mode: string): void; - export function stat(path: string, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function lstat(path: string, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function fstat(fd: number, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function statSync(path: string): Stats; - export function lstatSync(path: string): Stats; - export function fstatSync(fd: number): Stats; - export function link(srcpath: string, dstpath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function linkSync(srcpath: string, dstpath: string): void; - export function symlink(srcpath: string, dstpath: string, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function symlinkSync(srcpath: string, dstpath: string, type?: string): void; - export function readlink(path: string, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void; - export function readlinkSync(path: string): string; - export function realpath(path: string, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; - export function realpath(path: string, cache: {[path: string]: string}, callback: (err: NodeJS.ErrnoException, resolvedPath: string) =>any): void; - export function realpathSync(path: string, cache?: { [path: string]: string }): string; - /* - * Asynchronous unlink - deletes the file specified in {path} - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function unlink(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous unlink - deletes the file specified in {path} - * - * @param path - */ - export function unlinkSync(path: string): void; - /* - * Asynchronous rmdir - removes the directory specified in {path} - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function rmdir(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous rmdir - removes the directory specified in {path} - * - * @param path - */ - export function rmdirSync(path: string): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdirSync(path: string, mode?: number): void; - /* - * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdirSync(path: string, mode?: string): void; - export function readdir(path: string, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void; - export function readdirSync(path: string): string[]; - export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function closeSync(fd: number): void; - export function open(path: string, flags: string, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; - export function open(path: string, flags: string, mode: number, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; - export function open(path: string, flags: string, mode: string, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; - export function openSync(path: string, flags: string, mode?: number): number; - export function openSync(path: string, flags: string, mode?: string): number; - export function utimes(path: string, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimes(path: string, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimesSync(path: string, atime: number, mtime: number): void; - export function utimesSync(path: string, atime: Date, mtime: Date): void; - export function futimes(fd: number, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function futimes(fd: number, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function futimesSync(fd: number, atime: number, mtime: number): void; - export function futimesSync(fd: number, atime: Date, mtime: Date): void; - export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param encoding - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, options: { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: string) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, options: { flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param encoding - */ - export function readFileSync(filename: string, encoding: string): string; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. - */ - export function readFileSync(filename: string, options: { encoding: string; flag?: string; }): string; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. - */ - export function readFileSync(filename: string, options?: { flag?: string; }): Buffer; - export function writeFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; - export function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void; - export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: (curr: Stats, prev: Stats) => void): void; - export function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void; - export function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher; - export function watch(filename: string, options: { persistent?: boolean; }, listener?: (event: string, filename: string) => any): FSWatcher; - export function exists(path: string, callback?: (exists: boolean) => void): void; - export function existsSync(path: string): boolean; - /** Constant for fs.access(). File is visible to the calling process. */ - export var F_OK: number; - /** Constant for fs.access(). File can be read by the calling process. */ - export var R_OK: number; - /** Constant for fs.access(). File can be written by the calling process. */ - export var W_OK: number; - /** Constant for fs.access(). File can be executed by the calling process. */ - export var X_OK: number; - /** Tests a user's permissions for the file specified by path. */ - export function access(path: string, callback: (err: NodeJS.ErrnoException) => void): void; - export function access(path: string, mode: number, callback: (err: NodeJS.ErrnoException) => void): void; - /** Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise. */ - export function accessSync(path: string, mode ?: number): void; - export function createReadStream(path: string, options?: { - flags?: string; - encoding?: string; - fd?: string; - mode?: number; - bufferSize?: number; - }): ReadStream; - export function createReadStream(path: string, options?: { - flags?: string; - encoding?: string; - fd?: string; - mode?: string; - bufferSize?: number; - }): ReadStream; - export function createWriteStream(path: string, options?: { - flags?: string; - encoding?: string; - string?: string; - }): WriteStream; -} - -declare module "path" { - - /** - * A parsed path object generated by path.parse() or consumed by path.format(). - */ - export interface ParsedPath { - /** - * The root of the path such as '/' or 'c:\' - */ - root: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base: string; - /** - * The file extension (if any) such as '.html' - */ - ext: string; - /** - * The file name without extension (if any) such as 'index' - */ - name: string; - } - - /** - * Normalize a string path, reducing '..' and '.' parts. - * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. - * - * @param p string path to normalize. - */ - export function normalize(p: string): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths string paths to join. - */ - export function join(...paths: any[]): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths string paths to join. - */ - export function join(...paths: string[]): string; - /** - * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. - * - * Starting from leftmost {from} paramter, resolves {to} to an absolute path. - * - * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. - * - * @param pathSegments string paths to join. Non-string arguments are ignored. - */ - export function resolve(...pathSegments: any[]): string; - /** - * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. - * - * @param path path to test. - */ - export function isAbsolute(path: string): boolean; - /** - * Solve the relative path from {from} to {to}. - * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. - * - * @param from - * @param to - */ - export function relative(from: string, to: string): string; - /** - * Return the directory name of a path. Similar to the Unix dirname command. - * - * @param p the path to evaluate. - */ - export function dirname(p: string): string; - /** - * Return the last portion of a path. Similar to the Unix basename command. - * Often used to extract the file name from a fully qualified path. - * - * @param p the path to evaluate. - * @param ext optionally, an extension to remove from the result. - */ - export function basename(p: string, ext?: string): string; - /** - * Return the extension of the path, from the last '.' to end of string in the last portion of the path. - * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string - * - * @param p the path to evaluate. - */ - export function extname(p: string): string; - /** - * The platform-specific file separator. '\\' or '/'. - */ - export var sep: string; - /** - * The platform-specific file delimiter. ';' or ':'. - */ - export var delimiter: string; - /** - * Returns an object from a path string - the opposite of format(). - * - * @param pathString path to evaluate. - */ - export function parse(pathString: string): ParsedPath; - /** - * Returns a path string from an object - the opposite of parse(). - * - * @param pathString path to evaluate. - */ - export function format(pathObject: ParsedPath): string; - - export module posix { - export function normalize(p: string): string; - export function join(...paths: any[]): string; - export function resolve(...pathSegments: any[]): string; - export function isAbsolute(p: string): boolean; - export function relative(from: string, to: string): string; - export function dirname(p: string): string; - export function basename(p: string, ext?: string): string; - export function extname(p: string): string; - export var sep: string; - export var delimiter: string; - export function parse(p: string): ParsedPath; - export function format(pP: ParsedPath): string; - } - - export module win32 { - export function normalize(p: string): string; - export function join(...paths: any[]): string; - export function resolve(...pathSegments: any[]): string; - export function isAbsolute(p: string): boolean; - export function relative(from: string, to: string): string; - export function dirname(p: string): string; - export function basename(p: string, ext?: string): string; - export function extname(p: string): string; - export var sep: string; - export var delimiter: string; - export function parse(p: string): ParsedPath; - export function format(pP: ParsedPath): string; - } -} - -declare module "string_decoder" { - export interface NodeStringDecoder { - write(buffer: Buffer): string; - detectIncompleteChar(buffer: Buffer): number; - } - export var StringDecoder: { - new (encoding: string): NodeStringDecoder; - }; -} - -declare module "tls" { - import * as crypto from "crypto"; - import * as net from "net"; - import * as stream from "stream"; - - var CLIENT_RENEG_LIMIT: number; - var CLIENT_RENEG_WINDOW: number; - - export interface TlsOptions { - pfx?: any; //string or buffer - key?: any; //string or buffer - passphrase?: string; - cert?: any; - ca?: any; //string or buffer - crl?: any; //string or string array - ciphers?: string; - honorCipherOrder?: any; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: any; //array or Buffer; - SNICallback?: (servername: string) => any; - } - - export interface ConnectionOptions { - host?: string; - port?: number; - socket?: net.Socket; - pfx?: any; //string | Buffer - key?: any; //string | Buffer - passphrase?: string; - cert?: any; //string | Buffer - ca?: any; //Array of string | Buffer - rejectUnauthorized?: boolean; - NPNProtocols?: any; //Array of string | Buffer - servername?: string; - } - - export interface Server extends net.Server { - // Extended base methods - listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server; - listen(path: string, listeningListener?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - - listen(port: number, host?: string, callback?: Function): Server; - close(): Server; - address(): { port: number; family: string; address: string; }; - addContext(hostName: string, credentials: { - key: string; - cert: string; - ca: string; - }): void; - maxConnections: number; - connections: number; - } - - export interface ClearTextStream extends stream.Duplex { - authorized: boolean; - authorizationError: Error; - getPeerCertificate(): any; - getCipher: { - name: string; - version: string; - }; - address: { - port: number; - family: string; - address: string; - }; - remoteAddress: string; - remotePort: number; - } - - export interface SecurePair { - encrypted: any; - cleartext: any; - } - - export interface SecureContextOptions { - pfx?: any; //string | buffer - key?: any; //string | buffer - passphrase?: string; - cert?: any; // string | buffer - ca?: any; // string | buffer - crl?: any; // string | string[] - ciphers?: string; - honorCipherOrder?: boolean; - } - - export interface SecureContext { - context: any; - } - - export function createServer(options: TlsOptions, secureConnectionListener?: (cleartextStream: ClearTextStream) =>void ): Server; - export function connect(options: TlsOptions, secureConnectionListener?: () =>void ): ClearTextStream; - export function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () =>void ): ClearTextStream; - export function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () =>void ): ClearTextStream; - export function createSecurePair(credentials?: crypto.Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; - export function createSecureContext(details: SecureContextOptions): SecureContext; -} - -declare module "crypto" { - export interface CredentialDetails { - pfx: string; - key: string; - passphrase: string; - cert: string; - ca: any; //string | string array - crl: any; //string | string array - ciphers: string; - } - export interface Credentials { context?: any; } - export function createCredentials(details: CredentialDetails): Credentials; - export function createHash(algorithm: string): Hash; - export function createHmac(algorithm: string, key: string): Hmac; - export function createHmac(algorithm: string, key: Buffer): Hmac; - interface Hash { - update(data: any, input_encoding?: string): Hash; - digest(encoding: 'buffer'): Buffer; - digest(encoding: string): any; - digest(): Buffer; - } - interface Hmac { - update(data: any, input_encoding?: string): Hmac; - digest(encoding: 'buffer'): Buffer; - digest(encoding: string): any; - digest(): Buffer; - } - export function createCipher(algorithm: string, password: any): Cipher; - export function createCipheriv(algorithm: string, key: any, iv: any): Cipher; - interface Cipher { - update(data: Buffer): Buffer; - update(data: string, input_encoding?: string, output_encoding?: string): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding: boolean): void; - } - export function createDecipher(algorithm: string, password: any): Decipher; - export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher; - interface Decipher { - update(data: Buffer): Buffer; - update(data: string, input_encoding?: string, output_encoding?: string): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding: boolean): void; - } - export function createSign(algorithm: string): Signer; - interface Signer extends NodeJS.WritableStream { - update(data: any): void; - sign(private_key: string, output_format: string): string; - } - export function createVerify(algorith: string): Verify; - interface Verify extends NodeJS.WritableStream { - update(data: any): void; - verify(object: string, signature: string, signature_format?: string): boolean; - } - export function createDiffieHellman(prime_length: number): DiffieHellman; - export function createDiffieHellman(prime: number, encoding?: string): DiffieHellman; - interface DiffieHellman { - generateKeys(encoding?: string): string; - computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string; - getPrime(encoding?: string): string; - getGenerator(encoding: string): string; - getPublicKey(encoding?: string): string; - getPrivateKey(encoding?: string): string; - setPublicKey(public_key: string, encoding?: string): void; - setPrivateKey(public_key: string, encoding?: string): void; - } - export function getDiffieHellman(group_name: string): DiffieHellman; - export function pbkdf2(password: string, salt: string, iterations: number, keylen: number, callback: (err: Error, derivedKey: Buffer) => any): void; - export function pbkdf2(password: string, salt: string, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void; - export function pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number) : Buffer; - export function pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number, digest: string) : Buffer; - export function randomBytes(size: number): Buffer; - export function randomBytes(size: number, callback: (err: Error, buf: Buffer) =>void ): void; - export function pseudoRandomBytes(size: number): Buffer; - export function pseudoRandomBytes(size: number, callback: (err: Error, buf: Buffer) =>void ): void; -} - -declare module "stream" { - import * as events from "events"; - - export interface Stream extends events.EventEmitter { - pipe(destination: T, options?: { end?: boolean; }): T; - } - - export interface ReadableOptions { - highWaterMark?: number; - encoding?: string; - objectMode?: boolean; - } - - export class Readable extends events.EventEmitter implements NodeJS.ReadableStream { - readable: boolean; - constructor(opts?: ReadableOptions); - _read(size: number): void; - read(size?: number): string|Buffer; - setEncoding(encoding: string): void; - pause(): void; - resume(): void; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: string): void; - unshift(chunk: Buffer): void; - wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; - push(chunk: any, encoding?: string): boolean; - } - - export interface WritableOptions { - highWaterMark?: number; - decodeStrings?: boolean; - } - - export class Writable extends events.EventEmitter implements NodeJS.WritableStream { - writable: boolean; - constructor(opts?: WritableOptions); - _write(data: Buffer, encoding: string, callback: Function): void; - _write(data: string, encoding: string, callback: Function): void; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - } - - export interface DuplexOptions extends ReadableOptions, WritableOptions { - allowHalfOpen?: boolean; - } - - // Note: Duplex extends both Readable and Writable. - export class Duplex extends Readable implements NodeJS.ReadWriteStream { - writable: boolean; - constructor(opts?: DuplexOptions); - _write(data: Buffer, encoding: string, callback: Function): void; - _write(data: string, encoding: string, callback: Function): void; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - } - - export interface TransformOptions extends ReadableOptions, WritableOptions {} - - // Note: Transform lacks the _read and _write methods of Readable/Writable. - export class Transform extends events.EventEmitter implements NodeJS.ReadWriteStream { - readable: boolean; - writable: boolean; - constructor(opts?: TransformOptions); - _transform(chunk: Buffer, encoding: string, callback: Function): void; - _transform(chunk: string, encoding: string, callback: Function): void; - _flush(callback: Function): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): void; - resume(): void; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: string): void; - unshift(chunk: Buffer): void; - wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; - push(chunk: any, encoding?: string): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - } - - export class PassThrough extends Transform {} -} - -declare module "util" { - export interface InspectOptions { - showHidden?: boolean; - depth?: number; - colors?: boolean; - customInspect?: boolean; - } - - export function format(format: any, ...param: any[]): string; - export function debug(string: string): void; - export function error(...param: any[]): void; - export function puts(...param: any[]): void; - export function print(...param: any[]): void; - export function log(string: string): void; - export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string; - export function inspect(object: any, options: InspectOptions): string; - export function isArray(object: any): boolean; - export function isRegExp(object: any): boolean; - export function isDate(object: any): boolean; - export function isError(object: any): boolean; - export function inherits(constructor: any, superConstructor: any): void; -} - -declare module "assert" { - function internal (value: any, message?: string): void; - module internal { - export class AssertionError implements Error { - name: string; - message: string; - actual: any; - expected: any; - operator: string; - generatedMessage: boolean; - - constructor(options?: {message?: string; actual?: any; expected?: any; - operator?: string; stackStartFunction?: Function}); - } - - export function fail(actual?: any, expected?: any, message?: string, operator?: string): void; - export function ok(value: any, message?: string): void; - export function equal(actual: any, expected: any, message?: string): void; - export function notEqual(actual: any, expected: any, message?: string): void; - export function deepEqual(actual: any, expected: any, message?: string): void; - export function notDeepEqual(acutal: any, expected: any, message?: string): void; - export function strictEqual(actual: any, expected: any, message?: string): void; - export function notStrictEqual(actual: any, expected: any, message?: string): void; - export var throws: { - (block: Function, message?: string): void; - (block: Function, error: Function, message?: string): void; - (block: Function, error: RegExp, message?: string): void; - (block: Function, error: (err: any) => boolean, message?: string): void; - }; - - export var doesNotThrow: { - (block: Function, message?: string): void; - (block: Function, error: Function, message?: string): void; - (block: Function, error: RegExp, message?: string): void; - (block: Function, error: (err: any) => boolean, message?: string): void; - }; - - export function ifError(value: any): void; - } - - export = internal; -} - -declare module "tty" { - import * as net from "net"; - - export function isatty(fd: number): boolean; - export interface ReadStream extends net.Socket { - isRaw: boolean; - setRawMode(mode: boolean): void; - } - export interface WriteStream extends net.Socket { - columns: number; - rows: number; - } -} - -declare module "domain" { - import * as events from "events"; - - export class Domain extends events.EventEmitter { - run(fn: Function): void; - add(emitter: events.EventEmitter): void; - remove(emitter: events.EventEmitter): void; - bind(cb: (err: Error, data: any) => any): any; - intercept(cb: (data: any) => any): any; - dispose(): void; - - addListener(event: string, listener: Function): Domain; - on(event: string, listener: Function): Domain; - once(event: string, listener: Function): Domain; - removeListener(event: string, listener: Function): Domain; - removeAllListeners(event?: string): Domain; - } - - export function create(): Domain; -} - -declare module "constants" { - export var E2BIG: number; - export var EACCES: number; - export var EADDRINUSE: number; - export var EADDRNOTAVAIL: number; - export var EAFNOSUPPORT: number; - export var EAGAIN: number; - export var EALREADY: number; - export var EBADF: number; - export var EBADMSG: number; - export var EBUSY: number; - export var ECANCELED: number; - export var ECHILD: number; - export var ECONNABORTED: number; - export var ECONNREFUSED: number; - export var ECONNRESET: number; - export var EDEADLK: number; - export var EDESTADDRREQ: number; - export var EDOM: number; - export var EEXIST: number; - export var EFAULT: number; - export var EFBIG: number; - export var EHOSTUNREACH: number; - export var EIDRM: number; - export var EILSEQ: number; - export var EINPROGRESS: number; - export var EINTR: number; - export var EINVAL: number; - export var EIO: number; - export var EISCONN: number; - export var EISDIR: number; - export var ELOOP: number; - export var EMFILE: number; - export var EMLINK: number; - export var EMSGSIZE: number; - export var ENAMETOOLONG: number; - export var ENETDOWN: number; - export var ENETRESET: number; - export var ENETUNREACH: number; - export var ENFILE: number; - export var ENOBUFS: number; - export var ENODATA: number; - export var ENODEV: number; - export var ENOENT: number; - export var ENOEXEC: number; - export var ENOLCK: number; - export var ENOLINK: number; - export var ENOMEM: number; - export var ENOMSG: number; - export var ENOPROTOOPT: number; - export var ENOSPC: number; - export var ENOSR: number; - export var ENOSTR: number; - export var ENOSYS: number; - export var ENOTCONN: number; - export var ENOTDIR: number; - export var ENOTEMPTY: number; - export var ENOTSOCK: number; - export var ENOTSUP: number; - export var ENOTTY: number; - export var ENXIO: number; - export var EOPNOTSUPP: number; - export var EOVERFLOW: number; - export var EPERM: number; - export var EPIPE: number; - export var EPROTO: number; - export var EPROTONOSUPPORT: number; - export var EPROTOTYPE: number; - export var ERANGE: number; - export var EROFS: number; - export var ESPIPE: number; - export var ESRCH: number; - export var ETIME: number; - export var ETIMEDOUT: number; - export var ETXTBSY: number; - export var EWOULDBLOCK: number; - export var EXDEV: number; - export var WSAEINTR: number; - export var WSAEBADF: number; - export var WSAEACCES: number; - export var WSAEFAULT: number; - export var WSAEINVAL: number; - export var WSAEMFILE: number; - export var WSAEWOULDBLOCK: number; - export var WSAEINPROGRESS: number; - export var WSAEALREADY: number; - export var WSAENOTSOCK: number; - export var WSAEDESTADDRREQ: number; - export var WSAEMSGSIZE: number; - export var WSAEPROTOTYPE: number; - export var WSAENOPROTOOPT: number; - export var WSAEPROTONOSUPPORT: number; - export var WSAESOCKTNOSUPPORT: number; - export var WSAEOPNOTSUPP: number; - export var WSAEPFNOSUPPORT: number; - export var WSAEAFNOSUPPORT: number; - export var WSAEADDRINUSE: number; - export var WSAEADDRNOTAVAIL: number; - export var WSAENETDOWN: number; - export var WSAENETUNREACH: number; - export var WSAENETRESET: number; - export var WSAECONNABORTED: number; - export var WSAECONNRESET: number; - export var WSAENOBUFS: number; - export var WSAEISCONN: number; - export var WSAENOTCONN: number; - export var WSAESHUTDOWN: number; - export var WSAETOOMANYREFS: number; - export var WSAETIMEDOUT: number; - export var WSAECONNREFUSED: number; - export var WSAELOOP: number; - export var WSAENAMETOOLONG: number; - export var WSAEHOSTDOWN: number; - export var WSAEHOSTUNREACH: number; - export var WSAENOTEMPTY: number; - export var WSAEPROCLIM: number; - export var WSAEUSERS: number; - export var WSAEDQUOT: number; - export var WSAESTALE: number; - export var WSAEREMOTE: number; - export var WSASYSNOTREADY: number; - export var WSAVERNOTSUPPORTED: number; - export var WSANOTINITIALISED: number; - export var WSAEDISCON: number; - export var WSAENOMORE: number; - export var WSAECANCELLED: number; - export var WSAEINVALIDPROCTABLE: number; - export var WSAEINVALIDPROVIDER: number; - export var WSAEPROVIDERFAILEDINIT: number; - export var WSASYSCALLFAILURE: number; - export var WSASERVICE_NOT_FOUND: number; - export var WSATYPE_NOT_FOUND: number; - export var WSA_E_NO_MORE: number; - export var WSA_E_CANCELLED: number; - export var WSAEREFUSED: number; - export var SIGHUP: number; - export var SIGINT: number; - export var SIGILL: number; - export var SIGABRT: number; - export var SIGFPE: number; - export var SIGKILL: number; - export var SIGSEGV: number; - export var SIGTERM: number; - export var SIGBREAK: number; - export var SIGWINCH: number; - export var SSL_OP_ALL: number; - export var SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; - export var SSL_OP_CIPHER_SERVER_PREFERENCE: number; - export var SSL_OP_CISCO_ANYCONNECT: number; - export var SSL_OP_COOKIE_EXCHANGE: number; - export var SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; - export var SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; - export var SSL_OP_EPHEMERAL_RSA: number; - export var SSL_OP_LEGACY_SERVER_CONNECT: number; - export var SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; - export var SSL_OP_MICROSOFT_SESS_ID_BUG: number; - export var SSL_OP_MSIE_SSLV2_RSA_PADDING: number; - export var SSL_OP_NETSCAPE_CA_DN_BUG: number; - export var SSL_OP_NETSCAPE_CHALLENGE_BUG: number; - export var SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; - export var SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; - export var SSL_OP_NO_COMPRESSION: number; - export var SSL_OP_NO_QUERY_MTU: number; - export var SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; - export var SSL_OP_NO_SSLv2: number; - export var SSL_OP_NO_SSLv3: number; - export var SSL_OP_NO_TICKET: number; - export var SSL_OP_NO_TLSv1: number; - export var SSL_OP_NO_TLSv1_1: number; - export var SSL_OP_NO_TLSv1_2: number; - export var SSL_OP_PKCS1_CHECK_1: number; - export var SSL_OP_PKCS1_CHECK_2: number; - export var SSL_OP_SINGLE_DH_USE: number; - export var SSL_OP_SINGLE_ECDH_USE: number; - export var SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; - export var SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; - export var SSL_OP_TLS_BLOCK_PADDING_BUG: number; - export var SSL_OP_TLS_D5_BUG: number; - export var SSL_OP_TLS_ROLLBACK_BUG: number; - export var ENGINE_METHOD_DSA: number; - export var ENGINE_METHOD_DH: number; - export var ENGINE_METHOD_RAND: number; - export var ENGINE_METHOD_ECDH: number; - export var ENGINE_METHOD_ECDSA: number; - export var ENGINE_METHOD_CIPHERS: number; - export var ENGINE_METHOD_DIGESTS: number; - export var ENGINE_METHOD_STORE: number; - export var ENGINE_METHOD_PKEY_METHS: number; - export var ENGINE_METHOD_PKEY_ASN1_METHS: number; - export var ENGINE_METHOD_ALL: number; - export var ENGINE_METHOD_NONE: number; - export var DH_CHECK_P_NOT_SAFE_PRIME: number; - export var DH_CHECK_P_NOT_PRIME: number; - export var DH_UNABLE_TO_CHECK_GENERATOR: number; - export var DH_NOT_SUITABLE_GENERATOR: number; - export var NPN_ENABLED: number; - export var RSA_PKCS1_PADDING: number; - export var RSA_SSLV23_PADDING: number; - export var RSA_NO_PADDING: number; - export var RSA_PKCS1_OAEP_PADDING: number; - export var RSA_X931_PADDING: number; - export var RSA_PKCS1_PSS_PADDING: number; - export var POINT_CONVERSION_COMPRESSED: number; - export var POINT_CONVERSION_UNCOMPRESSED: number; - export var POINT_CONVERSION_HYBRID: number; - export var O_RDONLY: number; - export var O_WRONLY: number; - export var O_RDWR: number; - export var S_IFMT: number; - export var S_IFREG: number; - export var S_IFDIR: number; - export var S_IFCHR: number; - export var S_IFLNK: number; - export var O_CREAT: number; - export var O_EXCL: number; - export var O_TRUNC: number; - export var O_APPEND: number; - export var F_OK: number; - export var R_OK: number; - export var W_OK: number; - export var X_OK: number; - export var UV_UDP_REUSEADDR: number; -} diff --git a/src/typings/tsd.d.ts b/src/typings/tsd.d.ts deleted file mode 100644 index da8d837..0000000 --- a/src/typings/tsd.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -/// -/// -/// -/// -/// diff --git a/src/typings/winston/winston.d.ts b/src/typings/winston/winston.d.ts deleted file mode 100644 index 30ca712..0000000 --- a/src/typings/winston/winston.d.ts +++ /dev/null @@ -1,300 +0,0 @@ -// Type definitions for winston -// Project: https://github.com/flatiron/winston -// Definitions by: bonnici , Peter Harris -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -// Imported from: https://github.com/soywiz/typescript-node-definitions/winston.d.ts - -/// - -declare module "winston" { - export var transports: Transports; - export var Transport: TransportStatic; - export var Logger: LoggerStatic; - export var Container: ContainerStatic; - export var loggers: ContainerInstance; - export var defaultLogger: LoggerInstance; - - export var exitOnError: boolean; - export var level: string; - - export function log(level: string, msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - export function log(level: string, msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - export function debug(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - export function debug(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - export function info(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - export function info(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - export function warn(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - export function warn(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - export function error(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - export function error(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - export function query(options: QueryOptions, callback?: (err: Error, results: any) => void): any; - export function query(callback: (err: Error, results: any) => void): any; - export function stream(options?: any): NodeJS.ReadableStream; - export function handleExceptions(...transports: TransportInstance[]): void; - export function unhandleExceptions(...transports: TransportInstance[]): void; - export function add(transport: TransportInstance, options?: TransportOptions, created?: boolean): LoggerInstance; - export function clear(): void; - export function remove(transport: TransportInstance): LoggerInstance; - export function startTimer(): ProfileHandler; - export function profile(id: string, msg?: string, meta?: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - export function addColors(target: any): any; - export function setLevels(target: any): any; - export function cli(): LoggerInstance; - - - export interface LoggerStatic { - new (options?: LoggerOptions): LoggerInstance; - } - - export interface LoggerInstance extends NodeJS.EventEmitter { - extend(target: any): LoggerInstance; - - log(level: string, msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - log(level: string, msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - debug(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - debug(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - info(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - info(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - warn(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - warn(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - error(msg: string, meta: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - error(msg: string, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - query(options: QueryOptions, callback?: (err: Error, results: any) => void): any; - query(callback: (err: Error, results: any) => void): any; - stream(options?: any): NodeJS.ReadableStream; - close(): void; - handleExceptions(...transports: TransportInstance[]): void; - unhandleExceptions(...transports: TransportInstance[]): void; - add(transport: TransportInstance, options?: TransportOptions, created?: boolean): LoggerInstance; - addRewriter(rewriter: TransportInstance): TransportInstance[]; - clear(): void; - remove(transport: TransportInstance): LoggerInstance; - startTimer(): ProfileHandler; - profile(id: string, msg?: string, meta?: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): LoggerInstance; - - setLevels(target: any): any; - cli(): LoggerInstance; - } - - export interface LoggerOptions { - transports?: TransportInstance[]; - rewriters?: TransportInstance[]; - exceptionHandlers?: TransportInstance[]; - handleExceptions?: boolean; - - /** - * @type {(boolean|(err: Error) => void)} - */ - exitOnError?: any; - - // TODO: Need to make instances specific, - // and need to get options for each instance. - // Unfortunately, the documentation is unhelpful. - [optionName: string]: any; - } - - export interface TransportStatic { - new (options?: TransportOptions): TransportInstance; - } - - export interface TransportInstance extends TransportStatic, NodeJS.EventEmitter { - formatQuery(query: (string|Object)): (string|Object); - normalizeQuery(options: QueryOptions): QueryOptions; - formatResults(results: (Object|Array), options?: Object): (Object|Array); - logException(msg: string, meta: Object, callback: () => void): void; - } - - export interface ConsoleTransportInstance extends TransportInstance { - new (options?: ConsoleTransportOptions): ConsoleTransportInstance; - } - - export interface DailyRotateFileTransportInstance extends TransportInstance { - new (options?: DailyRotateFileTransportOptions): DailyRotateFileTransportInstance; - } - - export interface FileTransportInstance extends TransportInstance { - new (options?: FileTransportOptions): FileTransportInstance; - } - - export interface HttpTransportInstance extends TransportInstance { - new (options?: HttpTransportOptions): HttpTransportInstance; - } - - export interface MemoryTransportInstance extends TransportInstance { - new (options?: MemoryTransportOptions): MemoryTransportInstance; - } - - export interface WebhookTransportInstance extends TransportInstance { - new (options?: WebhookTransportOptions): WebhookTransportInstance; - } - - export interface WinstonModuleTrasportInstance extends TransportInstance { - new (options?: WinstonMoudleTransportOptions): WinstonModuleTrasportInstance; - } - - export interface ContainerStatic { - new (options: LoggerOptions): ContainerInstance; - } - - export interface ContainerInstance extends ContainerStatic { - get(id: string, options?: LoggerOptions): LoggerInstance; - add(id: string, options: LoggerOptions): LoggerInstance; - has(id: string): boolean; - close(id: string): void; - options: LoggerOptions; - loggers: any; - default: LoggerOptions; - } - - export interface Transports { - File: FileTransportInstance; - Console: ConsoleTransportInstance; - Loggly: WinstonModuleTrasportInstance; - DailyRotateFile: DailyRotateFileTransportInstance; - Http: HttpTransportInstance; - Memory: MemoryTransportInstance; - Webhook: WebhookTransportInstance; - } - - export interface TransportOptions { - level?: string; - silent?: boolean; - raw?: boolean; - name?: string; - formatter?: Function; - handleExceptions?: boolean; - exceptionsLevel?: string; - humanReadableUnhandledException?: boolean; - } - - export interface ConsoleTransportOptions extends TransportOptions { - json?: boolean; - colorize?: boolean; - prettyPrint?: boolean; - timestamp?: (Function|boolean); - showLevel?: boolean; - label?: string; - logstash?: boolean; - debugStdout?: boolean; - depth?: number; - } - - export interface DailyRotateFileTransportOptions extends TransportOptions { - json?: boolean; - colorize?: boolean; - prettyPrint?: boolean; - timestamp?: (Function|boolean); - showLevel?: boolean; - label?: string; - logstash?: boolean; - depth?: number; - maxsize?: number; - maxFiles?: number; - eol?: string; - maxRetries?: number; - datePattern?: string; - filename?: string; - dirname?: string; - options?: { - flags?: string; - highWaterMark?: number; - } - stream?: NodeJS.WritableStream; - } - - export interface FileTransportOptions extends TransportOptions { - json?: boolean; - colorize?: boolean; - prettyPrint?: boolean; - timestamp?: (Function|boolean); - showLevel?: boolean; - label?: string; - logstash?: boolean; - depth?: number; - maxsize?: number; - rotationFormat?: boolean; - zippedArchive?: boolean; - maxFiles?: number; - eol?: string; - tailable?: boolean; - maxRetries?: number; - filename?: string; - dirname?: string; - options?: { - flags?: string; - highWaterMark?: number; - } - stream?: NodeJS.WritableStream; - } - - export interface HttpTransportOptions extends TransportOptions { - ssl?: boolean; - host?: string; - port?: number; - auth?: { - username: string; - password: string; - }; - path?: string; - } - - export interface MemoryTransportOptions extends TransportOptions { - json?: boolean; - colorize?: boolean; - prettyPrint?: boolean; - timestamp?: (Function|boolean); - showLevel?: boolean; - label?: string; - depth?: number; - } - - export interface WebhookTransportOptions extends TransportOptions { - host?: string; - port?: number; - method?: string; - path?: string; - auth?: { - username?: string; - password?: string; - }; - ssl?: { - key?: any; - cert?: any; - ca: any; - }; - } - - export interface WinstonMoudleTransportOptions extends TransportOptions { - [optionName: string]: any; - } - - export interface QueryOptions { - rows?: number; - limit?: number; - start?: number; - from?: Date; - until?: Date; - /** - * 'asc' or 'desc' - */ - order?: string; - fields: any; - } - - export interface ProfileHandler { - logger: LoggerInstance; - start: Date; - done: (msg: string) => LoggerInstance; - } -} diff --git a/test/bot.test.js b/test/bot.test.js new file mode 100644 index 0000000..4d7f23e --- /dev/null +++ b/test/bot.test.js @@ -0,0 +1,211 @@ +'use strict'; + +const test = require('blue-tape'); +const Bot = require(process.env.PWD + '/lib/bot'); +const configDist = require(process.env.PWD + '/config.default.js'); + +test('Bot: instantiate and set config', (assert) => { + const bot = new Bot(configDist); + assert.equal(bot.config, configDist); + assert.end(); +}); + +test('Bot: build issue links', (assert) => { + const bot = new Bot(configDist); + const issueKey = 'Test-1'; + const expectedLink = `https://jira.yourhost.domain:443/browse/${issueKey}`; + + assert.equal(bot.buildIssueLink(issueKey), expectedLink); + assert.end(); +}); + +test('Bot: build issue links correctly with base', (assert) => { + configDist.jira.base = 'foo'; + const bot = new Bot(configDist); + const issueKey = 'TEST-1'; + const expectedLink = `https://jira.yourhost.domain:443/foo/browse/${issueKey}`; + assert.equal(bot.buildIssueLink(issueKey), expectedLink); + assert.end(); +}); + +test('Bot: parse a sprint name from greenhopper field', (assert) => { + const bot = new Bot(configDist); + const sprintName = 'TEST'; + const exampleSprint = [ + `derpry-derp-derp,name=${sprintName},foo`, + ]; + + assert.equal(bot.parseSprint(exampleSprint), sprintName); + assert.notOk(bot.parseSprint(['busted'])); + assert.end(); +}); + +test('Bot: parse a sprint name from the last sprint in the greenhopper field', (assert) => { + const bot = new Bot(configDist); + const sprintName = 'TEST'; + const exampleSprint = [ + `derpry-derp-derp,name=${sprintName}1,foo`, + `derpry-derp-derp,name=${sprintName}2,foo`, + `derpry-derp-derp,name=${sprintName}3,foo`, + ]; + + assert.equal(bot.parseSprint(exampleSprint), sprintName + '3'); + assert.end(); +}); + +test('Bot: translate a jira username to a slack username', (assert) => { + configDist.usermap = { + 'foo': 'bar', + 'fizz': 'buzz', + 'ping': 'pong', + }; + + const bot = new Bot(configDist); + + assert.equal(bot.jira2Slack('foo'), '@bar'); + assert.equal(bot.jira2Slack('ping'), '@pong'); + assert.notOk(bot.jira2Slack('blap')); + assert.end(); +}); + +test('Bot: parse unique jira tickets from a message', (assert) => { + const bot = new Bot(configDist); + assert.deepEqual(bot.parseTickets('Chan', 'blarty blar TEST-1'), ['TEST-1']); + assert.deepEqual(bot.parseTickets('Chan', 'blarty blar TEST-2 TEST-2'), ['TEST-2']); + assert.deepEqual(bot.parseTickets('Chan', 'blarty blar TEST-3 TEST-4'), ['TEST-3', 'TEST-4']); + assert.deepEqual(bot.parseTickets('Chan', 'blarty blar Test-1 Test-1'), []); + assert.end(); +}); + +test('Bot: handle empty message/channel', (assert) => { + const bot = new Bot(configDist); + assert.deepEqual(bot.parseTickets('Chan', null), []); + assert.deepEqual(bot.parseTickets(null, 'Foo'), []); + assert.end(); +}); + +test('Bot: populate the ticket buffer', (assert) => { + const bot = new Bot(configDist); + const ticket = 'TEST-1'; + const channel = 'Test'; + const hash = bot.hashTicket(channel, ticket); + + assert.deepEqual(bot.parseTickets(channel, 'foo ' + ticket), [ticket]); + assert.ok(bot.ticketBuffer.get(hash)); + + // Expect the ticket to not be repeated + assert.deepEqual(bot.parseTickets(channel, 'foo ' + ticket), []); + assert.end(); +}); + +test('Bot: respond to the same ticket in different channels', (assert) => { + const bot = new Bot(configDist); + const ticket = 'TEST-1'; + const channel1 = 'Test1'; + const channel2 = 'Test2'; + + assert.deepEqual(bot.parseTickets(channel1, 'foo ' + ticket), [ticket]); + assert.deepEqual(bot.parseTickets(channel2, 'foo ' + ticket), [ticket]); + assert.end(); +}); + +test('Bot: cleanup the ticket buffer', (assert) => { + const bot = new Bot(configDist); + const ticket = 'TEST-1'; + const channel = 'Test'; + const hash = bot.hashTicket(channel, ticket); + + assert.deepEqual(bot.parseTickets(channel, 'foo ' + ticket), [ticket]); + assert.ok(bot.ticketBuffer.get(hash)); + + // set the Ticket Buffer Length low to trigger the cleanup + bot.TICKET_BUFFER_LENGTH = -1; + bot.cleanupTicketBuffer(); + assert.notOk(bot.ticketBuffer.get(hash)); + + assert.end(); +}); + +test('Bot: return a default description if empty', (assert) => { + const bot = new Bot(configDist); + assert.equal(bot.formatIssueDescription(''), 'Ticket does not contain a description'); + assert.end(); +}); + +test('Bot: replace quotes', (assert) => { + const bot = new Bot(configDist); + assert.equal(bot.formatIssueDescription('{quote}foo{quote}'), '```foo```'); + assert.end(); +}); + +test('Bot: replace code blocks', (assert) => { + const bot = new Bot(configDist); + assert.equal(bot.formatIssueDescription('{code}foo{code}'), '```foo```'); + assert.end(); +}); + +test('Bot: show custom fields', (assert) => { + assert.plan(5); + const issue = { + key: 'TEST-1', + fields: { + created: '2015-05-01T00:00:00.000', + updated: '2015-05-01T00:01:00.000', + summary: 'Blarty', + description: 'Foo foo foo foo foo foo', + status: { + name: 'Open', + }, + priority: { + name: 'Low', + }, + reporter: { + name: 'bob', + displayName: 'Bob', + }, + assignee: { + name: 'fred', + displayName: 'Fred', + }, + customfield_10000: 'Fizz', + customfield_10001: [ + { value: 'Buzz' }, + ], + }, + }; + + // Add some custom fields + configDist.jira.customFields.customfield_10000 = 'CF1'; + configDist.jira.customFields['customfield_10001[0].value'] = 'CF2'; + configDist.jira.customFields['customfield_10003 && exit()'] = 'Nope1'; + configDist.jira.customFields['customfield_10004; exit()'] = 'Nope2'; + configDist.jira.customFields.customfield_10005 = 'Nope3'; + + const bot = new Bot(configDist); + const response = bot.issueResponse(issue); + + let x; + for (x in response.fields) { + if (response.fields.hasOwnProperty(x)) { + switch (response.fields[x].title) { + case configDist.jira.customFields.customfield_10000: + assert.equal(response.fields[x].value, issue.fields.customfield_10000); + break; + case configDist.jira.customFields['customfield_10001[0].value']: + assert.equal(response.fields[x].value, issue.fields.customfield_10001[0].value); + break; + case configDist.jira.customFields['customfield_10003 && exit()']: + assert.equal(response.fields[x].value, 'Invalid characters in customfield_10003 && exit()'); + break; + case configDist.jira.customFields['customfield_10004; exit()']: + assert.equal(response.fields[x].value, 'Invalid characters in customfield_10004; exit()'); + break; + case configDist.jira.customFields.customfield_10005: + assert.equal(response.fields[x].value, 'Unable to read customfield_10005'); + break; + default: + // nothing to see here + } + } + } +}); diff --git a/test/config.test.js b/test/config.test.js new file mode 100644 index 0000000..3f10818 --- /dev/null +++ b/test/config.test.js @@ -0,0 +1,47 @@ +'use strict'; + +const test = require('blue-tape'); +const Config = require(process.env.PWD + '/lib/config'); +const rawConfig = require(process.env.PWD + '/config.default'); + +test('Config: Config: parse the string \'true\' into a boolean true', (assert) => { + assert.equal(Config.parseBool('true'), true); + assert.equal(Config.parseBool('True'), true); + assert.equal(Config.parseBool('TRUE'), true); + assert.end(); +}); + +test('Config: parse the string \'1\' into a boolean true', (assert) => { + assert.equal(Config.parseBool('1'), true); + assert.end(); +}); + +test('Config: parse any other string into a boolean false', (assert) => { + assert.equal(Config.parseBool('false'), false); + assert.equal(Config.parseBool('lksjfljksdf'), false); + assert.equal(Config.parseBool('nope'), false); + assert.end(); +}); + +test('Config: pass the original value if not a string', (assert) => { + assert.equal(Config.parseBool(1), 1); + assert.end(); +}); + +test('Config: parse default config as is', (assert) => { + assert.equal(Config.parse(rawConfig), rawConfig); + assert.end(); +}); + +test('Config: use env values over file values', (assert) => { + process.env.JIRA_PORT = 3333; + const conf = Config.parse(rawConfig); + + assert.equal(conf.jira.port, 3333); + assert.end(); +}); + +test('Config: throw an error if config is not an object', (assert) => { + assert.throws(Config.parse.bind(null, 'foo'), /Config is not an object/); + assert.end(); +}); diff --git a/test/logger.test.js b/test/logger.test.js new file mode 100644 index 0000000..aab0a02 --- /dev/null +++ b/test/logger.test.js @@ -0,0 +1,9 @@ +'use strict'; + +const test = require('blue-tape'); + +test('Logger: create an instance of logger', (assert) => { + const logger = require(process.env.PWD + '/lib/logger')(); + assert.ok(logger); + assert.end(); +});