Merge pull request #686 from Telegram-Mini-Apps/bugfix/fix-invalid-show-popup-typings

Bugfix/fix invalid show popup typings

Author: heyqbnk

.changeset/calm-horses-drop.md

@@ -0,0 +1,5 @@
+---
+"@telegram-apps/sdk": patch
+---
+
+Fix ivalid typings in `openPopup` function.

packages/sdk/src/scopes/components/popup/exports.ts

@@ -4,9 +4,15 @@ export {
   open as openPopup,
   openError as openPopupError,
   openPromise as openPopupPromise,
+  isShown as isPopupShown,
+  show as showPopup,
+  showError as showPopupError,
+  showPromise as showPopupPromise,
 } from './exports.variable.js';
 export * as popup from './exports.variable.js';
 export type {
   OpenOptions as OpenPopupOptions,
   OpenOptionsButton as OpenPopupOptionsButton,
-} from './types.js';
+  ShowOptionsButton as ShowPopupOptionsButton,
+  ShowOptions as ShowPopupOptions,
+} from './types.js';

packages/sdk/src/scopes/components/popup/exports.variable.ts

@@ -1 +1,11 @@
-export { isOpened, open, isSupported, openPromise, openError } from './popup.js';
+export {
+  isOpened,
+  open,
+  isSupported,
+  openPromise,
+  openError,
+  showError,
+  show,
+  showPromise,
+  isShown,
+} from './popup.js';

packages/sdk/src/scopes/components/popup/popup.ts

@@ -1,10 +1,12 @@
+import type { AbortablePromise } from 'better-promises';
+
 import { request } from '@/globals.js';
 import { createIsSupported } from '@/scopes/createIsSupported.js';
 import { createWrapSupported } from '@/scopes/wrappers/createWrapSupported.js';
 import { defineNonConcurrentFn } from '@/scopes/defineNonConcurrentFn.js';
 
 import { prepareParams } from './prepareParams.js';
-import type { OpenOptions } from './types.js';
+import type { ShowOptions } from './types.js';
 
 const OPEN_METHOD = 'web_app_open_popup';
 const wrapSupported = createWrapSupported('popup', OPEN_METHOD);
@@ -14,16 +16,38 @@ const wrapSupported = createWrapSupported('popup', OPEN_METHOD);
  */
 export const isSupported = createIsSupported(OPEN_METHOD);
 
-const [
-  fn,
-  tOpenPromise,
-  tOpenError,
-] = defineNonConcurrentFn((options: OpenOptions) => {
-  return request(OPEN_METHOD, 'popup_closed', {
-    ...options,
-    params: prepareParams(options),
-  }).then(({ button_id: buttonId }) => buttonId === undefined ? null : buttonId);
-}, 'A popup is already opened');
+const [fn, tPromise, tShowError] = defineNonConcurrentFn(
+  (options: ShowOptions): AbortablePromise<string | null> => {
+    return request(OPEN_METHOD, 'popup_closed', {
+      ...options,
+      params: prepareParams(options),
+    }).then(({ button_id: buttonId }) => buttonId === undefined ? null : buttonId);
+  },
+  'A popup is already opened',
+);
+
+/**
+ * @deprecated Deprecated for consistence naming, to be removed in the next major update. Use
+ *   `show` instead.
+ */
+export const open = wrapSupported('open', fn);
+/**
+ * @deprecated Deprecated for consistence naming, to be removed in the next major update. Use
+ *   `showPromise` instead.
+ */
+const openPromise = tPromise[1];
+/**
+ * @deprecated Deprecated for consistence naming, to be removed in the next major update. Use
+ *   `isShown` instead.
+ */
+const isOpened = tPromise[2];
+/**
+ * @deprecated Deprecated for consistence naming, to be removed in the next major update. Use
+ *   `showError` instead.
+ */
+const openError = tShowError[1];
+
+export { openPromise, isOpened, openError };
 
 /**
  * A method that shows a native popup described by the `params` argument.
@@ -56,6 +80,6 @@ const [
  *   });
  * }
  */
-export const open = wrapSupported('open', fn);
-export const [, openPromise, isOpened] = tOpenPromise;
-export const [, openError] = tOpenError;
+export const show = wrapSupported('show', fn);
+export const [, showPromise, isShown] = tPromise;
+export const [, showError] = tShowError;

packages/sdk/src/scopes/components/popup/types.ts

@@ -1,10 +1,10 @@
-import { RequestOptionsNoCapture } from '@/types.js';
+import type { RequestOptionsNoCapture } from '@/types.js';
 
 /**
  * This object describes the native popup.
  * @see https://core.telegram.org/bots/webapps#popupparams
  */
-export interface OpenOptions extends RequestOptionsNoCapture {
+export interface ShowOptions extends RequestOptionsNoCapture {
   /**
    * The text to be displayed in the popup title, 0-64 characters.
    * @default ""
@@ -18,14 +18,14 @@ export interface OpenOptions extends RequestOptionsNoCapture {
    * List of buttons to be displayed in the popup, 1-3 buttons.
    * @default [{type: 'close'}]
    */
-  buttons?: OpenOptionsButton[];
+  buttons?: ShowOptionsButton[];
 }
 
 /**
  * This object describes the native popup button.
  * @see https://core.telegram.org/bots/webapps#popupbutton
  */
-export type OpenOptionsButton = {
+export type ShowOptionsButton = {
   /**
    * Identifier of the button, 0-64 characters.
    * @default ""
@@ -54,4 +54,16 @@ export type OpenOptionsButton = {
    * - `cancel`, a button with the localized text "Cancel".
    */
   type: 'ok' | 'close' | 'cancel';
-});
+});
+
+/**
+ * @deprecated Deprecated for consistence naming, to be removed in the next major update. Use
+ *   `ShowOptions` instead.
+ */
+export type OpenOptions = ShowOptions;
+
+/**
+ * @deprecated Deprecated for consistence naming, to be removed in the next major update. Use
+ *   `ShowOptionsButton` instead.
+ */
+export type OpenOptionsButton = ShowOptionsButton;