@effect-ak/tg-bot-client 1.3.4 → 1.4.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @effect-ak/tg-bot-client
 
+## 1.4.1
+
+### Patch Changes
+
+- 8ac8abd: Add homepage, keywords, and update documentation links to tg-bot-sdk.website
+- Updated dependencies [8ac8abd]
+  - @effect-ak/tg-bot-api@1.3.1
+
+## 1.4.0
+
+### Minor Changes
+
+- c5b9674: Replace thrown `TgBotClientError` with `ClientResult<T>` return type for all client methods
+
 ## 1.3.4
 
 ### Patch Changes

package/dist/index.cjs

@@ -21,43 +21,39 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   MESSAGE_EFFECTS: () => MESSAGE_EFFECTS,
-  TG_BOT_API_URL: () => TG_BOT_API_URL,
-  TgBotClientError: () => TgBotClientError,
   executeTgBotMethod: () => executeTgBotMethod,
-  getFile: () => getFile,
-  isFileContent: () => isFileContent,
-  isMessageEffect: () => isMessageEffect,
-  isTgBotApiResponse: () => isTgBotApiResponse,
   makePayload: () => makePayload,
   makeTgBotClient: () => makeTgBotClient,
-  messageEffectIdCodes: () => messageEffectIdCodes,
-  snakeToCamel: () => snakeToCamel
+  messageEffectIdCodes: () => messageEffectIdCodes
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/errors.ts
-var TgBotClientError = class extends Error {
-  _tag = "TgBotClientError";
-  cause;
-  constructor(options) {
-    super(`TgBotClientError: ${options.cause._tag}`);
-    this.cause = options.cause;
-    this.name = "TgBotClientError";
-  }
-};
-
-// src/guards.ts
+// src/execute.ts
 var isFileContent = (input) => typeof input == "object" && input != null && "file_content" in input && input.file_content instanceof Uint8Array && "file_name" in input && typeof input.file_name == "string";
 var isTgBotApiResponse = (input) => typeof input == "object" && input != null && "ok" in input && typeof input.ok == "boolean";
-
-// src/utils.ts
+var MESSAGE_EFFECTS = {
+  "\u{1F525}": "5104841245755180586",
+  "\u{1F44D}": "5107584321108051014",
+  "\u{1F44E}": "5104858069142078462",
+  "\u2764\uFE0F": "5159385139981059251",
+  "\u{1F389}": "5046509860389126442",
+  "\u{1F4A9}": "5046589136895476101"
+};
+var messageEffectIdCodes = Object.keys(
+  MESSAGE_EFFECTS
+);
+var isMessageEffect = (input) => {
+  return typeof input === "string" && input in MESSAGE_EFFECTS;
+};
 var snakeToCamel = (str) => {
   return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
 };
