messaging-api-messenger - npm Package Compare versions

Comparing version 0.1.0-2 to 0.1.0

package.json

 {
   "name": "messaging-api-messenger",
   "description": "Messaging API client for Messenger",
-  "version": "0.1.0-2",
+  "version": "0.1.0",
   "repository": {
@@ -6,0 +6,0 @@ "type": "git",

README.md

@@ -40,4 +40,6 @@ # messaging-api-messenger
 
-## Allowed Methods
+## Supported Methods
 
+All methods return a Promise resolves an API response.
+
 ### User
@@ -49,2 +51,5 @@
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference)  
+[Content types](https://developers.facebook.com/docs/messenger-platform/send-api-reference/contenttypes)
+
 - `sendRawBody`
@@ -60,4 +65,7 @@ - `send`
 - `sendTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/templates)
 - `sendButtonTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/button-template)
 - `sendGenericTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/generic-template)
 - `sendShippingUpdateTemplate`
@@ -67,9 +75,17 @@ - `sendReservationUpdateTemplate`
 - `sendListTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/list-template)
 - `sendReceiptTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/receipt-template)
 - `sendAirlineBoardingPassTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/airline-boardingpass-template)
 - `sendAirlineCheckinTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/airline-checkin-template)
 - `sendAirlineItineraryTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/airline-itinerary-template)
 - `sendAirlineFlightUpdateTemplate`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/airline-update-template)
 - `sendQuickReplies`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/quick-replies)
 - `sendSenderAction`
+  - [Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/sender-actions)
 - `turnTypingIndicatorsOn`
@@ -80,2 +96,4 @@ - `turnTypingIndicatorsOff`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/send-api-reference/attachment-upload/v2.8)
+
 - `uploadAttachment`
@@ -89,2 +107,4 @@ - `uploadAudio`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile)
+
 #### Messenger Profile
@@ -98,2 +118,4 @@
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/get-started-button)
+
 - `getGetStartedButton`
@@ -105,2 +127,4 @@ - `setGetStartedButton`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/persistent-menu)
+
 - `getPersistentMenu`
@@ -112,2 +136,4 @@ - `setPersistentMenu`
 
+[Officail docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/greeting-text)
+
 - `getGreetingText`
@@ -119,2 +145,4 @@ - `setGreetingText`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/domain-whitelisting)
+
 - `getDomainWhitelist`
@@ -126,2 +154,4 @@ - `setDomainWhitelist`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/account-linking-url)
+
 - `getAccountLinkingURL`
@@ -133,2 +163,4 @@ - `setAccountLinkingURL`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/payment-settings)
+
 - `getPaymentSettings`
@@ -142,4 +174,6 @@ - `setPaymentPrivacyPolicyURL`
 
+[Official docs](https://developers.facebook.com/docs/messenger-platform/messenger-profile/target-audience)
+
 - `getTargetAudience`
 - `setTargetAudience`
 - `deleteTargetAudience`

src/MessengerClient.js

@@ -21,2 +21,3 @@ import axios from 'axios';
   AirlineFlightUpdateAttributes,
+  PersistentMenu,
   MessengerProfile,
@@ -123,6 +124,14 @@ MessengerProfileResponse,
   setPersistentMenu = (
-    menuItems: Array<MenuItem>,
+    menuItems: Array<MenuItem> | PersistentMenu,
     { inputDisabled = false }: { inputDisabled: boolean } = {}
-  ): Promise<MutationSuccessResponse> =>
-    this.setMessengerProfile({
+  ): Promise<MutationSuccessResponse> => {
+    // menuItems is in type PersistentMenu
+    if (menuItems.some(item => item.locale === 'default')) {
+      return this.setMessengerProfile({
+        persistent_menu: menuItems,
+      });
+    }
+
+    // menuItems is in type Array<MenuItem>
+    return this.setMessengerProfile({
       persistent_menu: [
@@ -136,2 +145,3 @@ {
     });
+  };
 
@@ -138,0 +148,0 @@ deletePersistentMenu = (): Promise<MutationSuccessResponse> =>

src/MessengerTypes.js

@@ -194,2 +194,8 @@ /* @flow */
 
+export type PersistentMenu = Array<{
+  locale: string,
+  composer_input_disabled: boolean,
+  call_to_actions: Array<MenuItem>,
+}>;
+
 export type MessengerProfile = {
@@ -199,7 +205,3 @@ get_started?: {
   },
-  persistent_menu?: Array<{
-    locale: string,
-    composer_input_disabled: boolean,
-    call_to_actions: Array<TemplateButton>,
-  }>,
+  persistent_menu?: PersistentMenu,
   greeting?: Array<{
@@ -206,0 +208,0 @@ locale: string,

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

118121

increased by8.9%

Lines of code

3357

increased by7.25%

Number of lines in readme file

167

increased by25.56%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes