messaging-api-messenger - npm Package Compare versions

Comparing version 1.0.0-beta.24 to 1.0.0-beta.25

dist/browser.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessengerBatch = exports.Messenger = void 0;
 const Messenger_1 = __importDefault(require("./Messenger"));
@@ -8,0 +9,0 @@ exports.Messenger = Messenger_1.default;

dist/index.js

 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessengerTypes = exports.MessengerClient = exports.MessengerBatch = exports.Messenger = void 0;
 const Messenger_1 = __importDefault(require("./Messenger"));
@@ -14,0 +27,0 @@ exports.Messenger = Messenger_1.default;

dist/Messenger.js

@@ -12,3 +12,5 @@ "use strict";
     // snakecase support for backward compatibility
-    const quickReplies = options.quickReplies || options.quick_replies;
+    const quickReplies = options.quickReplies ||
+        // @ts-expect-error
+        options.quick_replies;
     if (quickReplies && Array.isArray(quickReplies) && quickReplies.length >= 1) {
@@ -25,3 +27,5 @@ message.quickReplies = quickReplies;
     // snakecase support for backward compatibility
-    const quickReplies = options.quickReplies || options.quick_replies;
+    const quickReplies = options.quickReplies ||
+        // @ts-expect-error
+        options.quick_replies;
     if (quickReplies && Array.isArray(quickReplies) && quickReplies.length >= 1) {
@@ -28,0 +32,0 @@ message.quickReplies = quickReplies;

dist/MessengerClient.d.ts

@@ -6,2 +6,5 @@ import FormData from 'form-data';
 export default class MessengerClient {
+    /**
+     * @deprecated Use `new MessengerClient(...)` instead.
+     */
     static connect(accessTokenOrConfig: string | Types.ClientConfig, version?: string): MessengerClient;
@@ -103,3 +106,3 @@ _onRequest: OnRequestFunction | undefined;
     getPersistentMenu(options?: Types.AccessTokenOptions): Promise<Types.PersistentMenu | null>;
-    setPersistentMenu(menuItems: Types.MenuItem[] | Types.PersistentMenu, { composerInputDisabled, ...options }?: {
+    setPersistentMenu(menuItems: Types.MenuItem[] | Types.PersistentMenuItem[], { composerInputDisabled, ...options }?: {
         composerInputDisabled?: boolean;
@@ -115,3 +118,3 @@ accessToken?: string;
     getUserPersistentMenu(userId: string, { accessToken: customAccessToken }?: Types.AccessTokenOptions): Promise<Types.PersistentMenu | null>;
-    setUserPersistentMenu(userId: string, menuItems: Types.MenuItem[] | Types.PersistentMenu, { composerInputDisabled, accessToken: customAccessToken, }?: {
+    setUserPersistentMenu(userId: string, menuItems: Types.MenuItem[] | Types.PersistentMenuItem[], { composerInputDisabled, accessToken: customAccessToken, }?: {
         composerInputDisabled?: boolean;
@@ -183,3 +186,3 @@ accessToken?: string;
     sendMessage(psidOrRecipient: Types.PsidOrRecipient, message: Types.Message, options?: Types.SendOption): Promise<Types.SendMessageSuccessResponse>;
-    sendMessageFormData(psidOrRecipient: Types.PsidOrRecipient, formdata: FormData, options?: Types.SendOption): Promise<any>;
+    sendMessageFormData(psidOrRecipient: Types.PsidOrRecipient, formdata: FormData, options?: Types.SendOption): Promise<Types.SendMessageSuccessResponse>;
     /**
@@ -420,4 +423,4 @@ * Content Types
     setNLPConfigs(config?: Types.MessengerNLPConfig, { accessToken: customAccessToken }?: Types.AccessTokenOptions): Promise<any>;
-    enableNLP(options?: Record<string, any>): Promise<any>;
-    disableNLP(options?: Record<string, any>): Promise<any>;
+    enableNLP(options?: Types.AccessTokenOptions): Promise<any>;
+    disableNLP(options?: Types.AccessTokenOptions): Promise<any>;
     /**
@@ -424,0 +427,0 @@ * Logging Custom Events

dist/MessengerClient.js

@@ -38,2 +38,3 @@ "use strict";
 const omit_1 = __importDefault(require("lodash/omit"));
+const warning_1 = __importDefault(require("warning"));
 const messaging_api_common_1 = require("messaging-api-common");
@@ -85,2 +86,4 @@ const Messenger_1 = __importDefault(require("./Messenger"));
             transformRequest: [
+                // axios use any as type of the data in AxiosTransformer
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 (data) => data && isPlainObject_1.default(data) ? messaging_api_common_1.snakecaseKeysDeep(data) : data,
@@ -93,2 +96,4 @@ ...axios_1.default.defaults.transformRequest,
                 ...axios_1.default.defaults.transformResponse,
+                // axios use any as type of the data in AxiosTransformer
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 (data) => data && isPlainObject_1.default(data) ? messaging_api_common_1.camelcaseKeysDeep(data) : data,
@@ -144,3 +149,7 @@ ],
     }
+    /**
+     * @deprecated Use `new MessengerClient(...)` instead.
+     */
     static connect(accessTokenOrConfig, version = '6.0') {
+        warning_1.default(false, '`MessengerClient.connect(...)` is deprecated. Use `new MessengerClient(...)` instead.');
         return new MessengerClient(accessTokenOrConfig, version);
@@ -322,4 +331,4 @@ }
         var { composerInputDisabled = false } = _a, options = __rest(_a, ["composerInputDisabled"]);
-        // menuItems is in type PersistentMenu
-        if (menuItems.some((item) => item.locale === 'default')) {
+        // locale is in type PersistentMenuItem
+        if (menuItems.some((item) => 'locale' in item && item.locale === 'default')) {
             return this.setMessengerProfile({
@@ -357,4 +366,4 @@ persistentMenu: menuItems,
     setUserPersistentMenu(userId, menuItems, { composerInputDisabled = false, accessToken: customAccessToken, } = {}) {
-        // menuItems is in type PersistentMenu
-        if (menuItems.some((item) => item.locale === 'default')) {
+        // locale is in type PersistentMenuItem
+        if (menuItems.some((item) => 'locale' in item && item.locale === 'default')) {
             return this._axios
@@ -921,3 +930,2 @@ .post(`/me/custom_user_settings?access_token=${customAccessToken ||
      */
-    // FIXME: [type] return type
     getInsights(metrics, options = {}) {
@@ -924,0 +932,0 @@ return this._axios

dist/MessengerTypes.d.ts

@@ -324,7 +324,8 @@ /// <reference types="node" />
 };
-export declare type PersistentMenu = {
+export declare type PersistentMenuItem = {
     locale: string;
     composerInputDisabled: boolean;
     callToActions: MenuItem[];
-}[];
+};
+export declare type PersistentMenu = PersistentMenuItem[];
 export declare type GreetingConfig = {
@@ -331,0 +332,0 @@ locale: string;

package.json

@@ -9,3 +9,3 @@ {
   },
-  "version": "1.0.0-beta.24",
+  "version": "1.0.0-beta.25",
   "main": "dist/index.js",
@@ -33,3 +33,3 @@ "browser": "lib/browser.js",
   },
-  "gitHead": "18258941a920ed2aabf7b12f17e10e8c14238c15"
+  "gitHead": "5cca124548cbd6d36cafbdfb3ce6856fd338dbe3"
 }

src/__tests__/MessengerClient-handover.spec.ts

@@ -19,3 +19,3 @@ import MockAdapter from 'axios-mock-adapter';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient(ACCESS_TOKEN);
@@ -22,0 +22,0 @@ const mock = new MockAdapter(client.axios);

src/__tests__/MessengerClient-insights.spec.ts

@@ -18,3 +18,3 @@ import MockAdapter from 'axios-mock-adapter';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient(ACCESS_TOKEN);
@@ -21,0 +21,0 @@ const mock = new MockAdapter(client.axios);

src/__tests__/MessengerClient-persona.spec.ts

@@ -18,3 +18,3 @@ import MockAdapter from 'axios-mock-adapter';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient(ACCESS_TOKEN);
@@ -21,0 +21,0 @@ const mock = new MockAdapter(client.axios);

src/__tests__/MessengerClient-profile.spec.ts

@@ -19,3 +19,3 @@ import MockAdapter from 'axios-mock-adapter';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient(ACCESS_TOKEN);
@@ -22,0 +22,0 @@ const mock = new MockAdapter(client.axios);

src/__tests__/MessengerClient-send.spec.ts

@@ -24,3 +24,3 @@ import fs from 'fs';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient(ACCESS_TOKEN);
@@ -437,3 +437,3 @@ const mock = new MockAdapter(client.axios);
             {
-              contentType: 'text' as any, // FIXME: use enum
+              contentType: 'text',
               title: 'Search',
@@ -537,3 +537,4 @@ payload: '<POSTBACK_PAYLOAD>',
         {
-          quickReplies: {} as any,
+          // @ts-expect-error
+          quickReplies: {},
         }
@@ -540,0 +541,0 @@ );

src/__tests__/MessengerClient-sendTemplate.spec.ts

@@ -19,3 +19,3 @@ import MockAdapter from 'axios-mock-adapter';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient(ACCESS_TOKEN);
@@ -22,0 +22,0 @@ const mock = new MockAdapter(client.axios);

src/__tests__/MessengerClient.spec.ts

@@ -25,3 +25,3 @@ import fs from 'fs';
 
-const createMock = () => {
+const createMock = (): { client: MessengerClient; mock: MockAdapter } => {
   const client = new MessengerClient({
@@ -28,0 +28,0 @@ appId: APP_ID,

src/Messenger.ts

@@ -16,3 +16,6 @@ import FormData from 'form-data';
   // snakecase support for backward compatibility
-  const quickReplies = options.quickReplies || (options as any).quick_replies;
+  const quickReplies =
+    options.quickReplies ||
+    // @ts-expect-error
+    options.quick_replies;
 
@@ -43,3 +46,6 @@ if (quickReplies && Array.isArray(quickReplies) && quickReplies.length >= 1) {
   // snakecase support for backward compatibility
-  const quickReplies = options.quickReplies || (options as any).quick_replies;
+  const quickReplies =
+    options.quickReplies ||
+    // @ts-expect-error
+    options.quick_replies;
 
@@ -46,0 +52,0 @@ if (quickReplies && Array.isArray(quickReplies) && quickReplies.length >= 1) {

src/MessengerClient.ts

@@ -14,2 +14,3 @@ import crypto from 'crypto';
 import omit from 'lodash/omit';
+import warning from 'warning';
 import {
@@ -42,2 +43,5 @@ OnRequestFunction,
 export default class MessengerClient {
+  /**
+   * @deprecated Use `new MessengerClient(...)` instead.
+   */
   static connect(
@@ -47,2 +51,6 @@ accessTokenOrConfig: string | Types.ClientConfig,
   ): MessengerClient {
+    warning(
+      false,
+      '`MessengerClient.connect(...)` is deprecated. Use `new MessengerClient(...)` instead.'
+    );
     return new MessengerClient(accessTokenOrConfig, version);
@@ -105,3 +113,5 @@ }
       transformRequest: [
-        (data: any) =>
+        // axios use any as type of the data in AxiosTransformer
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (data: any): any =>
           data && isPlainObject(data) ? snakecaseKeysDeep(data) : data,
@@ -115,3 +125,5 @@ ...(axios.defaults.transformRequest as AxiosTransformer[]),
         ...(axios.defaults.transformResponse as AxiosTransformer[]),
-        (data: any) =>
+        // axios use any as type of the data in AxiosTransformer
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (data: any): any =>
           data && isPlainObject(data) ? camelcaseKeysDeep(data) : data,
@@ -378,3 +390,3 @@ ],
     return this._axios
-      .get(
+      .get<Types.User>(
         `/${userId}?fields=${fields.join(
@@ -397,3 +409,3 @@ ','
     return this._axios
-      .get(
+      .get<{ data: Types.MessengerProfile[] }>(
         `/me/messenger_profile?fields=${fields.join(
@@ -411,3 +423,3 @@ ','
     return this._axios
-      .post(
+      .post<Types.MutationSuccessResponse>(
         `/me/messenger_profile?access_token=${customAccessToken ||
@@ -425,3 +437,3 @@ this._accessToken}`,
     return this._axios
-      .delete(
+      .delete<Types.MutationSuccessResponse>(
         `/me/messenger_profile?access_token=${customAccessToken ||
@@ -491,3 +503,3 @@ this._accessToken}`,
   setPersistentMenu(
-    menuItems: Types.MenuItem[] | Types.PersistentMenu,
+    menuItems: Types.MenuItem[] | Types.PersistentMenuItem[],
     {
@@ -501,5 +513,8 @@ composerInputDisabled = false,
   ): Promise<Types.MutationSuccessResponse> {
-    // menuItems is in type PersistentMenu
+    // locale is in type PersistentMenuItem
     if (
-      menuItems.some((item: Record<string, any>) => item.locale === 'default')
+      menuItems.some(
+        (item: Types.MenuItem | Types.PersistentMenuItem) =>
+          'locale' in item && item.locale === 'default'
+      )
     ) {
@@ -560,3 +575,3 @@ return this.setMessengerProfile(
     userId: string,
-    menuItems: Types.MenuItem[] | Types.PersistentMenu,
+    menuItems: Types.MenuItem[] | Types.PersistentMenuItem[],
     {
@@ -570,8 +585,11 @@ composerInputDisabled = false,
   ): Promise<Types.MutationSuccessResponse> {
-    // menuItems is in type PersistentMenu
+    // locale is in type PersistentMenuItem
     if (
-      menuItems.some((item: Record<string, any>) => item.locale === 'default')
+      menuItems.some(
+        (item: Types.MenuItem | Types.PersistentMenuItem) =>
+          'locale' in item && item.locale === 'default'
+      )
     ) {
       return this._axios
-        .post(
+        .post<Types.MutationSuccessResponse>(
           `/me/custom_user_settings?access_token=${customAccessToken ||
@@ -824,3 +842,3 @@ this._accessToken}`,
     return this._axios
-      .get(
+      .get<{ data: Types.MessageTagResponse }>(
         `/page_message_tags?access_token=${customAccessToken ||
@@ -843,3 +861,3 @@ this._accessToken}`
     return this._axios
-      .post(
+      .post<Types.SendMessageSuccessResponse>(
         `/me/messages?access_token=${customAccessToken || this._accessToken}`,
@@ -883,3 +901,3 @@ body
     options: Types.SendOption = {}
-  ) {
+  ): Promise<Types.SendMessageSuccessResponse> {
     const recipient =
@@ -903,3 +921,3 @@ typeof psidOrRecipient === 'string'
     return this._axios
-      .post(
+      .post<Types.SendMessageSuccessResponse>(
         `/me/messages?access_token=${options.accessToken || this._accessToken}`,
@@ -1650,3 +1668,2 @@ formdata,
    */
-  // FIXME: [type] return type
   getInsights(
@@ -1742,3 +1759,3 @@ metrics: Types.InsightMetric[],
     { accessToken: customAccessToken }: Types.AccessTokenOptions = {}
-  ) {
+  ): Promise<any> {
     return this._axios
@@ -1757,3 +1774,3 @@ .post(
   // FIXME: [type] return type
-  enableNLP(options: Record<string, any> = {}) {
+  enableNLP(options: Types.AccessTokenOptions = {}): Promise<any> {
     return this.setNLPConfigs({ nlpEnabled: true }, options);
@@ -1763,3 +1780,3 @@ }
   // FIXME: [type] return type
-  disableNLP(options: Record<string, any> = {}) {
+  disableNLP(options: Types.AccessTokenOptions = {}): Promise<any> {
     return this.setNLPConfigs({ nlpEnabled: false }, options);
@@ -1766,0 +1783,0 @@ }

src/MessengerTypes.ts

@@ -428,8 +428,10 @@ import fs from 'fs';
 
-export type PersistentMenu = {
+export type PersistentMenuItem = {
   locale: string;
   composerInputDisabled: boolean;
   callToActions: MenuItem[];
-}[];
+};
 
+export type PersistentMenu = PersistentMenuItem[];
+
 export type GreetingConfig = {
@@ -436,0 +438,0 @@ locale: string;

No alert changes

Improved metrics

Total package byte prevSize

738010

increased by1.1%

Lines of code

13061

increased by0.42%

No dependency changes