toasted-notifier/notifiers/growl.js

Push notifications in NodeJS for MacOS, Windows 7 - 11, and Linux (Growl as fallback)

/**
 * Wrapper for the growly module
 */
const checkGrowl = require( '../lib/checkGrowl' );
const utils = require( '../lib/utils' );
const growly = require( 'growly' );

const EventEmitter = require( 'events' ).EventEmitter;
const util = require( 'util' );

const errorMessageNotFound = 'Couldn\'t connect to growl (might be used as a fallback). Make sure it is running';

module.exports = Growl;

let hasGrowl;

function Growl( options )
{
    options = utils.clone( options || {});

    if ( !( this instanceof Growl ) )
        return new Growl( options );

    growly.appname = options.name || 'Node';
    this.options = options;

    EventEmitter.call( this );
}
util.inherits( Growl, EventEmitter );

function notifyRaw( options, callback )
{
    growly.setHost( this.options.host, this.options.port );
    options = utils.clone( options || {});

    if ( typeof options === 'string' )
        options = { title: 'toasted-notifier', message: options };

    callback = utils.actionJackerDecorator( this, options, callback, ( data ) =>
    {
        if ( data === 'click' )
            return 'click';

        if ( data === 'timedout' )
            return 'timeout';

        return false;
    });

    options = utils.mapToGrowl( options );

    if ( !options.message )
    {
        callback( new Error( 'Message is required.' ) );
        return this;
    }

    options.title = options.title || 'Example Notification:';

    if ( hasGrowl || !!options.wait )
    {
        const localCallback = options.wait ? callback : noop;
        growly.notify( options.message, options, localCallback );
        if ( !options.wait ) callback();
        return this;
    }

    checkGrowl( growly, ( _, didHaveGrowl ) =>
    {
        hasGrowl = didHaveGrowl;
        if ( !didHaveGrowl ) return callback( new Error( errorMessageNotFound ) );
        growly.notify( options.message, options );
        callback();
    });

    return this;
}

Object.defineProperty( Growl.prototype, 'notify',
{
    get: function ()
    {
        if ( !this._notify ) this._notify = notifyRaw.bind( this );
        return this._notify;
    }
});

function noop() {}