@tma.js/sdk 1.4.4 → 1.4.7

package/src/bridge/request.ts

@@ -1,176 +0,0 @@
-import { isRecord } from '~/misc/index.js';
-import { withTimeout } from '~/timeout/index.js';
-import type { And, ExecuteWithOptions, If, IsNever } from '~/types/index.js';
-
-import {
-  type MiniAppsEventHasParams,
-  type MiniAppsEventName,
-  type MiniAppsEventParams,
-  on,
-} from './events/index.js';
-import {
-  type MiniAppsEmptyMethodName,
-  type MiniAppsMethodAcceptParams,
-  type MiniAppsMethodName,
-  type MiniAppsMethodParams,
-  type MiniAppsNonEmptyMethodName,
-  postEvent as defaultPostEvent,
-} from './methods/index.js';
-
-/**
- * Names of methods, which require passing "req_id" parameter.
- */
-type MethodWithRequestId = {
-  [M in MiniAppsMethodName]: If<
-    And<
-      MiniAppsMethodAcceptParams<M>,
-      MiniAppsMethodParams<M> extends { req_id: string } ? true : false
-    >,
-    M,
-    never
-  >;
-}[MiniAppsMethodName];
-
-/**
- * Names of events, which contain "req_id" parameter.
- */
-type EventWithRequestId = {
-  [E in MiniAppsEventName]: If<
-    And<MiniAppsEventHasParams<E>, MiniAppsEventParams<E> extends {
-      req_id: string
-    } ? true : false>,
-    E,
-    never
-  >;
-}[MiniAppsEventName];
-
-export interface RequestOptions extends ExecuteWithOptions {
-}
-
-export interface RequestOptionsAdvanced<EventPayload> extends RequestOptions {
-  /**
-   * Should return true in case, this event should be captured. If not specified,
-   * request is not skipping captured events.
-   */
-  capture?: If<IsNever<EventPayload>, () => boolean, (payload: EventPayload) => boolean>;
-}
-
-/**
- * Calls specified TWA method and captures one of the specified events. Returns promise
- * which will be resolved in case, event with specified in method request identifier
- * was captured.
- * @param method - method to execute.
- * @param params - method parameters.
- * @param event - event or events to listen.
- * @param options - additional execution options.
- */
-export function request<M extends MethodWithRequestId, E extends EventWithRequestId>(
-  method: M,
-  params: MiniAppsMethodParams<M>,
-  event: E | E[],
-  options?: RequestOptions,
-): Promise<MiniAppsEventParams<E>>;
-
-/**
- * Calls specified TWA method and captures one of the specified events. Returns promise
- * which will be resolved in case, specified event was captured.
- * @param method - method to execute.
- * @param event - event or events to listen.
- * @param options - additional execution options.
- */
-export function request<M extends MiniAppsEmptyMethodName, E extends MiniAppsEventName>(
-  method: M,
-  event: E | E[],
-  options?: RequestOptionsAdvanced<MiniAppsEventParams<E>>,
-): Promise<MiniAppsEventParams<E>>;
-
-/**
- * Calls specified TWA method and captures one of the specified events. Returns promise
- * which will be resolved in case, specified event was captured.
- * @param method - method to execute
- * @param params - method parameters.
- * @param event - event or events to listen
- * @param options - additional execution options.
- */
-export function request<M extends MiniAppsNonEmptyMethodName, E extends MiniAppsEventName>(
-  method: M,
-  params: MiniAppsMethodParams<M>,
-  event: E | E[],
-  options?: RequestOptionsAdvanced<MiniAppsEventParams<E>>,
-): Promise<MiniAppsEventParams<E>>;
-
-export function request(
-  method: MiniAppsMethodName,
-  eventOrParams: MiniAppsEventName | MiniAppsEventName[] | MiniAppsEventParams<any>,
-  eventOrOptions?:
-    | MiniAppsEventName
-    | MiniAppsEventName[]
-    | RequestOptions
-    | RequestOptionsAdvanced<any>,
-  options?: RequestOptions | RequestOptionsAdvanced<any>,
-): Promise<any> {
-  let executionOptions: RequestOptions | RequestOptionsAdvanced<any> | undefined;
-  let methodParams: MiniAppsEventParams<any> | undefined;
-  let events: MiniAppsEventName[];
-  let requestId: string | undefined;
-
-  if (typeof eventOrParams === 'string' || Array.isArray(eventOrParams)) {
-    // Override: [method, event, options?]
-    events = Array.isArray(eventOrParams) ? eventOrParams : [eventOrParams] as MiniAppsEventName[];
-    executionOptions = eventOrOptions as (RequestOptionsAdvanced<any> | undefined);
-  } else {
-    // Override: [method, params, event, options?]
-    methodParams = eventOrParams as MiniAppsEventParams<any>;
-    events = Array.isArray(eventOrOptions)
-      ? eventOrOptions
-      : [eventOrOptions] as MiniAppsEventName[];
-    executionOptions = options;
-  }
-
-  // In case, method parameters were passed, and they contained request identifier, we should store
-  // it and wait for the event with this identifier to occur.
-  if (isRecord(methodParams) && typeof methodParams.req_id === 'string') {
-    requestId = methodParams.req_id;
-  }
-
-  const { postEvent = defaultPostEvent, timeout } = executionOptions || {};
-  const capture = executionOptions && 'capture' in executionOptions
-    ? executionOptions.capture
-    : null;
-
-  const execute = () => {
-    return new Promise((res, rej) => {
-      // Iterate over each event and create event listener.
-      const stoppers = events.map((ev) => on(ev, (data?) => {
-        // If request identifier was specified, we are waiting for event with the same value
-        // to occur.
-        if (requestId && (!isRecord(data) || data.req_id !== requestId)) {
-          return;
-        }
-
-        if (typeof capture === 'function' && !capture(data)) {
-          return;
-        }
-
-        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-        stopListening();
-        res(data);
-      }));
-
-      // Function which removes all event listeners.
-      const stopListening = () => stoppers.forEach((stop) => stop());
-
-      try {
-        // We are wrapping this call in try catch, because it can throw errors in case,
-        // compatibility check was enabled. We want an error to be captured by promise, not by
-        // another one external try catch.
-        postEvent(method as any, methodParams);
-      } catch (e) {
-        stopListening();
-        rej(e);
-      }
-    });
-  };
-
-  return typeof timeout === 'number' ? withTimeout(execute, timeout) : execute();
-}

package/src/classnames/__tests__/classNames.ts

@@ -1,20 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { classNames } from '../classNames';
-
-it('should ignore all non-empty strings and objects', () => {
-  expect(classNames('', 2, 'b', null, undefined, false, true, [], 'a', 'c')).toBe('b a c');
-});
-
-it('should pick only keys which values are truthy', () => {
-  expect(classNames({
-    a: true,
-    b: null,
-    c: false,
-    d: undefined,
-    e: {},
-    f: 3,
-    g: 0,
-    h: '',
-  })).toBe('a e f');
-});

package/src/classnames/__tests__/mergeClassNames.ts

@@ -1,21 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { mergeClassNames } from '../mergeClassNames';
-
-it('should ignore non-object values', () => {
-  expect(mergeClassNames({}, null, undefined, false, true, { tma: 'good' })).toStrictEqual({ tma: 'good' });
-});
-
-it('should merge objects keys by values applying classNames function', () => {
-  expect(mergeClassNames(
-    { a: 'hey there', b: 'space' },
-    { a: 'John', b: 'station' },
-    { c: 'wowow' },
-    { f: { mod: true, ignore: false, add: 'non empty string' } },
-  )).toStrictEqual({
-    a: 'hey there John',
-    b: 'space station',
-    c: 'wowow',
-    f: 'mod add',
-  });
-});