-
-// src/execute.ts
 async function executeTgBotMethod(params) {
-  const { config, method, input } = params;
+  const { config, method } = params;
+  let { input } = params;
+  if ("message_effect_id" in input && isMessageEffect(input.message_effect_id)) {
+    input = { ...input, message_effect_id: MESSAGE_EFFECTS[input.message_effect_id] };
+  }
   let httpResponse;
   try {
     httpResponse = await fetch(
@@ -68,33 +64,28 @@ async function executeTgBotMethod(params) {
       }
     );
   } catch (cause) {
-    throw new TgBotClientError({
-      cause: { _tag: "ClientInternalError", cause }
-    });
+    return { ok: false, error: { _tag: "ClientInternalError", cause } };
   }
   let response;
   try {
     response = await httpResponse.json();
   } catch {
-    throw new TgBotClientError({
-      cause: { _tag: "NotJsonResponse", response: httpResponse }
-    });
+    return { ok: false, error: { _tag: "NotJsonResponse", response: httpResponse } };
   }
   if (!isTgBotApiResponse(response)) {
-    throw new TgBotClientError({
-      cause: { _tag: "UnexpectedResponse", response }
-    });
+    return { ok: false, error: { _tag: "UnexpectedResponse", response } };
   }
   if (!httpResponse.ok) {
-    throw new TgBotClientError({
-      cause: {
+    return {
+      ok: false,
+      error: {
         _tag: "NotOkResponse",
         ...response.error_code ? { errorCode: response.error_code } : {},
         ...response.description ? { details: response.description } : {}
       }
-    });
+    };
   }
-  return response.result;
+  return { ok: true, data: response.result };
 }
 var makePayload = (body) => {
   const entries = Object.entries(body);
@@ -113,59 +104,8 @@ var makePayload = (body) => {
   return result;
 };
 
-// src/client-file.ts
-var getFile = async (params) => {
-  const { fileId, config, execute } = params;
-  const response = await execute("get_file", { file_id: fileId });
-  const file_path = response.file_path;
-  if (!file_path || file_path.length === 0) {
-    throw new TgBotClientError({
-      cause: {
-        _tag: "UnableToGetFile",
-        cause: "File path not defined"
-      }
-    });
-  }
-  const file_name = file_path.replaceAll("/", "-");
-  const url = `${config.base_url}/file/bot${config.bot_token}/${file_path}`;
-  let content;
-  try {
-    content = await fetch(url).then((_) => _.arrayBuffer());
-  } catch (cause) {
-    throw new TgBotClientError({
-      cause: { _tag: "UnableToGetFile", cause }
-    });
-  }
-  const base64String = () => Buffer.from(content).toString("base64");
-  const file = () => new File([content], file_name, {
-    ...params.type ? { type: params.type } : {}
-  });
-  return {
-    content,
-    file_name,
-    base64String,
-    file
-  };
-};
-
-// src/const.ts
-var TG_BOT_API_URL = "https://api.telegram.org";
-var MESSAGE_EFFECTS = {
-  "\u{1F525}": "5104841245755180586",
-  "\u{1F44D}": "5107584321108051014",
-  "\u{1F44E}": "5104858069142078462",
-  "\u2764\uFE0F": "5159385139981059251",
-  "\u{1F389}": "5046509860389126442",
-  "\u{1F4A9}": "5046589136895476101"
-};
-var messageEffectIdCodes = Object.keys(
-  MESSAGE_EFFECTS
-);
-var isMessageEffect = (input) => {
-  return typeof input === "string" && input in MESSAGE_EFFECTS;
-};
-
 // src/client.ts
+var TG_BOT_API_URL = "https://api.telegram.org";
 function makeTgBotClient(config) {
   const tgConfig = {
     bot_token: config.bot_token,
@@ -176,24 +116,44 @@ function makeTgBotClient(config) {
     method,
     input
   });
+  const getFile = async (params) => {
+    const response = await execute("get_file", { file_id: params.fileId });
+    if (!response.ok) return response;
+    const file_path = response.data.file_path;
+    if (!file_path || file_path.length === 0) {
+      return {
+        ok: false,
+        error: { _tag: "UnableToGetFile", cause: "File path not defined" }
+      };
+    }
+    const file_name = file_path.replaceAll("/", "-");
+    const url = `${tgConfig.base_url}/file/bot${tgConfig.bot_token}/${file_path}`;
+    let content;
+    try {
+      content = await fetch(url).then((_) => _.arrayBuffer());
+    } catch (cause) {
+      return { ok: false, error: { _tag: "UnableToGetFile", cause } };
+    }
+    const base64String = () => Buffer.from(content).toString("base64");
+    const file = () => new File([content], file_name, {
+      ...params.type ? { type: params.type } : {}
+    });
+    return {
+      ok: true,
+      data: { content, file_name, base64String, file }
+    };
+  };
   return {
     config: tgConfig,
     execute,
-    getFile: (input) => getFile({ ...input, config: tgConfig, execute })
+    getFile
   };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   MESSAGE_EFFECTS,
-  TG_BOT_API_URL,
-  TgBotClientError,
   executeTgBotMethod,
-  getFile,
-  isFileContent,
-  isMessageEffect,
-  isTgBotApiResponse,
   makePayload,
   makeTgBotClient,
-  messageEffectIdCodes,
-  snakeToCamel
+  messageEffectIdCodes
 });

package/dist/index.d.cts

@@ -1,44 +1,26 @@
 import { Api } from '@effect-ak/tg-bot-api';
 
+interface TgClientConfig {
+    bot_token: string;
+    base_url?: string;
+}
 interface TgFile {
     readonly content: ArrayBuffer;
     readonly file_name: string;
     readonly base64String: () => string;
     readonly file: () => File;
 }
-declare const getFile: (params: {
-    fileId: string;
-    config: {
-        bot_token: string;
-        base_url: string;
-    };
-    type?: string;
-    execute: ExecuteMethod;
-}) => Promise<TgFile>;
-
 interface TgBotClient {
     readonly config: Required<TgClientConfig>;
     readonly execute: ExecuteMethod;
     readonly getFile: (input: {
         fileId: string;
         type?: string;
-    }) => Promise<TgFile>;
-}
-interface TgClientConfig {
-    bot_token: string;
-    base_url?: string;
+    }) => Promise<ClientResult<TgFile>>;
 }
 declare function makeTgBotClient(config: TgClientConfig): TgBotClient;
 
