@tma.js/sdk 1.4.3 → 1.4.6

package/src/init-data/__tests__/initDataParser.ts

@@ -1,136 +0,0 @@
-import { toSearchParams } from 'test-utils';
-import { describe, expect, it } from 'vitest';
-
-import { initDataParser } from '../initDataParser';
-
-describe('auth_date', () => {
-  it('should throw an error in case, this property is missing', () => {
-    expect(() => initDataParser().parse(toSearchParams({ hash: 'abcd' }))).toThrow();
-  });
-
-  it('should parse source property as Date and pass it to the "authDate" property', () => {
-    expect(initDataParser().parse(toSearchParams({ auth_date: 1, hash: 'abcd' }))).toMatchObject({
-      authDate: new Date(1000),
-    });
-  });
-});
-
-describe('can_send_after', () => {
-  it('should parse source property as Date and pass it to the "canSendAfter" property', () => {
-    expect(
-      initDataParser().parse(toSearchParams({
-        auth_date: 1,
-        hash: 'abcd',
-        can_send_after: 8882,
-      })),
-    ).toMatchObject({
-      canSendAfter: 8882,
-    });
-  });
-});
-
-describe('chat', () => {
-  it('should parse source property as Chat and pass it to the "chat" property', () => {
-    expect(
-      initDataParser().parse(toSearchParams({
-        auth_date: 1,
-        hash: 'abcd',
-        chat: {
-          id: 5,
-          type: 'group chat',
-          title: 'My Chat',
-          photo_url: 'https://johny.com',
-          username: 'Johny Chat',
-        },
-      })),
-    ).toMatchObject({
-      chat: {
-        id: 5,
-        type: 'group chat',
-        title: 'My Chat',
-        photoUrl: 'https://johny.com',
-        username: 'Johny Chat',
-      },
-    });
-  });
-});
-
-describe('hash', () => {
-  it('should throw an error in case, this property is missing', () => {
-    expect(
-      () => initDataParser().parse(toSearchParams({
-        auth_date: 1,
-      })),
-    ).toThrow();
-  });
-
-  it('should parse source property as string and pass it to the "hash" property', () => {
-    expect(
-      initDataParser().parse(toSearchParams({
-        auth_date: 1,
-        hash: 'abcd',
-      })),
-    ).toMatchObject({
-      hash: 'abcd',
-    });
-  });
-});
-
-[
-  ['chat_instance', 'chatInstance'],
-  ['chat_type', 'chatType'],
-  ['query_id', 'queryId'],
-  ['start_param', 'startParam'],
-].forEach(([from, to]) => {
-  describe(from, () => {
-    it(`should parse source property as string and pass it to the "${to}" property`, () => {
-      expect(
-        initDataParser().parse(toSearchParams({
-          auth_date: 1,
-          hash: 'abcd',
-          [from]: 'my custom property',
-        })),
-      ).toMatchObject({
-        [to]: 'my custom property',
-      });
-    });
-  });
-});
-
-['user', 'receiver'].forEach((property) => {
-  describe(property, () => {
-    it('should parse source property as User and pass it to the property with the same name', () => {
-      expect(
-        initDataParser().parse(toSearchParams({
-          auth_date: 1,
-          hash: 'abcd',
-          [property]: {
-            added_to_attachment_menu: true,
-            allows_write_to_pm: false,
-            first_name: 'Johny',
-            id: 333,
-            is_bot: false,
-            is_premium: true,
-            language_code: 'en',
-            last_name: 'Bravo',
-            photo_url: 'https://johny.com',
-            username: 'johnybravo',
-          },
-        })),
-      ).toMatchObject({
-        [property]: {
-          addedToAttachmentMenu: true,
-          allowsWriteToPm: false,
-          firstName: 'Johny',
-          id: 333,
-          isBot: false,
-          isPremium: true,
-          languageCode: 'en',
-          lastName: 'Bravo',
-          photoUrl: 'https://johny.com',
-          username: 'johnybravo',
-        },
-      });
-    });
-  });
-});

package/src/init-data/__tests__/parseInitData.ts

