playov2-js-utilities 0.2.2 → 0.2.6

package/lib/index.js

@@ -3,5 +3,5 @@ module.exports = {
     ratings : require('./ratings/index'),
     constants : require('./constants'),
     playoUtils : require('./util'),
-    notificationTemplates = require('./notification-templates')
+    NotificationTemplates : require('./notification-templates')
 };

package/lib/notification-templates.js

@@ -1,20 +1,69 @@
-
+/**
+ * Template for sending notification whenever someone posts a questions on any activity.
+ * Notification is received by host and the co-host of the activity.
+ * text render only
+ * @param {String} user_first_name - first name of the user who posted the question
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const query_from_joinee = {
     heading: 'You have a new query! 🧐',
-    text: '{{user_first_name}} has a query for your {{sport_name}} game on {{date}}. Tap to respond.'
+    text: '{{user_first_name}} has a query for your {{sport_name}} game on {{date}}. Tap to respond.',
+    buttons: []
 };
 
+/**
+ * Template for sending notification whenever host/ cohost respond to an activity query.
+ * Notification is received by OP.
+ * text render only
+ * @param {String} host_first_name - first name of the host/ cohost who responded to the question
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const host_response_to_query = {
     heading: 'Your query has been answered! ✅',
     text: '{{host_first_name}} has responded to your query for the {{sport_name}} game on {{date}}. Tap to read.'
 };
 
+/**
+ * Template for sending notification whenever any user sends a request to join any activity.
+ * Notification is received by host & / cohost.
+ * text render only
+ * @param {String} user_first_name - first name of the user who posted the question
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const activity_join_request = {
-    heading: '{{user_first_name}} wants to join your game! 🙌',
-    text: '!!'
+    heading: 'You have a new game request! 🙌',
+    text: '{{user_first_name}} has requested to join your {{sport_name}} game happening on {{date}}.',
+    additional_message_text: {
+        text: 'They have a message for you! Tap to read',
+        default: 'Let them know if you\'re game.'
+    }
+};
+
+/**
+ * Template for sending notification whenever any host/cohost accepts an user's request to join any activity.
+ * Notification is received by the request joinee .
+ * heading render also!
+ * @param {String} host_first_name - first name of the host/cohost who accepted the request
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
+ const activity_request_accepted = {
+    heading: '{{host_first_name}} has accepted your request! 🥳',
+    text: 'You\'re on for the {{sport_name}} game on {{date}}. You can now chat with your game squad.'
 };
 
-const activity_request_accepted = {
+/**
+ * Template for sending notification whenever any host/cohost declines an user's request to join any activity.
+ * Notification is received by the request joinee .
+ * text render only
+ * @param {String} host_first_name - first name of the  host/cohost who rejected the request
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
+const activity_request_declined = {
     heading: 'Your request has been declined. 😟',
     text: '{{host_first_name}} declined your request to join the {{sport_name}} game on {{date}}.',
     additional_message_text: {
@@ -23,16 +72,40 @@ const activity_request_accepted = {
     }
 };
 
+/**
+ * Template for sending notification whenever any host/cohost invites an user to join any activity.
+ * Notification is received by the requested joinee .
+ * text render only
+ * @param {String} host_first_name - first name of the host/cohost who invited the user
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const user_invited_by_host = {
     heading: 'You have a new invite! 📩',
     text: '{{host_first_name}} has invited you to the {{sport_name}} game on {{date}}. Are you game? 💪'
 };
 
+/**
+ * Template for sending notification whenever any requested joinee accepts the request to join the activity.
+ * Notification is received by the host/cohost .
+ * text render only
+ * @param {String} user_first_name - first name of the user who accepted the request
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const user_accepted_invite = {
     heading: 'Your invite has been accepted! 🤝',
     text: '{{user_first_name}} has accepted your request for the {{sport_name}} game on {{date}}.'
 };
 
+/**
+ * Template for sending notification whenever any requested joinee declines the request to join the activity.
+ * Notification is received by the requested host/cohost .
+ * text render only
+ * @param {String} user_first_name - first name of the  user who rejected the request
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const user_declined_invite = {
     heading: 'Your invite has been declined. 😟',
     text: '{{user_first_name}} has declined your request for the {{sport_name}} game on {{date}}.',
@@ -42,6 +115,14 @@ const user_declined_invite = {
     }
 };
 
+/**
+ * Template for sending notification whenever any host/cohost revokes the request to join the activity.
+ * Notification is received by the requested joinee .
+ * text render only
+ * @param {String} host_first_name - first name of the  user who cancelled the invite
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const host_revoked_invite = {
     heading: 'Your invite has been cancelled 😕 ',
     text: '{{host_first_name}} has cancelled your invitation to the {{sport_name}} game on {{date}}.',
@@ -51,6 +132,14 @@ const host_revoked_invite = {
     }
 };
 
+/**
+ * Template for sending notification whenever any host/cohost retires an user for an activity.
+ * Notification is received by the joinee .
+ * text render only
+ * @param {String} host_first_name - first name of the  host/cohost who retired the user
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const host_retired_user = {
     heading: 'You have been made to retire. 😕 ',
     text: 'You are no longer a part of {{sport_name}} game on {{date}}.',
@@ -60,6 +149,14 @@ const host_retired_user = {
     }
 };
 
+/**
+ * Template for sending notification whenever any  user leaves an activity.
+ * Notification is received by the host/cohost .
+ * text render only
+ * @param {String} user_first_name - first name of the  user who left the game
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const user_left_game = {
     heading: 'Player has left the game.',
     text: '{{user_first_name}} has left {{date}}\'s  {{sport_name}} game.',
@@ -69,6 +166,14 @@ const user_left_game = {
     }
 };
 
+/**
+ * Template for sending notification whenever any activity is cancelled.
+ * Notification is received by all the players of the activity (except the host) .
+ * text render only
+ * @param {String} host_first_name - first name of the  user who left the request
+ * @param {String} sport_name - 
+ * @param {String} date - Activity's date
+ */
 const host_cancelled_activity = {
     heading: 'Oops, your game has been cancelled! 😩',
     text: '{{host_first_name}} has cancelled your {{sport_name}} for {{date}}. Wanna join another game? '
@@ -91,6 +196,7 @@ module.exports = {
     host_response_to_query,
     activity_join_request,
     activity_request_accepted,
+    activity_request_declined,
     user_accepted_invite,
     user_declined_invite,
     user_invited_by_host,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playov2-js-utilities",
-  "version": "0.2.2",
+  "version": "0.2.6",
   "description": "Private package for JS utility functions",
   "main": "index.js",
   "scripts": {