-type ExecuteMethod = <M extends keyof Api>(method: M, input: Parameters<Api[M]>[0]) => Promise<ReturnType<Api[M]>>;
-declare function executeTgBotMethod<M extends keyof Api>(params: {
-    config: Required<TgClientConfig>;
-    method: M;
-    input: Parameters<Api[M]>[0];
-}): Promise<ReturnType<Api[M]>>;
-declare const makePayload: (body: object) => FormData | undefined;
-
-type ErrorReason = {
+type ClientErrorReason = {
     _tag: "NotOkResponse";
     errorCode?: number;
     details?: string;
@@ -58,28 +40,17 @@ type ErrorReason = {
     _tag: "NotJsonResponse";
     response: unknown;
 };
-declare class TgBotClientError extends Error {
-    readonly _tag = "TgBotClientError";
-    readonly cause: ErrorReason;
-    constructor(options: {
-        cause: ErrorReason;
-    });
-}
-
+type ClientResult<T> = {
+    readonly ok: true;
+    readonly data: T;
+} | {
+    readonly ok: false;
+    readonly error: ClientErrorReason;
+};
 interface FileContent {
     file_content: Uint8Array<ArrayBuffer>;
     file_name: string;
 }
-declare const isFileContent: (input: unknown) => input is FileContent;
-interface TgBotApiResponseSchema {
-    ok: boolean;
-    error_code?: number;
-    description?: string;
-    result?: unknown;
-}
-declare const isTgBotApiResponse: (input: unknown) => input is TgBotApiResponseSchema;
-
-declare const TG_BOT_API_URL = "https://api.telegram.org";
 declare const MESSAGE_EFFECTS: {
     readonly "\uD83D\uDD25": "5104841245755180586";
     readonly "\uD83D\uDC4D": "5107584321108051014";
@@ -90,8 +61,17 @@ declare const MESSAGE_EFFECTS: {
 };
 type MessageEffect = keyof typeof MESSAGE_EFFECTS;
 declare const messageEffectIdCodes: MessageEffect[];
-declare const isMessageEffect: (input: unknown) => input is MessageEffect;
-
-declare const snakeToCamel: (str: string) => string;
+type WithMessageEffect<T> = T extends {
+    message_effect_id?: string;
+} ? Omit<T, "message_effect_id"> & {
+    message_effect_id?: MessageEffect | (string & {});
+} : T;
+type ExecuteMethod = <M extends keyof Api>(method: M, input: WithMessageEffect<Parameters<Api[M]>[0]>) => Promise<ClientResult<ReturnType<Api[M]>>>;
+declare function executeTgBotMethod<M extends keyof Api>(params: {
+    config: Required<TgClientConfig>;
+    method: M;
+    input: Parameters<Api[M]>[0];
+}): Promise<ClientResult<ReturnType<Api[M]>>>;
+declare const makePayload: (body: object) => FormData | undefined;
 
-export { type ExecuteMethod, type FileContent, MESSAGE_EFFECTS, type MessageEffect, TG_BOT_API_URL, type TgBotApiResponseSchema, type TgBotClient, TgBotClientError, type TgClientConfig, type TgFile, executeTgBotMethod, getFile, isFileContent, isMessageEffect, isTgBotApiResponse, makePayload, makeTgBotClient, messageEffectIdCodes, snakeToCamel };
+export { type ClientErrorReason, type ClientResult, type ExecuteMethod, type FileContent, MESSAGE_EFFECTS, type MessageEffect, type TgBotClient, type TgClientConfig, type TgFile, executeTgBotMethod, makePayload, makeTgBotClient, messageEffectIdCodes };

package/dist/index.d.ts

@@ -1,44 +1,26 @@
 import { Api } from '@effect-ak/tg-bot-api';
 
+interface TgClientConfig {
+    bot_token: string;
+    base_url?: string;
+}
 interface TgFile {
     readonly content: ArrayBuffer;
     readonly file_name: string;
     readonly base64String: () => string;
     readonly file: () => File;
 }
-declare const getFile: (params: {
-    fileId: string;
-    config: {
-        bot_token: string;
-        base_url: string;
-    };
-    type?: string;
-    execute: ExecuteMethod;
-}) => Promise<TgFile>;
-
 interface TgBotClient {
     readonly config: Required<TgClientConfig>;
     readonly execute: ExecuteMethod;
     readonly getFile: (input: {
         fileId: string;
         type?: string;
-    }) => Promise<TgFile>;
-}
-interface TgClientConfig {
-    bot_token: string;
-    base_url?: string;
+    }) => Promise<ClientResult<TgFile>>;
 }
 declare function makeTgBotClient(config: TgClientConfig): TgBotClient;
 
-type ExecuteMethod = <M extends keyof Api>(method: M, input: Parameters<Api[M]>[0]) => Promise<ReturnType<Api[M]>>;
-declare function executeTgBotMethod<M extends keyof Api>(params: {
-    config: Required<TgClientConfig>;
-    method: M;
-    input: Parameters<Api[M]>[0];
-}): Promise<ReturnType<Api[M]>>;
-declare const makePayload: (body: object) => FormData | undefined;
-
-type ErrorReason = {
+type ClientErrorReason = {
     _tag: "NotOkResponse";
     errorCode?: number;
     details?: string;
@@ -58,28 +40,17 @@ type ErrorReason = {
     _tag: "NotJsonResponse";
     response: unknown;
 };
-declare class TgBotClientError extends Error {
-    readonly _tag = "TgBotClientError";
-    readonly cause: ErrorReason;
-    constructor(options: {
-        cause: ErrorReason;
-    });
-}
-
+type ClientResult<T> = {
+    readonly ok: true;
+    readonly data: T;
+} | {
+    readonly ok: false;
+    readonly error: ClientErrorReason;
+};
 interface FileContent {
     file_content: Uint8Array<ArrayBuffer>;
     file_name: string;
 }
-declare const isFileContent: (input: unknown) => input is FileContent;
-interface TgBotApiResponseSchema {
-    ok: boolean;
-    error_code?: number;
-    description?: string;
-    result?: unknown;
-}
-declare const isTgBotApiResponse: (input: unknown) => input is TgBotApiResponseSchema;
-
-declare const TG_BOT_API_URL = "https://api.telegram.org";
 declare const MESSAGE_EFFECTS: {
     readonly "\uD83D\uDD25": "5104841245755180586";
     readonly "\uD83D\uDC4D": "5107584321108051014";
@@ -90,8 +61,17 @@ declare const MESSAGE_EFFECTS: {
 };
 type MessageEffect = keyof typeof MESSAGE_EFFECTS;
 declare const messageEffectIdCodes: MessageEffect[];
-declare const isMessageEffect: (input: unknown) => input is MessageEffect;
-
-declare const snakeToCamel: (str: string) => string;
+type WithMessageEffect<T> = T extends {
+    message_effect_id?: string;
+} ? Omit<T, "message_effect_id"> & {
+    message_effect_id?: MessageEffect | (string & {});
+} : T;
+type ExecuteMethod = <M extends keyof Api>(method: M, input: WithMessageEffect<Parameters<Api[M]>[0]>) => Promise<ClientResult<ReturnType<Api[M]>>>;
+declare function executeTgBotMethod<M extends keyof Api>(params: {
+    config: Required<TgClientConfig>;
+    method: M;
+    input: Parameters<Api[M]>[0];
+}): Promise<ClientResult<ReturnType<Api[M]>>>;
+declare const makePayload: (body: object) => FormData | undefined;
 
-export { type ExecuteMethod, type FileContent, MESSAGE_EFFECTS, type MessageEffect, TG_BOT_API_URL, type TgBotApiResponseSchema, type TgBotClient, TgBotClientError, type TgClientConfig, type TgFile, executeTgBotMethod, getFile, isFileContent, isMessageEffect, isTgBotApiResponse, makePayload, makeTgBotClient, messageEffectIdCodes, snakeToCamel };
+export { type ClientErrorReason, type ClientResult, type ExecuteMethod, type FileContent, MESSAGE_EFFECTS, type MessageEffect, type TgBotClient, type TgClientConfig, type TgFile, executeTgBotMethod, makePayload, makeTgBotClient, messageEffectIdCodes };

package/dist/index.js

@@ -1,26 +1,29 @@
-// src/errors.ts
-var TgBotClientError = class extends Error {
-  _tag = "TgBotClientError";
-  cause;
-  constructor(options) {
-    super(`TgBotClientError: ${options.cause._tag}`);
-    this.cause = options.cause;
-    this.name = "TgBotClientError";
-  }
-};
-
-// src/guards.ts
+// src/execute.ts
 var isFileContent = (input) => typeof input == "object" && input != null && "file_content" in input && input.file_content instanceof Uint8Array && "file_name" in input && typeof input.file_name == "string";
 var isTgBotApiResponse = (input) => typeof input == "object" && input != null && "ok" in input && typeof input.ok == "boolean";
-
-// src/utils.ts
+var MESSAGE_EFFECTS = {
+  "\u{1F525}": "5104841245755180586",
+  "\u{1F44D}": "5107584321108051014",
+  "\u{1F44E}": "5104858069142078462",
+  "\u2764\uFE0F": "5159385139981059251",
+  "\u{1F389}": "5046509860389126442",
+  "\u{1F4A9}": "5046589136895476101"
+};
+var messageEffectIdCodes = Object.keys(
+  MESSAGE_EFFECTS
+);
+var isMessageEffect = (input) => {
+  return typeof input === "string" && input in MESSAGE_EFFECTS;
+};
 var snakeToCamel = (str) => {
   return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
 };
-
-// src/execute.ts
 async function executeTgBotMethod(params) {
-  const { config, method, input } = params;
+  const { config, method } = params;
+  let { input } = params;
+  if ("message_effect_id" in input && isMessageEffect(input.message_effect_id)) {
+    input = { ...input, message_effect_id: MESSAGE_EFFECTS[input.message_effect_id] };
+  }
   let httpResponse;
   try {
     httpResponse = await fetch(
@@ -31,33 +34,28 @@ async function executeTgBotMethod(params) {
       }
     );
   } catch (cause) {
-    throw new TgBotClientError({
-      cause: { _tag: "ClientInternalError", cause }
-    });
+    return { ok: false, error: { _tag: "ClientInternalError", cause } };
   }
   let response;
   try {
     response = await httpResponse.json();
   } catch {
-    throw new TgBotClientError({
-      cause: { _tag: "NotJsonResponse", response: httpResponse }
-    });
+    return { ok: false, error: { _tag: "NotJsonResponse", response: httpResponse } };
   }
   if (!isTgBotApiResponse(response)) {
-    throw new TgBotClientError({
-      cause: { _tag: "UnexpectedResponse", response }
-    });
+    return { ok: false, error: { _tag: "UnexpectedResponse", response } };
   }
   if (!httpResponse.ok) {
-    throw new TgBotClientError({
-      cause: {
+    return {
+      ok: false,
+      error: {
         _tag: "NotOkResponse",
         ...response.error_code ? { errorCode: response.error_code } : {},
         ...response.description ? { details: response.description } : {}
       }
-    });
+    };
   }
-  return response.result;
+  return { ok: true, data: response.result };
 }
 var makePayload = (body) => {
   const entries = Object.entries(body);
@@ -76,59 +74,8 @@ var makePayload = (body) => {
   return result;
 };
 
-// src/client-file.ts
-var getFile = async (params) => {
-  const { fileId, config, execute } = params;
-  const response = await execute("get_file", { file_id: fileId });
-  const file_path = response.file_path;
-  if (!file_path || file_path.length === 0) {
-    throw new TgBotClientError({
-      cause: {
-        _tag: "UnableToGetFile",
-        cause: "File path not defined"
-      }
-    });
-  }
-  const file_name = file_path.replaceAll("/", "-");
-  const url = `${config.base_url}/file/bot${config.bot_token}/${file_path}`;
-  let content;
-  try {
-    content = await fetch(url).then((_) => _.arrayBuffer());
-  } catch (cause) {
-    throw new TgBotClientError({
-      cause: { _tag: "UnableToGetFile", cause }
-    });
-  }
-  const base64String = () => Buffer.from(content).toString("base64");
-  const file = () => new File([content], file_name, {
-    ...params.type ? { type: params.type } : {}
-  });
-  return {
-    content,
-    file_name,
-    base64String,
-    file
-  };
-};
-
-// src/const.ts
-var TG_BOT_API_URL = "https://api.telegram.org";
-var MESSAGE_EFFECTS = {
-  "\u{1F525}": "5104841245755180586",
-  "\u{1F44D}": "5107584321108051014",
-  "\u{1F44E}": "5104858069142078462",
-  "\u2764\uFE0F": "5159385139981059251",
-  "\u{1F389}": "5046509860389126442",
-  "\u{1F4A9}": "5046589136895476101"
-};
-var messageEffectIdCodes = Object.keys(
-  MESSAGE_EFFECTS
-);
-var isMessageEffect = (input) => {
-  return typeof input === "string" && input in MESSAGE_EFFECTS;
-};
-
 // src/client.ts
+var TG_BOT_API_URL = "https://api.telegram.org";
 function makeTgBotClient(config) {
   const tgConfig = {
     bot_token: config.bot_token,
@@ -139,23 +86,43 @@ function makeTgBotClient(config) {
     method,
     input
   });
+  const getFile = async (params) => {
+    const response = await execute("get_file", { file_id: params.fileId });
+    if (!response.ok) return response;
+    const file_path = response.data.file_path;
+    if (!file_path || file_path.length === 0) {
+      return {
+        ok: false,
+        error: { _tag: "UnableToGetFile", cause: "File path not defined" }
+      };
+    }
+    const file_name = file_path.replaceAll("/", "-");
+    const url = `${tgConfig.base_url}/file/bot${tgConfig.bot_token}/${file_path}`;
+    let content;
+    try {
+      content = await fetch(url).then((_) => _.arrayBuffer());
+    } catch (cause) {
+      return { ok: false, error: { _tag: "UnableToGetFile", cause } };
+    }
+    const base64String = () => Buffer.from(content).toString("base64");
+    const file = () => new File([content], file_name, {
+      ...params.type ? { type: params.type } : {}
+    });
+    return {
+      ok: true,
+      data: { content, file_name, base64String, file }
+    };
+  };
   return {
     config: tgConfig,
     execute,
-    getFile: (input) => getFile({ ...input, config: tgConfig, execute })
+    getFile
   };
 }
 export {
   MESSAGE_EFFECTS,
-  TG_BOT_API_URL,
-  TgBotClientError,
   executeTgBotMethod,
-  getFile,
-  isFileContent,
-  isMessageEffect,
-  isTgBotApiResponse,
   makePayload,
   makeTgBotClient,
-  messageEffectIdCodes,
-  snakeToCamel
+  messageEffectIdCodes
 };