@tma.js/sdk-react 0.5.3 → 1.0.0

package/dist/dts/lib/index.d.ts

@@ -1,13 +0,0 @@
-export * from './back-button/index.js';
-export * from './closing-behavior/index.js';
-export * from './haptic-feedback/index.js';
-export * from './launch-params/index.js';
-export * from './main-button/index.js';
-export * from './popup/index.js';
-export * from './qr-scanner/index.js';
-export * from './viewport/index.js';
-export * from './web-app/index.js';
-export * from './cloud-storage.js';
-export { usePostEvent } from './hooks.js';
-export * from './init-data.js';
-export * from './theme-params.js';

package/dist/dts/lib/init-data.d.ts

@@ -1,20 +0,0 @@
-import { type ComponentType } from 'react';
-import type { InitData } from '@tma.js/sdk';
-interface EnhancedProps {
-    initData: InitData | null;
-    initDataRaw: string | null;
-}
-/**
- * Returns InitData component instance.
- */
-export declare function useInitData(): InitData | null;
-/**
- * Returns init data raw representation.
- */
-export declare function useInitDataRaw(): string | null;
-/**
- * HOC which passes InitData SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withInitData<P extends Partial<EnhancedProps>>(Component: ComponentType<P>): ComponentType<Omit<P, keyof EnhancedProps>>;
-export { InitData };

package/dist/dts/lib/launch-params/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useLaunchParams.js';
-export * from './withLaunchParams.js';

package/dist/dts/lib/launch-params/types.d.ts

@@ -1 +0,0 @@
-export type { LaunchParams } from '@tma.js/launch-params';

package/dist/dts/lib/launch-params/useLaunchParams.d.ts

@@ -1,5 +0,0 @@
-import type { LaunchParams } from './types.js';
-/**
- * The hook which returns launch parameters initially passed to Mini App.
- */
-export declare function useLaunchParams(): LaunchParams;

package/dist/dts/lib/launch-params/withLaunchParams.d.ts

@@ -1,9 +0,0 @@
-import { type ComponentType } from 'react';
-import type { LaunchParams } from './types.js';
-/**
- * HOC which passes launch parameters to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withLaunchParams<P extends {
-    launchParams?: LaunchParams;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'launchParams'>>;

package/dist/dts/lib/main-button/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useMainButton.js';
-export * from './withMainButton.js';

package/dist/dts/lib/main-button/types.d.ts

@@ -1 +0,0 @@
-export type { MainButton } from '@tma.js/sdk';

package/dist/dts/lib/main-button/useMainButton.d.ts

@@ -1,5 +0,0 @@
-import type { MainButton } from './types.js';
-/**
- * Returns MainButton component instance.
- */
-export declare function useMainButton(): MainButton;

package/dist/dts/lib/main-button/withMainButton.d.ts

@@ -1,9 +0,0 @@
-import { type ComponentType } from 'react';
-import type { MainButton } from './types.js';
-/**
- * HOC which passes MainButton SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withMainButton<P extends {
-    mainButton?: MainButton;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'mainButton'>>;

package/dist/dts/lib/popup/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './usePopup.js';
-export * from './withPopup.js';

package/dist/dts/lib/popup/types.d.ts

@@ -1 +0,0 @@
-export type { Popup } from '@tma.js/sdk';

package/dist/dts/lib/popup/usePopup.d.ts

@@ -1,5 +0,0 @@
-import type { Popup } from './types.js';
-/**
- * Returns Popup component instance.
- */
-export declare function usePopup(): Popup;

package/dist/dts/lib/popup/withPopup.d.ts

@@ -1,9 +0,0 @@
-import { type ComponentType } from 'react';
-import type { Popup } from './types.js';
-/**
- * HOC which passes Popup SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withPopup<P extends {
-    popup?: Popup;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'popup'>>;

package/dist/dts/lib/qr-scanner/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useQRScanner.js';
-export * from './withQRScanner.js';

package/dist/dts/lib/qr-scanner/types.d.ts

@@ -1 +0,0 @@
-export type { QRScanner } from '@tma.js/sdk';

package/dist/dts/lib/qr-scanner/useQRScanner.d.ts

@@ -1,5 +0,0 @@
-import type { QRScanner } from './types.js';
-/**
- * Returns QRScanner component instance.
- */
-export declare function useQRScanner(): QRScanner;

package/dist/dts/lib/qr-scanner/withQRScanner.d.ts

@@ -1,9 +0,0 @@
-import { type ComponentType } from 'react';
-import type { QRScanner } from './types.js';
-/**
- * HOC which passes QRScanner SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withQRScanner<P extends {
-    qrScanner?: QRScanner;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'qrScanner'>>;

package/dist/dts/lib/theme-params.d.ts

@@ -1,13 +0,0 @@
-import { type ComponentType } from 'react';
-import type { ThemeParams } from '@tma.js/sdk';
-/**
- * Returns ThemeParams component instance.
- */
-export declare function useThemeParams(): ThemeParams;
-/**
- * HOC which passes ThemeParams SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withThemeParams<P extends {
-    themeParams?: ThemeParams;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'themeParams'>>;

package/dist/dts/lib/viewport/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useViewport.js';
-export * from './withViewport.js';

package/dist/dts/lib/viewport/types.d.ts

@@ -1 +0,0 @@
-export type { Viewport } from '@tma.js/sdk';

package/dist/dts/lib/viewport/useViewport.d.ts

@@ -1,5 +0,0 @@
-import type { Viewport } from './types.js';
-/**
- * Returns Viewport component instance.
- */
-export declare function useViewport(): Viewport;

package/dist/dts/lib/viewport/withViewport.d.ts

@@ -1,9 +0,0 @@
-import { type ComponentType } from 'react';
-import type { Viewport } from './types.js';
-/**
- * HOC which passes Viewport SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withViewport<P extends {
-    viewport?: Viewport;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'viewport'>>;

package/dist/dts/lib/web-app/index.d.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useWebApp.js';
-export * from './withWebApp.js';

package/dist/dts/lib/web-app/types.d.ts

@@ -1 +0,0 @@
-export type { WebApp } from '@tma.js/sdk';

package/dist/dts/lib/web-app/useWebApp.d.ts

@@ -1,5 +0,0 @@
-import type { WebApp } from './types.js';
-/**
- * Returns WebApp component instance.
- */
-export declare function useWebApp(): WebApp;

package/dist/dts/lib/web-app/withWebApp.d.ts

@@ -1,9 +0,0 @@
-import { type ComponentType } from 'react';
-import type { WebApp } from './types.js';
-/**
- * HOC which passes WebApp SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export declare function withWebApp<P extends {
-    webApp?: WebApp;
-}>(Component: ComponentType<P>): ComponentType<Omit<P, 'webApp'>>;

package/dist/dts/provider/context.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-import type { SDKContext } from './types.js';
-export declare const sdkContext: import("react").Context<SDKContext>;

package/dist/dts/provider/hooks.d.ts

@@ -1,11 +0,0 @@
-import type { SDKComponent, SDKComponentName } from './types.js';
-/**
- * Returns current SDK information.
- */
-export declare const useSDK: () => import("./types.js").SDKContext;
-/**
- * Returns value by its field name from SDK init result.
- * @param name - component name.
- * @throws {Error} SDK is not initialized.
- */
-export declare function useUnit<N extends SDKComponentName>(name: N): SDKComponent<N>;

package/src/lib/back-button/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useBackButton.js';
-export * from './withBackButton.js';

package/src/lib/back-button/types.ts

@@ -1 +0,0 @@
-export type { BackButton } from '@tma.js/sdk';

package/src/lib/back-button/useBackButton.ts