package/src/classnames/classNames.ts

@@ -1,34 +0,0 @@
-/**
- * Inserts a space between a and b in case both of them are
- * non-empty strings.
- * @param a
- * @param b
- */
-function space(a: string, b: string): string {
-  return a + (a.length > 0 && b.length > 0 ? ` ${b}` : b);
-}
-
-/**
- * Function which joins passed values with space following these rules:
- * 1. If value is non-empty string, it will be added to output.
- * 2. If value is object, only those keys will be added, which values are truthy.
- * 3. All other values are ignored.
- *
- * You can find this function to similar one from package {@link https://www.npmjs.com/package/classnames|classnames}.
- * @param values - values array.
- */
-export function classNames(...values: any[]): string {
-  return values.reduce<string>((acc, value) => {
-    let formattedValue = '';
-
-    if (typeof value === 'string') {
-      formattedValue = value;
-    } else if (typeof value === 'object' && value !== null) {
-      formattedValue = Object
-        .entries(value)
-        .reduce<string>((valueAcc, [className, enable]) => (enable ? space(valueAcc, className) : valueAcc), '');
-    }
-
-    return space(acc, formattedValue);
-  }, '');
-}

package/src/classnames/index.ts

@@ -1,2 +0,0 @@
-export * from './classNames.js';
-export * from './mergeClassNames.js';

package/src/classnames/mergeClassNames.ts

@@ -1,60 +0,0 @@
-import { isRecord } from '~/misc/index.js';
-
-import { classNames } from './classNames.js';
-
-/**
- * Returns union keys removing those, which values are not strings.
- */
-type UnionStringKeys<U> = U extends U
-  ? {
-    [K in keyof U]-?: U[K] extends string | undefined ? K : never;
-  }[keyof U]
-  : never;
-
-/**
- * Returns union required keys.
- */
-type UnionRequiredKeys<U> = U extends U
-  ? {
-    [K in UnionStringKeys<U>]: ({} extends Pick<U, K> ? never : K)
-  }[UnionStringKeys<U>]
-  : never;
-
-/**
- * Returns union optional keys.
- */
-type UnionOptionalKeys<U> = Exclude<UnionStringKeys<U>, UnionRequiredKeys<U>>;
-
-type MergeClassNames<Tuple extends any[]> =
-  // Removes all types from union which will be ignored by the mergeClassNames function.
-  Exclude<Tuple[number], number | string | null | undefined | any[] | boolean> extends infer Union
-    ? {
-    [K in UnionRequiredKeys<Union>]: string;
-  } & {
-    [K in UnionOptionalKeys<Union>]?: string;
-  }
-    : never;
-
-/**
- * Merges 2 sets of parameters. Function expects passing an array of objects with values, which
- * could be passed to `classNames` function. As the result, it returns an object with keys
- * from all objects with merged values.
- * @see classNames
- */
-export function mergeClassNames<T extends any[]>(...partials: T): MergeClassNames<T> {
-  return partials.reduce<MergeClassNames<T>>((acc, partial) => {
-    if (!isRecord(partial)) {
-      return acc;
-    }
-
-    Object.entries(partial).forEach(([key, value]) => {
-      const className = classNames((acc as any)[key], value);
-
-      if (className.length > 0) {
-        (acc as any)[key] = className;
-      }
-    });
-
-    return acc;
-  }, {} as MergeClassNames<T>);
-}

package/src/closing-behavior/ClosingBehavior.ts

