@tma.js/init-data 0.2.22 → 4.0.0-rc.0

package/src/serialize.ts

@@ -1,77 +0,0 @@
-import type { InitData, User } from './types.js';
-
-function setString(params: URLSearchParams, key: string, value: string | undefined) {
-  if (value === undefined) {
-    return;
-  }
-  params.set(key, value);
-}
-
-function setUser(params: URLSearchParams, key: string, value: User | undefined) {
-  if (value === undefined) {
-    return;
-  }
-  const {
-    photoUrl,
-    firstName,
-    lastName,
-    isPremium,
-    languageCode,
-    isBot,
-    ...rest
-  } = value;
-
-  params.set(key, JSON.stringify({
-    ...rest,
-    photo_url: photoUrl,
-    first_name: firstName,
-    last_name: lastName,
-    is_premium: isPremium,
-    language_code: languageCode,
-    is_bot: isBot,
-  }));
-}
-
-/**
- * Converts init data to its initial representation.
- * @param value - init data.
- */
-export function serialize(value: InitData): string {
-  const {
-    authDate,
-    canSendAfter,
-    chat,
-    chatInstance,
-    chatType,
-    hash,
-    queryId,
-    receiver,
-    startParam,
-    user,
-  } = value;
-
-  const params = new URLSearchParams();
-
-  params.set('auth_date', (authDate.getTime() / 1000).toString());
-  setString(params, 'chat_instance', chatInstance);
-  setString(params, 'chat_type', chatType);
-  setString(params, 'hash', hash);
-  setString(params, 'query_id', queryId);
-  setUser(params, 'receiver', receiver);
-  setString(params, 'start_param', startParam);
-  setUser(params, 'user', user);
-
-  if (chat) {
-    const { photoUrl, ...rest } = chat;
-    params.set('chat', JSON.stringify({
-      ...rest,
-      photo_url: photoUrl,
-    }));
-  }
-
-  if (canSendAfter) {
-    params.set('can_send_after', canSendAfter.toString());
-  }
-
-  return params.toString();
-}

package/src/types.ts

@@ -1,164 +0,0 @@
-/**
- * Known type of chat.
- */
-export type ChatType =
-  | 'sender'
-  | 'private'
-  | 'group'
-  | 'supergroup'
-  | 'channel'
-  | string;
-
-/**
- * Describes Telegram Mini Apps [User](https://docs.telegram-mini-apps.com/launch-parameters/init-data#user) type.
- */
-export interface User {
-  /**
-   * True, if this user added the bot to the attachment menu.
-   */
-  addedToAttachmentMenu?: boolean;
-
-  /**
-   * True, if this user allowed the bot to message them.
-   */
-  allowsWriteToPm?: boolean;
-
-  /**
-   * First name of the user or bot.
-   */
-  firstName: string;
-
-  /**
-   * A unique identifier for the user or bot.
-   */
-  id: number;
-
-  /**
-   * True, if this user is a bot. Returned in the `receiver` field only.
-   * @see InitData.receiver
-   */
-  isBot?: boolean;
-
-  /**
-   * True, if this user is a Telegram Premium user.
-   */
-  isPremium?: boolean;
-
-  /**
-   * Last name of the user or bot.
-   */
-  lastName?: string;
-
-  /**
-   * [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language.
-   * Returns in user field only.
-   */
-  languageCode?: string;
-
-  /**
-   * URL of the user’s profile photo. The photo can be in .jpeg or .svg
-   * formats. Only returned for Mini Apps launched from the attachment menu.
-   */
-  photoUrl?: string;
-
-  /**
-   * Username of the user or bot.
-   */
-  username?: string;
-}
-
-/**
- * Describes Telegram Mini Apps [Chat](https://docs.telegram-mini-apps.com/launch-parameters/init-data#chat) type.
- */
-export interface Chat {
-  /**
-   * Unique identifier for this chat.
-   */
-  id: number;
-
-  /**
-   * URL of the chat’s photo. The photo can be in .jpeg or .svg formats.
-   * Only returned for Mini Apps launched from the attachment menu.
-   */
-  photoUrl?: string;
-
-  /**
-   * Type of chat.
-   */
-  type: 'group' | 'supergroup' | 'channel' | string;
-
-  /**
-   * Title of the chat.
-   */
-  title: string;
-
-  /**
-   * Username of the chat.
-   */
-  username?: string;
-}
-
-/**
- * Describes Telegram Mini Apps [InitData](https://docs.telegram-mini-apps.com/launch-parameters/init-data#parameters-list)
- * type.
- */
-export interface InitData {
-  /**
-   * Init data generation date.
-   */
-  authDate: Date;
-
-  /**
-   * The number of seconds after which a message can be sent via the method [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery).
-   */
-  canSendAfter?: number;
-
-  /**
-   * An object containing data about the chat where the bot was launched via
-   * the attachment menu. Returned for supergroups, channels and group
-   * chats – only for Mini Apps launched via the attachment menu.
-   */
-  chat?: Chat;
-
-  /**
-   * The type of chat from which Mini App was opened.
-   */
-  chatType?: ChatType;
-
-  /**
-   * A global identifier indicating the chat from which Mini App was
-   * opened. Returned only for applications opened by direct link.
-   */
-  chatInstance?: string;
-
-  /**
-   * A hash of all passed parameters, which the bot server can use to
-   * check their [validity](https://core.telegram.org/bots/webapps#validating-data-received-via-the-web-app).
-   */
-  hash: string;
-
-  /**
-   * A unique identifier for the Mini App session, required for sending
-   * messages via the [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) method.
-   */
-  queryId?: string;
-
-  /**
-   * An object containing data about the chat partner of the current user in
-   * the chat where the bot was launched via the attachment menu.
-   * Returned only for private chats and only for Mini Apps launched
-   * via the attachment menu.
-   */
-  receiver?: User;
-
-  /**
-   * The value of the `startattach` parameter, passed via link. Only returned for
-   * Mini Apps when launched from the attachment menu via link.
-   */
-  startParam?: string;
-
-  /**
-   * An object containing data about the current user.
-   */
-  user?: User;
-}

package/src/user.ts

@@ -1,45 +0,0 @@
-import { json, string, boolean, number } from '@tma.js/parsing';
-
-import type { User } from './types.js';
-
-/**
- * Returns parser used to parse user data.
- */
-export function user() {
-  return json<User>({
-    addedToAttachmentMenu: {
-      type: boolean().optional(),
-      from: 'added_to_attachment_menu',
-    },
-    allowsWriteToPm: {
-      type: boolean().optional(),
-      from: 'allows_write_to_pm',
-    },
-    firstName: {
-      type: string(),
-      from: 'first_name',
-    },
-    id: number(),
-    isBot: {
-      type: boolean().optional(),
-      from: 'is_bot',
-    },
-    isPremium: {
-      type: boolean().optional(),
-      from: 'is_premium',
-    },
-    languageCode: {
-      type: string().optional(),
-      from: 'language_code',
-    },
-    lastName: {
-      type: string().optional(),
-      from: 'last_name',
-    },
-    photoUrl: {
-      type: string().optional(),
-      from: 'photo_url',
-    },
-    username: string().optional(),
-  }, 'User');
-}