@@ -1,13 +0,0 @@
-import { useUnit } from '../../provider/index.js';
-import { useEventsTracking } from '../hooks.js';
-import type { BackButton } from './types.js';
-
-/**
- * Returns BackButton component instance.
- */
-export function useBackButton(): BackButton {
-  const backButton = useUnit('backButton');
-  useEventsTracking(backButton, ['isVisibleChanged']);
-
-  return backButton;
-}

package/src/lib/back-button/withBackButton.tsx

@@ -1,18 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import { useBackButton } from './useBackButton.js';
-import type { BackButton } from './types.js';
-
-/**
- * HOC which passes BackButton SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withBackButton<P extends { backButton?: BackButton }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'backButton'>> {
-  return function WithBackButton(props: Omit<P, 'backButton'>) {
-    const p = { ...props, backButton: useBackButton() } as P;
-
-    return <Component {...p} />;
-  };
-}

package/src/lib/closing-behavior/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useClosingBehaviour.js';
-export * from './withClosingBehaviour.js';

package/src/lib/closing-behavior/types.ts

@@ -1 +0,0 @@
-export type { ClosingBehaviour } from '@tma.js/sdk';

package/src/lib/closing-behavior/useClosingBehaviour.ts

@@ -1,13 +0,0 @@
-import { useUnit } from '../../provider/index.js';
-import { useEventsTracking } from '../hooks.js';
-import type { ClosingBehaviour } from './types.js';
-
-/**
- * Returns ClosingBehaviour component instance.
- */
-export function useClosingBehaviour(): ClosingBehaviour {
-  const component = useUnit('closingBehavior');
-  useEventsTracking(component, ['isConfirmationNeededChanged']);
-
-  return component;
-}

package/src/lib/closing-behavior/withClosingBehaviour.tsx

@@ -1,18 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import { useClosingBehaviour } from './useClosingBehaviour.js';
-import type { ClosingBehaviour } from './types.js';
-
-/**
- * HOC which passes ClosingBehaviour SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withClosingBehaviour<P extends { closingBehaviour?: ClosingBehaviour }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'closingBehaviour'>> {
-  return function WithClosingConfirmation(props: Omit<P, 'closingBehaviour'>) {
-    const p = { ...props, closingBehaviour: useClosingBehaviour() } as P;
-
-    return <Component {...p} />;
-  };
-}

package/src/lib/cloud-storage.tsx

@@ -1,28 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import type { CloudStorage } from '@tma.js/sdk';
-
-import { useUnit } from '../provider/index.js';
-
-/**
- * Returns CloudStorage component instance.
- */
-export function useCloudStorage(): CloudStorage {
-  return useUnit('cloudStorage');
-}
-
-/**
- * HOC which passes CloudStorage SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withCloudStorage<P extends { cloudStorage?: CloudStorage }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'cloudStorage'>> {
-  return function WithCloudStorage(props: Omit<P, 'cloudStorage'>) {
-    const p = { ...props, cloudStorage: useCloudStorage() } as P;
-
-    return <Component {...p} />;
-  };
-}
-
-export type { CloudStorage };

package/src/lib/haptic-feedback/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useHapticFeedback.js';
-export * from './withHapticFeedback.js';

package/src/lib/haptic-feedback/types.ts

@@ -1 +0,0 @@
-export type { HapticFeedback } from '@tma.js/sdk';

package/src/lib/haptic-feedback/useHapticFeedback.ts

@@ -1,9 +0,0 @@
-import { useUnit } from '../../provider/index.js';
-import type { HapticFeedback } from './types.js';
-
-/**
- * Returns HapticFeedback component instance.
- */
-export function useHapticFeedback(): HapticFeedback {
-  return useUnit('haptic');
-}

package/src/lib/haptic-feedback/withHapticFeedback.tsx