@@ -1,64 +0,0 @@
-import { type PostEvent, postEvent as defaultPostEvent } from '~/bridge/index.js';
-import { EventEmitter } from '~/event-emitter/index.js';
-import { State } from '~/state/index.js';
-
-import type {
-  ClosingBehaviorEvents,
-  ClosingBehaviorState,
-} from './types.js';
-
-/**
- * Component responsible for controlling current closing confirmation
- * status.
- */
-export class ClosingBehavior {
-  private readonly ee = new EventEmitter<ClosingBehaviorEvents>();
-
-  private readonly state: State<ClosingBehaviorState>;
-
-  constructor(
-    isConfirmationNeeded: boolean,
-    private readonly postEvent: PostEvent = defaultPostEvent,
-  ) {
-    this.state = new State({ isConfirmationNeeded }, this.ee);
-  }
-
-  private set isConfirmationNeeded(value: boolean) {
-    this.state.set('isConfirmationNeeded', value);
-    this.postEvent('web_app_setup_closing_behavior', { need_confirmation: value });
-  }
-
-  /**
-   * Returns true, if the confirmation dialog enabled while the user is trying
-   * to close the Mini App.
-   */
-  get isConfirmationNeeded(): boolean {
-    return this.state.get('isConfirmationNeeded');
-  }
-
-  /**
-   * Disables the confirmation dialog while the user is trying to close the
-   * Mini App.
-   */
-  disableConfirmation(): void {
-    this.isConfirmationNeeded = false;
-  }
-
-  /**
-   * Enables the confirmation dialog while the user is trying to close the
-   * Mini App.
-   */
-  enableConfirmation(): void {
-    this.isConfirmationNeeded = true;
-  }
-
-  /**
-   * Adds new event listener.
-   */
-  on = this.ee.on.bind(this.ee);
-
-  /**
-   * Removes event listener.
-   */
-  off = this.ee.off.bind(this.ee);
-}

package/src/closing-behavior/__tests__/ClosingBehavior.ts