@@ -1,136 +0,0 @@
-import { toSearchParams } from 'test-utils';
-import { describe, expect, it } from 'vitest';
-
-import { parseInitData } from '../parseInitData';
-
-describe('auth_date', () => {
-  it('should throw an error in case, this property is missing', () => {
-    expect(() => parseInitData(toSearchParams({ hash: 'abcd' }))).toThrow();
-  });
-
-  it('should parse source property as Date and pass it to the "authDate" property', () => {
-    expect(parseInitData(toSearchParams({ auth_date: 1, hash: 'abcd' }))).toMatchObject({
-      authDate: new Date(1000),
-    });
-  });
-});
-
-describe('can_send_after', () => {
-  it('should parse source property as Date and pass it to the "canSendAfter" property', () => {
-    expect(
-      parseInitData(toSearchParams({
-        auth_date: 1,
-        hash: 'abcd',
-        can_send_after: 8882,
-      })),
-    ).toMatchObject({
-      canSendAfter: 8882,
-    });
-  });
-});
-
-describe('chat', () => {
-  it('should parse source property as Chat and pass it to the "chat" property', () => {
-    expect(
-      parseInitData(toSearchParams({
-        auth_date: 1,
-        hash: 'abcd',
-        chat: {
-          id: 5,
-          type: 'group chat',
-          title: 'My Chat',
-          photo_url: 'https://johny.com',
-          username: 'Johny Chat',
-        },
-      })),
-    ).toMatchObject({
-      chat: {
-        id: 5,
-        type: 'group chat',
-        title: 'My Chat',
-        photoUrl: 'https://johny.com',
-        username: 'Johny Chat',
-      },
-    });
-  });
-});
-
-describe('hash', () => {
-  it('should throw an error in case, this property is missing', () => {
-    expect(
-      () => parseInitData(toSearchParams({
-        auth_date: 1,
-      })),
-    ).toThrow();
-  });
-
-  it('should parse source property as string and pass it to the "hash" property', () => {
-    expect(
-      parseInitData(toSearchParams({
-        auth_date: 1,
-        hash: 'abcd',
-      })),
-    ).toMatchObject({
-      hash: 'abcd',
-    });
-  });
-});
-
-[
-  ['chat_instance', 'chatInstance'],
-  ['chat_type', 'chatType'],
-  ['query_id', 'queryId'],
-  ['start_param', 'startParam'],
-].forEach(([from, to]) => {
-  describe(from, () => {
-    it(`should parse source property as string and pass it to the "${to}" property`, () => {
-      expect(
-        parseInitData(toSearchParams({
-          auth_date: 1,
-          hash: 'abcd',
-          [from]: 'my custom property',
-        })),
-      ).toMatchObject({
-        [to]: 'my custom property',
-      });
-    });
-  });
-});
-
-['user', 'receiver'].forEach((property) => {
-  describe(property, () => {
-    it('should parse source property as User and pass it to the property with the same name', () => {
-      expect(
-        parseInitData(toSearchParams({
-          auth_date: 1,
-          hash: 'abcd',
-          [property]: {
-            added_to_attachment_menu: true,
-            allows_write_to_pm: false,
-            first_name: 'Johny',
-            id: 333,
-            is_bot: false,
-            is_premium: true,
-            language_code: 'en',
-            last_name: 'Bravo',
-            photo_url: 'https://johny.com',
-            username: 'johnybravo',
-          },
-        })),
-      ).toMatchObject({
-        [property]: {
-          addedToAttachmentMenu: true,
-          allowsWriteToPm: false,
-          firstName: 'Johny',
-          id: 333,
-          isBot: false,
-          isPremium: true,
-          languageCode: 'en',
-          lastName: 'Bravo',
-          photoUrl: 'https://johny.com',
-          username: 'johnybravo',
-        },
-      });
-    });
-  });
-});

package/src/init-data/__tests__/userParser.ts