@@ -1,18 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import { useHapticFeedback } from './useHapticFeedback.js';
-import type { HapticFeedback } from './types.js';
-
-/**
- * HOC which passes HapticFeedback SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withHapticFeedback<P extends { hapticFeedback?: HapticFeedback }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'hapticFeedback'>> {
-  return function WithHapticFeedback(props: Omit<P, 'hapticFeedback'>) {
-    const p = { ...props, hapticFeedback: useHapticFeedback() } as P;
-
-    return <Component {...p} />;
-  };
-}

package/src/lib/hooks.ts

@@ -1,52 +0,0 @@
-import { useCallback, useState, useEffect } from 'react';
-import type { PostEvent } from '@tma.js/sdk';
-
-import { useUnit } from '../provider/index.js';
-
-interface Trackable {
-  on: (event: any, ...args: any[]) => void;
-  off: (event: any, ...args: any[]) => void;
-}
-
-type EventName<T extends Trackable> = T extends {
-  on(event: infer E, ...args: any[]): any
-} ? E : never;
-
-/**
- * The hook which returns function used for force update.
- */
-export function useForceUpdate(): (() => void) {
-  const [, setHash] = useState(0);
-  // TODO: Maybe just assign new symbol?
-  return useCallback(() => setHash((hash) => (hash + 1) % 1_000_000), []);
-}
-
-/**
- * The hook which listens to the specified object events and calls force update
- * in case, some of them was emitted.
- * @param trackable - object which allows events listening.
- * @param events - events to listen. This array will be memoized during first
- * hook call.
- */
-export function useEventsTracking<T extends Trackable>(
-  trackable: T,
-  events: EventName<T>[],
-) {
-  const forceUpdate = useForceUpdate();
-
-  useEffect(() => {
-    // Start listening to each event.
-    events.forEach((event) => trackable.on(event, forceUpdate));
-
-    // On cleanup remove event listeners.
-    return () => events.forEach((event) => trackable.off(event, forceUpdate));
-  }, [trackable, forceUpdate, events]);
-}
-
-/**
- * Returns event posting function which was created during SDK
- * initialization.
- */
-export function usePostEvent(): PostEvent {
-  return useUnit('postEvent');
-}

package/src/lib/index.ts

@@ -1,13 +0,0 @@
-export * from './back-button/index.js';
-export * from './closing-behavior/index.js';
-export * from './haptic-feedback/index.js';
-export * from './launch-params/index.js';
-export * from './main-button/index.js';
-export * from './popup/index.js';
-export * from './qr-scanner/index.js';
-export * from './viewport/index.js';
-export * from './web-app/index.js';
-export * from './cloud-storage.js';
-export { usePostEvent } from './hooks.js';
-export * from './init-data.js';
-export * from './theme-params.js';

package/src/lib/init-data.tsx

@@ -1,43 +0,0 @@
-import React, { type ComponentType } from 'react';
-import type { InitData } from '@tma.js/sdk';
-
-import { useUnit } from '../provider/index.js';
-
-interface EnhancedProps {
-  initData: InitData | null;
-  initDataRaw: string | null;
-}
-
-/**
- * Returns InitData component instance.
- */
-export function useInitData(): InitData | null {
-  return useUnit('initData') || null;
-}
-
-/**
- * Returns init data raw representation.
- */
-export function useInitDataRaw(): string | null {
-  return useUnit('initDataRaw') || null;
-}
-
-/**
- * HOC which passes InitData SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withInitData<P extends Partial<EnhancedProps>>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, keyof EnhancedProps>> {
-  return function WithInitData(props) {
-    const enhancedProps = {
-      ...props,
-      initData: useInitData(),
-      initDataRaw: useInitDataRaw(),
-    } as P;
-
-    return <Component {...enhancedProps} />;
-  };
-}
-
-export { InitData };

package/src/lib/launch-params/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useLaunchParams.js';
-export * from './withLaunchParams.js';

package/src/lib/launch-params/types.ts

@@ -1 +0,0 @@
-export type { LaunchParams } from '@tma.js/launch-params';

package/src/lib/launch-params/useLaunchParams.ts

@@ -1,11 +0,0 @@
-import { useMemo } from 'react';
-import { computeLaunchData } from '@tma.js/launch-params';
-
-import type { LaunchParams } from './types.js';
-
-/**
- * The hook which returns launch parameters initially passed to Mini App.
- */
-export function useLaunchParams(): LaunchParams {
-  return useMemo(() => computeLaunchData().launchParams, []);
-}

