bespoke-convenient

var bespoke = require('bespoke'),
  convenient = require('bespoke-convenient');

var cv = convenient.builder("myplugin");

var cv = bespoke.plugins.convenient.builder("myplugin");

// convenient.builder(pluginName)
// bespoke.plugins.convenient.builder(pluginName)
// Convenient plugin level functions - create the variable cv in your plugin.
var cv = convenient.builder("myplugin");

// cv.activateDeck(deck)
// Activate convenient features and return an object with functions bound to the deck.
var cvBoundToDeck = cv.activateDeck(deck);

// cv.getStorage(deck)
// cvBoundToDeck.getStorage()
// Get a plugin storage object for the deck. Prior deck activation is required.
// Useful if you store state per deck, not for the entire plugin.
var storage = cvBoundToDeck.getStorage();
storage.anything = "Here you can save any options and state for this particular deck.";
storage.whatever = { happens: "happens" };

// cv.generateErrorObject(message)
// An error object with a prefixed error message.
throw cv.generateErrorObject("Look, sometimes bad things happen, and there is nothing you can do about it, so why worry? -- Simba, The Lion King");

// cv.fire(deck, eventName, innerEvent, slide, customData)
// cvBoundToDeck.fire(eventName, innerEvent, slide, customData)
// Fire an event on the deck, with plugin name etcetera filled in.
// innerEvent: either a DOM/browser event or a bespoke event
// slide: either the index of the affected slide, or the slide object itself
var success = cvBoundToDeck.fire("myevent", e, 123, { someExtraPluginData: "data value", somePluginStatus: 999 });

// cv.createEventData(deck, eventNamespace, eventName, innerEvent, slide, eventData)
// cvBoundToDeck.createEventData(eventNamespace, eventName, innerEvent, slide, eventData)
// Creates the event same object used by cvBoundToDeck.fire(...).
var eventData = cvBoundToDeck.createEventData();

// convenient.copyArray(array)
// Mostly useful for function arguments
var args = convenient.copyArray(arguments);

// cv.log([object], ...)
// Log a prefixed log message, by default to the developer console
cv.log("Something", "happened", 1974);