@tgify/tgify 0.1.0

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.argsParser = void 0;
+var args_1 = require("./core/helpers/args");
+Object.defineProperty(exports, "argsParser", { enumerable: true, get: function () { return args_1.argsParser; } });

package/markup.d.ts

@@ -0,0 +1 @@
+export * from './typings/markup'

package/markup.js

@@ -0,0 +1 @@
+module.exports = require('./lib/markup')

package/package.json

@@ -0,0 +1,140 @@
+{
+  "name": "@tgify/tgify",
+  "version": "0.1.0",
+  "description": "Modern Telegram Bot Framework",
+  "license": "MIT",
+  "author": "IATNAOD",
+  "homepage": "https://tgify.iatnaod.space",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/IATNAOD/tgify.git"
+  },
+  "bugs": {
+    "url": "https://github.com/IATNAOD/tgify/issues"
+  },
+  "main": "lib/index.js",
+  "exports": {
+    ".": {
+      "types": "./typings/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./filters": {
+      "types": "./filters.d.ts",
+      "default": "./filters.js"
+    },
+    "./future": {
+      "types": "./future.d.ts",
+      "default": "./future.js"
+    },
+    "./scenes": {
+      "types": "./scenes.d.ts",
+      "default": "./scenes.js"
+    },
+    "./types": {
+      "types": "./types.d.ts",
+      "default": "./types.js"
+    },
+    "./format": {
+      "types": "./format.d.ts",
+      "default": "./format.js"
+    },
+    "./utils": {
+      "types": "./utils.d.ts",
+      "default": "./utils.js"
+    },
+    "./markup": {
+      "types": "./markup.d.ts",
+      "default": "./markup.js"
+    },
+    "./session": {
+      "types": "./session.d.ts",
+      "default": "./session.js"
+    }
+  },
+  "files": [
+    "bin/*",
+    "src/**/*.ts",
+    "lib/**/*.js",
+    "typings/**/*.d.ts",
+    "typings/**/*.d.ts.map",
+    "types.*",
+    "format.*",
+    "filters.*",
+    "future.*",
+    "scenes.*",
+    "utils.*",
+    "markup.*",
+    "session.*"
+  ],
+  "bin": {
+    "tgify": "lib/cli.mjs"
+  },
+  "scripts": {
+    "prepare": "npm run --silent build",
+    "build": "tsc && npm run expose",
+    "expose": "tsx build/expose.ts types scenes filters format future utils markup session",
+    "build:docs": "typedoc src/index.ts",
+    "pretest": "npm run build",
+    "test": "ava",
+    "lint": "eslint .",
+    "lint:fix": "npm run lint -- --fix",
+    "checks": "npm test && npm run lint",
+    "refresh": "npm run clean && npm ci",
+    "clean": "git clean -fX .eslintcache docs/build/ lib/ typings/"
+  },
+  "ava": {
+    "files": [
+      "test/*",
+      "!test/_*"
+    ]
+  },
+  "type": "commonjs",
+  "engines": {
+    "node": "^12.20.0 || >=14.13.1"
+  },
+  "types": "./typings/index.d.ts",
+  "dependencies": {
+    "@telegraf/types": "^7.1.0",
+    "abort-controller": "^3.0.0",
+    "debug": "^4.3.5",
+    "mri": "^1.2.0",
+    "node-fetch": "^2.7.0",
+    "p-timeout": "^4.1.0",
+    "safe-compare": "^1.1.4",
+    "sandwich-stream": "^2.0.2"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.8",
+    "@types/node": "^20.4.2",
+    "@types/node-fetch": "^2.6.2",
+    "@types/safe-compare": "^1.1.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "ava": "^5.3.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-ava": "^14.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^6.1.1",
+    "fast-check": "^3.12.0",
+    "prettier": "^3.0.3",
+    "tsx": "^4.7.1",
+    "typedoc": "^0.25.0",
+    "typescript": "^5.2.2"
+  },
+  "keywords": [
+    "tgify",
+    "telegram",
+    "telegram bot api",
+    "bot",
+    "botapi",
+    "bot framework"
+  ],
+  "directories": {
+    "doc": "docs",
+    "lib": "lib",
+    "test": "test"
+  }
+}

package/scenes.d.ts

@@ -0,0 +1 @@
+export * from './typings/scenes'

package/scenes.js

@@ -0,0 +1 @@
+module.exports = require('./lib/scenes')

package/session.d.ts

@@ -0,0 +1 @@
+export * from './typings/session'

package/session.js

@@ -0,0 +1 @@
+module.exports = require('./lib/session')

package/src/button.ts