@@ -1,86 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import { ClosingBehavior } from '../ClosingBehavior';
-
-describe('disable', () => {
-  it('should call "web_app_setup_closing_behavior" method with "need_confirmation" equal to false', () => {
-    const postEvent = vi.fn();
-    const confirmation = new ClosingBehavior(true, postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    confirmation.disableConfirmation();
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_setup_closing_behavior', { need_confirmation: false });
-  });
-
-  it('should emit "isConfirmationNeededChanged" event with false value', () => {
-    const confirmation = new ClosingBehavior(true, vi.fn());
-    const listener = vi.fn();
-
-    confirmation.on('change:isConfirmationNeeded', listener);
-    expect(listener).toHaveBeenCalledTimes(0);
-    confirmation.disableConfirmation();
-    expect(listener).toHaveBeenCalledTimes(1);
-    expect(listener).toHaveBeenCalledWith(false);
-  });
-});
-
-describe('enable', () => {
-  it('should call "web_app_setup_closing_behavior" method with "need_confirmation" equal to true', () => {
-    const postEvent = vi.fn();
-    const confirmation = new ClosingBehavior(false, postEvent);
-
-    expect(postEvent).toHaveBeenCalledTimes(0);
-    confirmation.enableConfirmation();
-    expect(postEvent).toHaveBeenCalledTimes(1);
-    expect(postEvent).toHaveBeenCalledWith('web_app_setup_closing_behavior', { need_confirmation: true });
-  });
-
-  it('should emit "isConfirmationNeededChanged" event with true value', () => {
-    const confirmation = new ClosingBehavior(false, vi.fn());
-    const listener = vi.fn();
-
-    confirmation.on('change:isConfirmationNeeded', listener);
-    expect(listener).toHaveBeenCalledTimes(0);
-    confirmation.enableConfirmation();
-    expect(listener).toHaveBeenCalledTimes(1);
-    expect(listener).toHaveBeenCalledWith(true);
-  });
-});
-
-describe('on', () => {
-  describe('"isConfirmationNeededChanged" event', () => {
-    it('should add event listener to event', () => {
-      const listener = vi.fn();
-      const confirmation = new ClosingBehavior(false, vi.fn());
-
-      confirmation.on('change:isConfirmationNeeded', listener);
-
-      expect(listener).toHaveBeenCalledTimes(0);
-      confirmation.enableConfirmation();
-      expect(listener).toHaveBeenCalledTimes(1);
-    });
-  });
-});
-
-describe('off', () => {
-  describe('"isConfirmationNeededChanged" event', () => {
-    it('should remove event listener from event', () => {
-      const listener = vi.fn();
-      const confirmation = new ClosingBehavior(false, vi.fn());
-
-      confirmation.on('change:isConfirmationNeeded', listener);
-
-      expect(listener).toHaveBeenCalledTimes(0);
-      confirmation.enableConfirmation();
-      expect(listener).toHaveBeenCalledTimes(1);
-
-      confirmation.off('change:isConfirmationNeeded', listener);
-      listener.mockClear();
-
-      expect(listener).toHaveBeenCalledTimes(0);
-      confirmation.disableConfirmation();
-      expect(listener).toHaveBeenCalledTimes(0);
-    });
-  });
-});

package/src/closing-behavior/index.ts

@@ -1,2 +0,0 @@
-export * from './ClosingBehavior.js';
-export * from './types.js';

package/src/closing-behavior/types.ts

@@ -1,12 +0,0 @@
-import type { StateEvents } from '~/state/index.js';
-
-export interface ClosingBehaviorState {
-  isConfirmationNeeded: boolean;
-}
-
-export type ClosingBehaviorEvents = StateEvents<ClosingBehaviorState>;
-
-export type ClosingBehaviorEventName = keyof ClosingBehaviorEvents;
-
-export type ClosingBehaviorEventListener<E extends ClosingBehaviorEventName> =
-  ClosingBehaviorEvents[E];

package/src/cloud-storage/CloudStorage.ts

@@ -1,138 +0,0 @@
-import {
-  invokeCustomMethod,
-  postEvent as defaultPostEvent,
-} from '~/bridge/index.js';
-import {
-  array,
-  json,
-  string,
-} from '~/parsing/index.js';
-import {
-  createSupportsFunc,
-  type SupportsFunc,
-} from '~/supports/index.js';
-import type { CreateRequestIdFunc, ExecuteWithTimeout } from '~/types/index.js';
-import type { Version } from '~/version/index.js';
-
-function objectFromKeys<K extends string, V>(keys: K[], value: V): Record<K, V> {
-  return keys.reduce<Record<K, V>>((acc, key) => {
-    acc[key] = value;
-    return acc;
-  }, {} as Record<K, V>);
-}
-
-export class CloudStorage {
-  constructor(
-    version: Version,
-    private readonly createRequestId: CreateRequestIdFunc,
-    private readonly postEvent = defaultPostEvent,
-  ) {
-    this.supports = createSupportsFunc(version, {
-      delete: 'web_app_invoke_custom_method',
-      get: 'web_app_invoke_custom_method',
-      getKeys: 'web_app_invoke_custom_method',
-      set: 'web_app_invoke_custom_method',
-    });
-  }
-
-  /**
-   * Deletes specified key or keys from the cloud storage.
-   * @param keyOrKeys - key or keys to delete.
-   * @param options - request execution options.
-   */
-  async delete(keyOrKeys: string | string[], options: ExecuteWithTimeout = {}): Promise<void> {
-    const keys = Array.isArray(keyOrKeys) ? keyOrKeys : [keyOrKeys];
-    if (keys.length === 0) {
-      return;
-    }
-
-    await invokeCustomMethod(
-      'deleteStorageValues',
-      { keys },
-      this.createRequestId(),
-      { ...options, postEvent: this.postEvent },
-    );
-  }
-
-  /**
-   * Returns list of all keys presented in the cloud storage.
-   * @param options - request execution options.
-   */
-  async getKeys(options: ExecuteWithTimeout = {}): Promise<string[]> {
-    const result = await invokeCustomMethod(
-      'getStorageKeys',
-      {},
-      this.createRequestId(),
-      { ...options, postEvent: this.postEvent },
-    );
-
-    return array().of(string()).parse(result);
-  }
-
-  /**
-   * Returns map, where key is one of the specified in keys argument, and value is according
-   * storage value.
-   * @param keys - keys list.
-   * @param options - request execution options.
-   */
-  get<K extends string>(
-    keys: K[],
-    options?: ExecuteWithTimeout,
-  ): Promise<Record<K, string>>;
-
-  /**
-   * Returns value of the specified key.
-   * @param key - cloud storage key.
-   * @param options - request execution options.
-   * @return Value of the specified key. In case, key was not created previously, function
-   * will return empty string.
-   */
-  get(key: string, options?: ExecuteWithTimeout): Promise<string>;
-
-  async get(
-    keyOrKeys: string | string[],
-    options: ExecuteWithTimeout = {},
-  ): Promise<string | Record<string, string>> {
-    const keys = Array.isArray(keyOrKeys) ? keyOrKeys : [keyOrKeys];
-    if (keys.length === 0) {
-      return objectFromKeys<string, string>(keys, '');
-    }
-
-    const schema = json(
-      objectFromKeys(keys, string()),
-    );
-    const result = await invokeCustomMethod(
-      'getStorageValues',
-      { keys },
-      this.createRequestId(),
-      { ...options, postEvent: this.postEvent },
-    ).then((data) => schema.parse(data));
-
-    return Array.isArray(keyOrKeys) ? result : result[keyOrKeys];
-  }
-
-  /**
-   * Saves specified value by key.
-   * @param key - storage key.
-   * @param value - storage value.
-   * @param options - request execution options.
-   */
-  async set(key: string, value: string, options: ExecuteWithTimeout = {}): Promise<void> {
-    await invokeCustomMethod(
-      'saveStorageValue',
-      { key, value },
-      this.createRequestId(),
-      { ...options, postEvent: this.postEvent },
-    );
-  }
-
-  /**
-   * Checks if specified method is supported by current component.
-   */
-  supports: SupportsFunc<
-    | 'delete'
-    | 'get'
-    | 'getKeys'
-    | 'set'
-  >;
-}

package/src/cloud-storage/index.ts

@@ -1 +0,0 @@
-export * from './CloudStorage.js';

package/src/colors/__tests__/isColorDark.ts

@@ -1,12 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { isColorDark } from '../isColorDark';
-
-it('should return true in case, the value which is equal to Math.sqrt(0.299 * R * R + 0.587 * G * G + 0.114 * B * B) is less than 120 and false otherwise', () => {
-  expect(isColorDark('#17212b')).toBe(true);
-  expect(isColorDark('#f5f5f5')).toBe(false);
-});
-
-it('should throw an error in case, passed value has not convertable to RGB format', () => {
-  expect(() => isColorDark('abc')).toThrow();
-});

package/src/colors/__tests__/isRGB.ts

@@ -1,13 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { isRGB } from '../isRGB';
-
-it('should return true for correct full RGB representation', () => {
-  expect(isRGB('#ffffff')).toBe(true);
-});
-
-it('should return false for any other value', () => {
-  ['abc', '#ffff', '#fff', '#fffffg'].forEach((v) => {
-    expect(isRGB(v)).toBe(false);
-  });
-});

package/src/colors/__tests__/isRGBShort.ts

@@ -1,13 +0,0 @@
-import { expect, it } from 'vitest';
-
-import { isRGBShort } from '../isRGBShort';
-
-it('should return true for correct short RGB representation', () => {
-  expect(isRGBShort('#fff')).toBe(true);
-});
-
-it('should return false for any other value', () => {
-  ['abc', '#ffff', '#ffffff', '#ggg'].forEach((v) => {
-    expect(isRGBShort(v)).toBe(false);
-  });
-});