@vbotma/sdk 3.3.4 → 3.3.7

package/README.md

@@ -4,7 +4,6 @@
 
 [docs-badge]: https://img.shields.io/badge/documentation-blue?logo=gitbook&logoColor=white
 
-[link]: https://github.com/Telegram-Mini-Apps/tma.js/tree/master/tma.js/sdk
 
 [docs-link]: https://docs.vbot-mini-apps.com/packages/tma-js-sdk
 
@@ -22,11 +21,11 @@
 Made from scratch TypeScript library for seamless communication with VBot Mini Apps
 functionality.
 
-The code of this library is designed to simplify the process of developers interacting with Telegram
+The code of this library is designed to simplify the process of developers interacting with VBot
 Mini Apps. It consists of several individual components, each responsible for a specific aspect of
 the VBot Mini Apps ecosystem.
 
-Before you begin using the SDK, we highly recommend familiarizing yourself with the Telegram Mini
+Before you begin using the SDK, we highly recommend familiarizing yourself with the VBot Mini
 Apps [documentation](https://docs.vbot-mini-apps.com/platform/about)
 to grasp the fundamental concepts of the platform.
 

package/dist/dts/features/HapticFeedback/HapticFeedback.d.ts

@@ -18,7 +18,7 @@ export declare class HapticFeedback {
      */
     readonly isSupported: Computed<boolean>;
     /**
-     * A method that tells if an impact occurred. The Telegram app may play the
+     * A method that tells if an impact occurred. The VBot app may play the
      * appropriate haptics based on style value passed.
      * @param style - impact style.
      * @since Mini Apps v6.1
@@ -30,7 +30,7 @@ export declare class HapticFeedback {
     impactOccurred: WithChecks<(style: ImpactHapticFeedbackStyle) => void, true>;
     /**
      * A method tells that a task or action has succeeded, failed, or produced
-     * a warning. The Telegram app may play the appropriate haptics based on type
+     * a warning. The VBot app may play the appropriate haptics based on type
      * value passed.
      * @param type - notification type.
      * @since Mini Apps v6.1
@@ -41,7 +41,7 @@ export declare class HapticFeedback {
      */
     notificationOccurred: WithChecks<(type: NotificationHapticFeedbackType) => void, true>;
     /**
-     * A method tells that the user has changed a selection. The Telegram app may
+     * A method tells that the user has changed a selection. The VBot app may
      * play the appropriate haptics.
      *
      * Do not use this feedback when the user makes or confirms a selection; use

package/dist/dts/features/InitData/InitData.d.ts

@@ -29,7 +29,6 @@ export declare class InitData<Err extends Error> {
     readonly canSendAfter: Computed<number | undefined>;
     /**
      * Date after which it is allowed to call
-     * the [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method.
      */
     readonly canSendAfterDate: Computed<Date | undefined>;
     /**

package/dist/dts/features/Invoice/Invoice.d.ts

@@ -43,7 +43,7 @@ export declare class Invoice {
      * @param options - additional options.
      * @since Mini Apps v6.1
      * @example
-     * const status = await invoice.openUrl('https://t.me/$kJNFS331');
+     * const status = await invoice.openUrl('https://vbot.vn/$kJNFS331');
      */
     readonly openUrlFp: WithChecksFp<(url: string, options?: AsyncOptions) => (InvoiceTask<InvalidArgumentsError, InvoiceStatus>), true>;
     /**

package/dist/dts/features/MiniApp/MiniApp.d.ts

@@ -172,7 +172,7 @@ export declare class MiniApp {
      */
     readonly close: WithChecks<(returnBack?: boolean) => void, false>;
     /**
-     * Informs the Telegram app that the Mini App is ready to be displayed.
+     * Informs the VBot app that the Mini App is ready to be displayed.
      *
      * It is recommended to call this method as early as possible, as soon as all
      * essential interface elements loaded.

package/dist/dts/features/Popup/types.d.ts

@@ -1,7 +1,6 @@
 import { AsyncOptions } from '../../types.js';
 /**
  * This object describes the native popup.
- * @see https://core.telegram.org/bots/webapps#popupparams
  */
 export interface ShowOptions extends AsyncOptions {
     /**
@@ -21,7 +20,6 @@ export interface ShowOptions extends AsyncOptions {
 }
 /**
  * This object describes the native popup button.
- * @see https://core.telegram.org/bots/webapps#popupbutton
  */
 export type ShowOptionsButton = {
     /**

package/dist/dts/features/links/openVBotLink.d.ts

@@ -4,12 +4,12 @@ import { InvalidArgumentsError } from '../../errors.js';
 export type OpenVBotLinkError = PostEventError | InvalidArgumentsError;
 /**
  * Opens a VBot link inside the VBot app. The function expects passing a link in a full
- * format using the hostname "t.me".
+ * format using the hostname "vbot.vn".
  *
  * The Mini App will be closed.
  * @param url - URL to be opened.
  * @example
- * openVBotLink('https://t.me/heyqbnk');
+ * openVBotLink('https://vbot.vn/heyqbnk');
  */
 export declare const openVBotLinkFp: import('../../with-checks/withChecksFp.js').WithChecksFp<(url: string | URL) => E.Either<OpenVBotLinkError, void>, false, never>;
 /**

package/dist/dts/features/links/shareURL.d.ts

@@ -5,11 +5,9 @@ export type ShareURLError = PostEventError;
  * Shares the specified URL with the passed to the chats, selected by user.
  * After being called, it closes the mini application.
  *
- * This method uses Telegram's Share Links.
+ * This method uses VBot's Share Links.
  * @param url - URL to share.
  * @param text - text to append after the URL.
- * @see https://core.telegram.org/api/links#share-links
- * @see https://core.telegram.org/widgets/share#custom-buttons
  */
 export declare const shareURLFp: import('../../with-checks/withChecksFp.js').WithChecksFp<(url: string, text?: string) => E.Either<ShareURLError, void>, false, never>;
 /**

package/dist/dts/features/privacy/requestContact.d.ts

@@ -23,7 +23,7 @@ export interface RequestedContact {
  */
 export interface RequestedContactCompleteData {
     /**
-     * Raw original representation of the contact data returned from the Telegram server.
+     * Raw original representation of the contact data returned from the VBot server.
      */
     raw: string;
     /**

package/dist/dts/features/uncategorized/downloadFile.d.ts

@@ -11,7 +11,7 @@ export type DownloadFileError = RequestError | AccessDeniedError;
  * @since Mini Apps v8.0
  * @example
  * fn.pipe(
- *   downloadFileFp('https://telegram.org/js/telegram-web-app.js', 'telegram-sdk.js'),
+ *   downloadFileFp('https://vbot.org/js/vbot-web-app.js', 'vbot-sdk.js'),
  *   TE.map(() => {
  *     console.log('Downloading');
  *   })

package/dist/dts/features/uncategorized/getCurrentTime.d.ts

@@ -4,7 +4,7 @@ import { InvokeCustomMethodError } from '../../fn-options/withInvokeCustomMethod
 import { AsyncOptions } from '../../types.js';
 export type GetCurrentTimeError = InvokeCustomMethodError | ValidationError;
 /**
- * @returns The current time according to the Telegram server time.
+ * @returns The current time according to the VBot server time.
  * @param options - additional options.
  * @since Mini Apps v6.9
  */

package/dist/dts/features/uncategorized/retrieveAndroidDeviceData.d.ts

@@ -1,6 +1,5 @@
 import { AndroidDeviceData } from './retrieveAndroidDeviceDataFrom.js';
 /**
  * Retrieves Android device data from the navigator.userAgent.
- * @see https://core.telegram.org/bots/webapps#additional-data-in-user-agent
  */
 export declare function retrieveAndroidDeviceData(): AndroidDeviceData;

package/dist/dts/features/uncategorized/retrieveAndroidDeviceDataFrom.d.ts

@@ -8,7 +8,6 @@ export interface AndroidDeviceData {
 }
 /**
  * Retrieves Android device data from the specified User Agent.
- * @see https://core.telegram.org/bots/webapps#additional-data-in-user-agent
  * @param userAgent - user agent.
  */
 export declare function retrieveAndroidDeviceDataFrom(userAgent: string): AndroidDeviceData;

package/dist/dts/features/uncategorized/sendData.d.ts

@@ -8,7 +8,6 @@ export type SendDataError = PostEventError | InvalidArgumentsError;
  * When this method called, a service message sent to the bot containing the data of the length
  * up to 4096 bytes, and the Mini App closed.
  *
- * See the field `web_app_data` in the class [Message](https://core.telegram.org/bots/api#message).
  *
  * This method is only available for Mini Apps launched via a Keyboard button.
  * @param data - data to send to bot.

package/dist/dts/features/uncategorized/shareStory.d.ts

@@ -4,13 +4,13 @@ export interface ShareStoryOptions {
     /**
      * The caption to be added to the media.
      * 0-200 characters for regular users and 0-2048 characters for premium subscribers.
-     * @see https://telegram.org/faq_premium#telegram-premium
+     * @see https://vbot.org/faq_premium#vbot-premium
      */
     text?: string;
     /**
      * An object that describes a widget link to be included in the story.
      * Note that only premium subscribers can post stories with links.
-     * @see https://telegram.org/faq_premium#telegram-premium
+     * @see https://vbot.org/faq_premium#vbot-premium
      */
     widgetLink?: {
         /**
@@ -32,7 +32,7 @@ export type ShareStoryError = PostEventError;
  *   shareStory('https://example.com/background.png', {
  *     text: 'Look at this cool group!',
  *     widgetLink: {
- *       url: 'https://t.me/heyqbnk',
+ *       url: 'https://vbot.vn/heyqbnk',
  *       name: 'Vlad\'s community',
  *     },
  *   }),

package/dist/dts/host-features/Link/HostLink.d.ts

@@ -5,8 +5,8 @@ export declare class HostLink {
      */
     onOpenLink(listener: (params: MethodParams<'web_app_open_link'>) => void): VoidFunction;
     /**
-     * Listens to 'web_app_open_tg_link' methods calls from Mini App.
+     * Listens to 'web_app_open_vb_link' methods calls from Mini App.
      */
-    onOpenTgLink(listener: (params: MethodParams<'web_app_open_tg_link'>) => void): VoidFunction;
+    onOpenTgLink(listener: (params: MethodParams<'web_app_open_vb_link'>) => void): VoidFunction;
 }
 export declare const hostLink: HostLink;

package/dist/dts/init.d.ts

@@ -29,7 +29,7 @@ export interface InitOptions {
     version?: Version;
 }
 /**
- * Initializes the SDK allowing it to properly handle events, sent from the native Telegram
+ * Initializes the SDK allowing it to properly handle events, sent from the native VBot
  * application. This function also configure the package's global dependencies (functions,
  * variables used across the package).
  * @param options - function options.