package/src/lib/launch-params/withLaunchParams.tsx

@@ -1,18 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import { useLaunchParams } from './useLaunchParams.js';
-import type { LaunchParams } from './types.js';
-
-/**
- * HOC which passes launch parameters to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withLaunchParams<P extends { launchParams?: LaunchParams }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'launchParams'>> {
-  return function WithLaunchParams(props: Omit<P, 'launchParams'>) {
-    const p = { ...props, launchParams: useLaunchParams() } as P;
-
-    return <Component {...p} />;
-  };
-}

package/src/lib/main-button/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useMainButton.js';
-export * from './withMainButton.js';

package/src/lib/main-button/types.ts

@@ -1 +0,0 @@
-export type { MainButton } from '@tma.js/sdk';

package/src/lib/main-button/useMainButton.ts

@@ -1,16 +0,0 @@
-import { useUnit } from '../../provider/index.js';
-import { useEventsTracking } from '../hooks.js';
-import type { MainButton } from './types.js';
-
-/**
- * Returns MainButton component instance.
- */
-export function useMainButton(): MainButton {
-  const mainButton = useUnit('mainButton');
-  useEventsTracking(mainButton, [
-    'isEnabledChanged', 'backgroundColorChanged', 'isProgressVisibleChanged',
-    'textChanged', 'textColorChanged', 'isVisibleChanged',
-  ]);
-
-  return mainButton;
-}

package/src/lib/main-button/withMainButton.tsx

@@ -1,18 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import { useMainButton } from './useMainButton.js';
-import type { MainButton } from './types.js';
-
-/**
- * HOC which passes MainButton SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withMainButton<P extends { mainButton?: MainButton }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'mainButton'>> {
-  return function WithMainButton(props: Omit<P, 'mainButton'>) {
-    const p = { ...props, mainButton: useMainButton() } as P;
-
-    return <Component {...p} />;
-  };
-}

package/src/lib/popup/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './usePopup.js';
-export * from './withPopup.js';

package/src/lib/popup/types.ts

@@ -1 +0,0 @@
-export type { Popup } from '@tma.js/sdk';

package/src/lib/popup/usePopup.ts

@@ -1,13 +0,0 @@
-import { useUnit } from '../../provider/index.js';
-import { useEventsTracking } from '../hooks.js';
-import type { Popup } from './types.js';
-
-/**
- * Returns Popup component instance.
- */
-export function usePopup(): Popup {
-  const popup = useUnit('popup');
-  useEventsTracking(popup, ['isOpenedChanged']);
-
-  return popup;
-}

package/src/lib/popup/withPopup.tsx

@@ -1,18 +0,0 @@
-import React, { type ComponentType } from 'react';
-
-import { usePopup } from './usePopup.js';
-import type { Popup } from './types.js';
-
-/**
- * HOC which passes Popup SDK component to wrapped React component.
- * @param Component - component to wrap.
- */
-export function withPopup<P extends { popup?: Popup }>(
-  Component: ComponentType<P>,
-): ComponentType<Omit<P, 'popup'>> {
-  return function WithPopup(props: Omit<P, 'popup'>) {
-    const p = { ...props, popup: usePopup() } as P;
-
-    return <Component {...p} />;
-  };
-}

package/src/lib/qr-scanner/index.ts

@@ -1,3 +0,0 @@
-export * from './types.js';
-export * from './useQRScanner.js';
-export * from './withQRScanner.js';

package/src/lib/qr-scanner/types.ts

@@ -1 +0,0 @@
-export type { QRScanner } from '@tma.js/sdk';