Merge pull request #847 from Telegram-Mini-Apps/feature/simplify-fp-ts-usage

refactor(all-packages): simplify usage of fp-ts

Author: heyqbnk

.changeset/loud-pianos-accept.md

@@ -0,0 +1,9 @@
+---
+"@tma.js/init-data-node": patch
+"@tma.js/transformers": patch
+"@tma.js/toolkit": patch
+"@tma.js/bridge": patch
+"@tma.js/sdk": patch
+---
+
+Simplify usage of fp-ts to potentially avoid building problems in some applications.

packages/bridge/src/base64-url.ts

@@ -1,5 +1,5 @@
 import { throwifyFpFn } from '@tma.js/toolkit';
-import * as E from 'fp-ts/Either';
+import { either as E } from 'fp-ts';
 
 export type DecodeBase64UrlError = DOMException;
 

packages/bridge/src/env/isTMA.test.ts

@@ -1,6 +1,5 @@
 import { TimeoutError } from 'better-promises';
-import * as TE from 'fp-ts/TaskEither';
-import { pipe } from 'fp-ts/function';
+import { taskEither as TE, function as fn } from 'fp-ts';
 import {
   createWindow,
   mockSessionStorageGetItem,
@@ -79,7 +78,7 @@ describe('isTMAFp', () => {
   describe('complete', () => {
     it('should return true if current window contains TelegramWebviewProxy property', async () => {
       createWindow({ TelegramWebviewProxy: { postEvent: () => undefined } } as any);
-      await pipe(
+      await fn.pipe(
         isTMAFp('complete'),
         TE.match(
           () => expect.unreachable(),
@@ -94,7 +93,7 @@ describe('isTMAFp', () => {
       async () => {
         createWindow();
         requestFp.mockImplementationOnce(() => TE.right({}));
-        await pipe(
+        await fn.pipe(
           isTMAFp('complete'),
           TE.match(
             () => expect.unreachable(),
@@ -110,7 +109,7 @@ describe('isTMAFp', () => {
       async () => {
         createWindow();
         requestFp.mockImplementationOnce(() => TE.left(new TimeoutError(100)));
-        await pipe(
+        await fn.pipe(
           isTMAFp('complete'),
           TE.match(
             () => expect.unreachable(),
@@ -120,7 +119,7 @@ describe('isTMAFp', () => {
         expect.assertions(1);
 
         requestFp.mockImplementationOnce(() => TE.left(new Error('something else')));
-        await pipe(
+        await fn.pipe(
           isTMAFp('complete'),
           TE.match(
             error => expect(error).toStrictEqual(new Error('something else')),
@@ -134,7 +133,7 @@ describe('isTMAFp', () => {
     it('should return false if the env is unknown', async () => {
       mockWindow({} as any);
       requestFp.mockImplementationOnce(() => TE.left(new UnknownEnvError()));
-      await pipe(
+      await fn.pipe(
         isTMAFp('complete'),
         TE.match(
           () => expect.unreachable(),

packages/bridge/src/env/isTMA.ts

@@ -4,9 +4,7 @@ import {
   type BetterPromiseOptions,
   TimeoutError,
 } from 'better-promises';
-import * as E from 'fp-ts/Either';
-import * as TE from 'fp-ts/TaskEither';
-import { pipe } from 'fp-ts/function';
+import { either as E, taskEither as TE, function as fn } from 'fp-ts';
 
 import { hasWebviewProxy } from '@/env/hasWebviewProxy.js';
 import { UnknownEnvError } from '@/errors.js';
@@ -31,9 +29,9 @@ export function isTMA(
     // @ts-expect-error TS doesn't get what override we are going to use.
     type,
     options,
-  ) as boolean | TE.TaskEither<isTMAError, boolean>;
+  );
   return typeof monad === 'function'
-    ? BetterPromise.fn(() => throwifyAnyEither(monad))
+    ? BetterPromise.fn(() => throwifyAnyEither(monad as TE.TaskEither<any, boolean>))
     : monad;
 }
 
@@ -65,14 +63,14 @@ export function isTMAFp(
 ): boolean | TE.TaskEither<isTMAError, boolean> {
   const hasProxy = hasWebviewProxy(window);
   if (!type) {
-    return hasProxy || pipe(retrieveRawLaunchParamsFp(), E.match(() => false, () => true));
+    return hasProxy || fn.pipe(retrieveRawLaunchParamsFp(), E.match(() => false, () => true));
   }
   if (hasProxy) {
     return TE.right(true);
   }
   const { timeout = 100 } = options || {};
 
-  return pipe(
+  return fn.pipe(
     request2Fp('web_app_request_theme', 'theme_changed', { ...options, timeout }),
     TE.match(
       error => (

packages/bridge/src/launch-params.test.ts

@@ -1,5 +1,4 @@
-import * as E from 'fp-ts/Either';
-import * as O from 'fp-ts/Option';
+import { either as E, option as O } from 'fp-ts';
 import { afterEach, describe, expect, it, vi } from 'vitest';
 
 import {

packages/bridge/src/launch-params.ts

@@ -4,9 +4,7 @@ import {
   type LaunchParamsGenType,
   type ParseLaunchParamsQueryError,
 } from '@tma.js/transformers';
-import * as E from 'fp-ts/Either';
-import * as O from 'fp-ts/Option';
-import { pipe } from 'fp-ts/function';
+import { either as E, function as fn, option as O } from 'fp-ts';
 
 import { LaunchParamsRetrieveError } from '@/errors.js';
 
@@ -39,7 +37,7 @@ export function retrieveLaunchParamsFp(): E.Either<
   RetrieveLaunchParamsError,
   RetrieveLaunchParamsResult
 > {
-  return pipe(
+  return fn.pipe(
     retrieveRawLaunchParamsFp(),
     E.chainW(parseLaunchParamsQueryFp),
   );
@@ -55,7 +53,7 @@ export const retrieveLaunchParams: () => RetrieveLaunchParamsResult =
  * @returns Raw init data from any known source.
  */
 export function retrieveRawInitDataFp(): E.Either<RetrieveRawInitDataError, O.Option<string>> {
-  return pipe(
+  return fn.pipe(
     retrieveRawLaunchParamsFp(),
     E.map(raw => {
       const v = new URLSearchParams(raw).get('tgWebAppData');
@@ -68,7 +66,7 @@ export function retrieveRawInitDataFp(): E.Either<RetrieveRawInitDataError, O.Op
  * @see retrieveRawInitDataFp
  */
 export function retrieveRawInitData(): string | undefined {
-  return pipe(
+  return fn.pipe(
     retrieveRawInitDataFp(),
     E.fold(err => {
       throw err;
@@ -101,7 +99,7 @@ export function retrieveRawLaunchParamsFp(): E.Either<RetrieveRawLaunchParamsErr
       errors.push({ source, error: new Error('Source is empty') });
       continue;
     }
-    const maybeError = pipe(
+    const maybeError = fn.pipe(
       parseLaunchParamsQueryFp(v),
       E.foldW(err => err, () => true as const),
     );

packages/bridge/src/methods/postEvent.test.ts

@@ -1,4 +1,4 @@
-import * as E from 'fp-ts/Either';
+import { either as E } from 'fp-ts';
 import { createWindow } from 'test-utils';
 import {
   expect,

packages/bridge/src/methods/postEvent.ts

@@ -1,5 +1,4 @@
-import * as E from 'fp-ts/Either';
-import { pipe } from 'fp-ts/function';
+import { either as E, function as fpFn } from 'fp-ts';
 import { function as fn, is, looseObject } from 'valibot';
 
 import { hasWebviewProxy } from '@/env/hasWebviewProxy.js';
@@ -43,7 +42,7 @@ export function postEvent(
   eventType: MethodName,
   eventData?: MethodParams<MethodName>,
 ): void {
-  pipe(
+  fpFn.pipe(
     postEventFp(
       // @ts-expect-error It's ok, TS can't determine a specific override.
       eventType,

packages/bridge/src/start-param.test.ts

@@ -1,4 +1,4 @@
-import * as E from 'fp-ts/Either';
+import { either as E } from 'fp-ts';
 import { describe, expect, it } from 'vitest';
 
 import {

packages/bridge/src/start-param.ts

@@ -1,7 +1,5 @@
 import { throwifyFpFn, throwifyAnyEither } from '@tma.js/toolkit';
-import * as E from 'fp-ts/Either';
-import * as J from 'fp-ts/Json';
-import { pipe } from 'fp-ts/function';
+import { either as E, function as fn, json as J } from 'fp-ts';
 
 import { encodeBase64Url, type DecodeBase64UrlError, decodeBase64UrlFp } from '@/base64-url.js';
 
@@ -80,7 +78,7 @@ export function decodeStartParamFp<L, R>(
   value: string,
   arg2?: 'json' | ((value: string) => E.Either<L, R>),
 ): E.Either<DecodeBase64UrlError | SyntaxError | L, R | string | J.Json> {
-  return pipe(
+  return fn.pipe(
     decodeBase64UrlFp(value),
     E.chain<DecodeBase64UrlError | SyntaxError | L, string, R | string | J.Json>(decoded => {
       if (!arg2) {