@@ -1,96 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { userParser } from '../userParser';
-
-describe('first_name', () => {
-  it('should throw an error in case, this property is missing', () => {
-    expect(() => userParser().parse({ id: 123 })).toThrow();
-  });
-
-  it('should parse source property as string and pass it to the "firstName" property', () => {
-    expect(
-      userParser().parse({ id: 123, first_name: 'Pavel' }),
-    ).toMatchObject({
-      firstName: 'Pavel',
-    });
-  });
-});
-
-describe('id', () => {
-  it('should throw an error in case, this property is missing', () => {
-    expect(() => userParser().parse({ first_name: 'Pavel' })).toThrow();
-  });
-
-  it('should parse source property as number and pass it to the "id" property', () => {
-    expect(
-      userParser().parse({
-        id: 123,
-        first_name: 'Pavel',
-      }),
-    ).toMatchObject({
-      id: 123,
-    });
-  });
-});
-
-// Check optional booleans.
-[
-  ['added_to_attachment_menu', 'addedToAttachmentMenu'],
-  ['allows_write_to_pm', 'allowsWriteToPm'],
-  ['is_bot', 'isBot'],
-  ['is_premium', 'isPremium'],
-].forEach(([from, to]) => {
-  describe(from, () => {
-    it(`should parse source property as boolean and pass it to the "${to}" property`, () => {
-      expect(
-        userParser().parse({
-          id: 123,
-          first_name: 'Pavel',
-          [from]: false,
-        }),
-      ).toMatchObject({
-        [to]: false,
-      });
-
-      expect(
-        () => userParser().parse({
-          id: 123,
-          first_name: 'Pavel',
-          [from]: 'non-boolean',
-        }),
-      ).toThrow();
-    });
-  });
-});
-
-// Check optional strings.
-[
-  ['language_code', 'languageCode'],
-  ['last_name', 'lastName'],
-  ['photo_url', 'photoUrl'],
-  ['username', 'username'],
-].forEach(([from, to]) => {
-  describe(from, () => {
-    it(`should parse source property as string and pass it to the "${to}" property`, () => {
-      expect(
-        userParser().parse({
-          id: 123,
-          first_name: 'Pavel',
-          [from]: 'my custom property',
-        }),
-      ).toMatchObject({
-        [to]: 'my custom property',
-      });
-
-      expect(
-        () => userParser().parse({
-          id: 123,
-          first_name: 'Pavel',
-          [from]: {
-            key: 'cant parse it',
-          },
-        }),
-      ).toThrow();
-    });
-  });
-});

package/src/init-data/chatParser.ts

@@ -1,19 +0,0 @@
-import { json, number, string } from '~/parsing/index.js';
-
-import type { Chat } from './types.js';
-
-/**
- * Returns parser used to parse chat data.
- */
-export function chatParser() {
-  return json<Chat>({
-    id: number(),
-    type: string(),
-    title: string(),
-    photoUrl: {
-      type: string().optional(),
-      from: 'photo_url',
-    },
-    username: string().optional(),
-  }, 'Chat');
-}

package/src/init-data/index.ts

@@ -1,6 +0,0 @@
-export * from './chatParser.js';
-export * from './InitData.js';
-export * from './initDataParser.js';
-export * from './parseInitData.js';
-export * from './types.js';
-export * from './userParser.js';

package/src/init-data/initDataParser.ts

@@ -1,41 +0,0 @@
-import { date, number, searchParams, string } from '~/parsing/index.js';
-
-import { chatParser } from './chatParser.js';
-import type { InitDataParsed } from './types.js';
-import { userParser } from './userParser.js';
-
-/**
- * Returns parser used to parse init data, presented as search params.
- */
-export function initDataParser() {
-  return searchParams<InitDataParsed>({
-    authDate: {
-      type: date(),
-      from: 'auth_date',
-    },
-    canSendAfter: {
-      type: number().optional(),
-      from: 'can_send_after',
-    },
-    chat: chatParser().optional(),
-    chatInstance: {
-      type: string().optional(),
-      from: 'chat_instance',
-    },
-    chatType: {
-      type: string().optional(),
-      from: 'chat_type',
-    },
-    hash: string(),
-    queryId: {
-      type: string().optional(),
-      from: 'query_id',
-    },
-    receiver: userParser().optional(),
-    startParam: {
-      type: string().optional(),
-      from: 'start_param',
-    },
-    user: userParser().optional(),
-  }, 'InitData');
-}

package/src/init-data/parseInitData.ts

@@ -1,10 +0,0 @@
-import { initDataParser } from './initDataParser.js';
-import type { InitDataParsed } from './types.js';
-
-/**
- * Parses incoming value as init data.
- * @param value - value to parse.
- */
-export function parseInitData(value: unknown): InitDataParsed {
-  return initDataParser().parse(value);
-}

package/src/init-data/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/platform/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 InitDataParsed.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/platform/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/platform/launch-parameters/init-data#parameters-list)
- * type.
- */
-export interface InitDataParsed {
-  /**
-   * 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/init-data/userParser.ts

@@ -1,45 +0,0 @@
-import { boolean, json, number, string } from '~/parsing/index.js';
-
-import type { User } from './types.js';
-
-/**
- * Returns parser used to parse user data.
- */
-export function userParser() {
-  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');
-}