playov2-js-utilities 0.3.70 → 0.3.74

package/lib/notification-templates.js

@@ -1,255 +1,255 @@
-const { notificationIds } = require('./notification.config');
-
-/**
- * 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.',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_QUERY
-};
-
-/**
- * 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.',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_QUERY_ANSWERED
-};
-
-/**
- * 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: '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.'
-    },
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_REQUEST_MANAGE
-};
-
-/**
- * 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: 'Request accepted! 🥳',
-    text: 'You\'re on for the {{sport_name}} game on {{date}}. You can now chat with your game squad.',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_REQUEST_RESPONSE
-};
-
-/**
- * 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: 'Request declined. 😟',
-    text: '{{host_first_name}} declined your request to join the {{sport_name}} game on {{date}}.',
-    additional_message_text: {
-        text: 'They have a message for you! Tap to read.',
-        default: 'No worries, other games are waiting for you! Join them now. 😀'
-    },
-    buttons: [],
-    notificationId: notificationIds.HOST_RETIRED
-};
-
-/**
- * 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: 'New game invite! 📩',
-    text: '{{host_first_name}} has invited you to the {{sport_name}} game on {{date}}. Are you game? 💪',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_INVITATION
-};
-
-/**
- * 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: 'Game invite accepted! 🤝',
-    text: '{{user_first_name}} has accepted your invite for the {{sport_name}} game on {{date}}.',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_INVITATION_RESPONSE
-};
-
-/**
- * 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: 'Game invite declined. 😟',
-    text: '{{user_first_name}} has declined your invite for the {{sport_name}} game on {{date}}.',
-    additional_message_text: {
-        text: 'They have a message for you! Tap to read.',
-        default: 'Tap to invite other players.'
-    },
-    buttons: [],
-    notificationId: notificationIds.HOST_RETIRED
-};
-
-/**
- * Template for sending notification whenever any host/cohost revokes the request to join the activity.
- * Notification is received by the requested joinee . -- Document wherever it's being used
- * 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: 'Game invite cancelled 😕',
-    text: '{{host_first_name}} has cancelled your invitation to the {{sport_name}} game on {{date}}.',
-    additional_message_text: {
-        text: 'They have a message for you! Tap to read.',
-        default: 'But, you can always join another game!'
-    },
-    buttons: [],
-    notificationId: notificationIds.HOST_RETIRED
-};
-
-/**
- * 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}}.',
-    additional_message_text: {
-        text: '{{host_first_name}} has a message for you! Tap to read',
-        default: 'But, you can always join another game!'
-    },
-    buttons: [],
-    notificationId: notificationIds.HOST_RETIRED
-};
-
-/**
- * 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.',
-    additional_message_text: {
-        text: 'They have a message for you! Tap to read.',
-        default: 'Tap to invite other players.'
-    },
-    buttons: [],
-    notificationId: notificationIds.HOST_RETIRED
-};
-
-/**
- * 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? ',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_CANCEL
-};
-
-/**
- * Template for sending activity reminder.
- * Notification is received by all the players of the activity.
- * Text render only
- * @param {String} sport_name
- * @param {String} date
- */
-const activity_reminder = {
-    heading: 'Activity Reminder',
-    text: 'You have a {{sport_name}} game coming up at {{date}}. Gear up for some fun!',
-    buttons: [],
-    notificationId: notificationIds.ACTIVITY_REMINDER
-};
-
-const host_updated_activity_details = {
-    // ??
-};
-
-const host_tagged_venue = {
-    // ??
-};
-
-const host_booked_venue = {
-    // ??
-};
-
-const dm_request = {
-    heading: 'New message request 💭',
-    text: '{{user_name}} has messaged you on Playo. Tap to see.',
-    buttons: [],
-    notificationId: notificationIds.MESSAGE_REQUEST
-}
-
-module.exports = {
-    query_from_joinee,
-    host_response_to_query,
-    activity_join_request,
-    activity_request_accepted,
-    activity_request_declined,
-    user_accepted_invite,
-    user_declined_invite,
-    user_invited_by_host,
-    host_revoked_invite,
-    host_retired_user,
-    user_left_game,
-    host_cancelled_activity,
-    activity_reminder,
-    dm_request
+const { notificationIds } = require('./notification.config');
+
+/**
+ * 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.',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_QUERY
+};
+
+/**
+ * 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.',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_QUERY_ANSWERED
+};
+
+/**
+ * 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: '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.'
+    },
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_REQUEST_MANAGE
+};
+
+/**
+ * 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: 'Request accepted! 🥳',
+    text: 'You\'re on for the {{sport_name}} game on {{date}}. You can now chat with your game squad.',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_REQUEST_RESPONSE
+};
+
+/**
+ * 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: 'Request declined. 😟',
+    text: '{{host_first_name}} declined your request to join the {{sport_name}} game on {{date}}.',
+    additional_message_text: {
+        text: 'They have a message for you! Tap to read.',
+        default: 'No worries, other games are waiting for you! Join them now. 😀'
+    },
+    buttons: [],
+    notificationId: notificationIds.HOST_RETIRED
+};
+
+/**
+ * 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: 'New game invite! 📩',
+    text: '{{host_first_name}} has invited you to the {{sport_name}} game on {{date}}. Are you game? 💪',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_INVITATION
+};
+
+/**
+ * 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: 'Game invite accepted! 🤝',
+    text: '{{user_first_name}} has accepted your invite for the {{sport_name}} game on {{date}}.',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_INVITATION_RESPONSE
+};
+
+/**
+ * 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: 'Game invite declined. 😟',
+    text: '{{user_first_name}} has declined your invite for the {{sport_name}} game on {{date}}.',
+    additional_message_text: {
+        text: 'They have a message for you! Tap to read.',
+        default: 'Tap to invite other players.'
+    },
+    buttons: [],
+    notificationId: notificationIds.HOST_RETIRED
+};
+
+/**
+ * Template for sending notification whenever any host/cohost revokes the request to join the activity.
+ * Notification is received by the requested joinee . -- Document wherever it's being used
+ * 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: 'Game invite cancelled 😕',
+    text: '{{host_first_name}} has cancelled your invitation to the {{sport_name}} game on {{date}}.',
+    additional_message_text: {
+        text: 'They have a message for you! Tap to read.',
+        default: 'But, you can always join another game!'
+    },
+    buttons: [],
+    notificationId: notificationIds.HOST_RETIRED
+};
+
+/**
+ * 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}}.',
+    additional_message_text: {
+        text: '{{host_first_name}} has a message for you! Tap to read',
+        default: 'But, you can always join another game!'
+    },
+    buttons: [],
+    notificationId: notificationIds.HOST_RETIRED
+};
+
+/**
+ * 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.',
+    additional_message_text: {
+        text: 'They have a message for you! Tap to read.',
+        default: 'Tap to invite other players.'
+    },
+    buttons: [],
+    notificationId: notificationIds.HOST_RETIRED
+};
+
+/**
+ * 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? ',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_CANCEL
+};
+
+/**
+ * Template for sending activity reminder.
+ * Notification is received by all the players of the activity.
+ * Text render only
+ * @param {String} sport_name
+ * @param {String} date
+ */
+const activity_reminder = {
+    heading: 'Activity Reminder',
+    text: 'You have a {{sport_name}} game coming up at {{date}}. Gear up for some fun!',
+    buttons: [],
+    notificationId: notificationIds.ACTIVITY_REMINDER
+};
+
+const host_updated_activity_details = {
+    // ??
+};
+
+const host_tagged_venue = {
+    // ??
+};
+
+const host_booked_venue = {
+    // ??
+};
+
+const dm_request = {
+    heading: 'New message request 💭',
+    text: '{{user_name}} has messaged you on Playo. Tap to see.',
+    buttons: [],
+    notificationId: notificationIds.MESSAGE_REQUEST
+}
+
+module.exports = {
+    query_from_joinee,
+    host_response_to_query,
+    activity_join_request,
+    activity_request_accepted,
+    activity_request_declined,
+    user_accepted_invite,
+    user_declined_invite,
+    user_invited_by_host,
+    host_revoked_invite,
+    host_retired_user,
+    user_left_game,
+    host_cancelled_activity,
+    activity_reminder,
+    dm_request
 }