@@ -0,0 +1,182 @@
+import {
+  InlineKeyboardButton,
+  KeyboardButton,
+  KeyboardButtonRequestChat,
+  KeyboardButtonRequestUsers,
+} from './core/types/typegram'
+
+type Hideable<B> = B & { hide: boolean }
+
+export function text(
+  text: string,
+  hide = false
+): Hideable<KeyboardButton.CommonButton> {
+  return { text, hide }
+}
+
+export function contactRequest(
+  text: string,
+  hide = false
+): Hideable<KeyboardButton.RequestContactButton> {
+  return { text, request_contact: true, hide }
+}
+
+export function locationRequest(
+  text: string,
+  hide = false
+): Hideable<KeyboardButton.RequestLocationButton> {
+  return { text, request_location: true, hide }
+}
+
+export function pollRequest(
+  text: string,
+  type?: 'quiz' | 'regular',
+  hide = false
+): Hideable<KeyboardButton.RequestPollButton> {
+  return { text, request_poll: { type }, hide }
+}
+
+export function userRequest(
+  text: string,
+  /** Must fit in a signed 32 bit int */
+  request_id: number,
+  extra?: Omit<KeyboardButtonRequestUsers, 'request_id' | 'text'>,
+  hide = false
+): Hideable<KeyboardButton.RequestUsersButton> {
+  return {
+    text,
+    request_users: { request_id, ...extra },
+    hide,
+  }
+}
+
+export function botRequest(
+  text: string,
+  /** Must fit in a signed 32 bit int */
+  request_id: number,
+  extra?: Omit<
+    KeyboardButtonRequestUsers,
+    'request_id' | 'user_is_bot' | 'text'
+  >,
+  hide = false
+): Hideable<KeyboardButton.RequestUsersButton> {
+  return {
+    text,
+    request_users: { request_id, user_is_bot: true, ...extra },
+    hide,
+  }
+}
+
+type KeyboardButtonRequestGroup = Omit<
+  KeyboardButtonRequestChat,
+  'request_id' | 'chat_is_channel'
+>
+
+export function groupRequest(
+  text: string,
+  /** Must fit in a signed 32 bit int */
+  request_id: number,
+  extra?: KeyboardButtonRequestGroup,
+  hide = false
+): Hideable<KeyboardButton.RequestChatButton> {
+  return {
+    text,
+    request_chat: { request_id, chat_is_channel: false, ...extra },
+    hide,
+  }
+}
+
+type KeyboardButtonRequestChannel = Omit<
+  KeyboardButtonRequestChat,
+  'request_id' | 'chat_is_channel' | 'chat_is_forum'
+>
+
+export function channelRequest(
+  text: string,
+  /** Must fit in a signed 32 bit int */
+  request_id: number,
+  extra?: KeyboardButtonRequestChannel,
+  hide = false
+): Hideable<KeyboardButton.RequestChatButton> {
+  return {
+    text,
+    request_chat: { request_id, chat_is_channel: true, ...extra },
+    hide,
+  }
+}
+
+export function url(
+  text: string,
+  url: string,
+  hide = false
+): Hideable<InlineKeyboardButton.UrlButton> {
+  return { text, url, hide }
+}
+
+export function callback(
+  text: string,
+  data: string,
+  hide = false
+): Hideable<InlineKeyboardButton.CallbackButton> {
+  return { text, callback_data: data, hide }
+}
+
+export function switchToChat(
+  text: string,
+  value: string,
+  hide = false
+): Hideable<InlineKeyboardButton.SwitchInlineButton> {
+  return { text, switch_inline_query: value, hide }
+}
+
+export function switchToCurrentChat(
+  text: string,
+  value: string,
+  hide = false
+): Hideable<InlineKeyboardButton.SwitchInlineCurrentChatButton> {
+  return { text, switch_inline_query_current_chat: value, hide }
+}
+
+export function game(
+  text: string,
+  hide = false
+): Hideable<InlineKeyboardButton.GameButton> {
+  return { text, callback_game: {}, hide }
+}
+
+export function pay(
+  text: string,
+  hide = false
+): Hideable<InlineKeyboardButton.PayButton> {
+  return { text, pay: true, hide }
+}
+
+export function login(
+  text: string,
+  url: string,
+  opts: {
+    forward_text?: string
+    bot_username?: string
+    request_write_access?: boolean
+  } = {},
+  hide = false
+): Hideable<InlineKeyboardButton.LoginButton> {
+  return {
+    text,
+    login_url: { ...opts, url },
+    hide,
+  }
+}
+
+export function webApp(
+  text: string,
+  url: string,
+  hide = false
+  // works as both InlineKeyboardButton and KeyboardButton
+): Hideable<InlineKeyboardButton.WebAppButton> {
+  return {
+    text,
+    web_app: { url },
+    hide,
+  }
+}