@grom.js/bot-api-spec 0.4.0 → 0.5.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grom.js/bot-api-spec",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Telegram Bot API specification as a collection of JavaScript objects in a custom format.",
   "license": "MIT",
   "repository": {
@@ -12,32 +12,41 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
+    },
+    "./format": {
+      "types": "./dist/format.d.ts",
+      "import": "./dist/format.js"
     }
   },
   "files": [
-    "dist/"
+    "./dist/",
+    "./src/"
   ],
+  "engines": {
+    "node": ">=22.18"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "7.0.1",
+    "@types/node": "22.19.7",
+    "@types/turndown": "5.0.6",
+    "bumpp": "10.4.0",
+    "cheerio": "1.1.2",
+    "domhandler": "5.0.3",
+    "eslint": "9.39.2",
+    "eslint-plugin-format": "1.3.1",
+    "taze": "19.9.2",
+    "turndown": "7.2.2",
+    "typescript": "5.9.3",
+    "zod": "4.3.5"
+  },
   "scripts": {
-    "typecheck": "tsc",
-    "build": "tsdown",
+    "typecheck": "tsc --build --noEmit",
+    "build": "tsc --build",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "gen:spec": "bun run ./scripts/gen.ts",
-    "gen:return-types": "bun run ./scripts/gen-return-types.ts",
+    "gen:spec": "node ./scripts/gen.ts",
+    "gen:return-types": "node --env-file=./.env ./scripts/gen-return-types.ts",
+    "deps": "taze --write --interactive --include-locked minor",
     "release": "bumpp"
-  },
-  "devDependencies": {
-    "@antfu/eslint-config": "^5.4.1",
-    "@types/bun": "^1.2.22",
-    "@types/turndown": "^5.0.5",
-    "bumpp": "^10.2.3",
-    "cheerio": "^1.1.2",
-    "domhandler": "^5.0.3",
-    "eslint": "^9.36.0",
-    "eslint-plugin-format": "^1.0.1",
-    "tsdown": "^0.15.5",
-    "turndown": "^7.2.1",
-    "typescript": "^5.9.2",
-    "zod": "^4.1.11"
   }
-}
+}

package/src/format.ts

@@ -0,0 +1,188 @@
+import type { types } from './types.gen.ts'
+
+/**
+ * Type defined in the API. It can either be an {@link ApiTypeObject object}
+ * or a {@link ApiTypeOneOf union}.
+ */
+export type ApiType
+  = | ApiTypeObject
+    | ApiTypeOneOf
+
+export interface ApiTypeObject {
+  /**
+   * Name of the type.
+   */
+  name: string
+
+  /**
+   * Description of the type.
+   */
+  description: Description
+
+  /**
+   * Fields of the object representing this type.
+   */
+  fields: Array<FieldOrParam>
+
+  oneOf?: never
+}
+
+export interface ApiTypeOneOf {
+  /**
+   * Name of the type.
+   */
+  name: string
+
+  /**
+   * Description of the type.
+   */
+  description: Description
+
+  /**
+   * Array of possible types this type can be.
+   */
+  oneOf: Array<ValueTypeApiType>
+
+  fields?: never
+}
+
+export interface ApiMethod {
+  /**
+   * Name of the method.
+   */
+  name: string
+
+  /**
+   * Description of the method.
+   */
+  description: Description
+
+  /**
+   * Parameters this method takes.
+   */
+  parameters: Array<FieldOrParam>
+
+  /**
+   * Type of the value this method returns.
+   */
+  returnType: ValueType
+}
+
+export interface FieldOrParam {
+  /**
+   * Name of the field/parameter.
+   */
+  name: string
+
+  /**
+   * Type of the value this field/parameter can be assigned.
+   */
+  type: ValueType
+
+  /**
+   * Whether this is a required field/parameter.
+   */
+  required: boolean
+
+  /**
+   * Description of the field/parameter.
+   */
+  description: Description
+
+  /**
+   * Whether this field/parameter should be JSON-serialized.
+   */
+  jsonSerialized: boolean
+}
+
+/**
+ * Description of a type/method/field/parameter.
+ */
+export interface Description {
+  markdown: string
+}
+
+/**
+ * Type of a value.
+ */
+export type ValueType
+  = | ValueTypeString
+    | ValueTypeBoolean
+    | ValueTypeInteger32
+    | ValueTypeInteger53
+    | ValueTypeFloat
+    | ValueTypeInputFile
+    | ValueTypeApiType
+    | ValueTypeArray
+    | ValueTypeUnion
+
+/**
+ * `String` value type.
+ */
+export interface ValueTypeString {
+  type: 'str'
+  literal?: string
+}
+
+/**
+ * `Boolean` value type.
+ */
+export interface ValueTypeBoolean {
+  type: 'bool'
+  literal?: boolean
+}
+
+/**
+ * `Integer` value type, which fits in a 32-bit integer.
+ */
+export interface ValueTypeInteger32 {
+  type: 'int32'
+  literal?: number
+}
+
+/**
+ * `Integer` value type, which may have more than 32 significant bits, but has
+ * at most 52 significant bits, so a 64-bit integer or double-precision float
+ * type are safe for storing values of this type.
+ */
+export interface ValueTypeInteger53 {
+  type: 'int53'
+}
+
+/**
+ * `Float` value type.
+ */
+export interface ValueTypeFloat {
+  type: 'float'
+}
+
+/**
+ * [`InputFile`](https://core.telegram.org/bots/api#inputfile) value type.
+ */
+export interface ValueTypeInputFile {
+  type: 'input-file'
+}
+
+/**
+ * Any {@link ApiType} value type.
+ */
+export interface ValueTypeApiType {
+  type: 'api-type'
+  name: keyof typeof types
+}
+
+/**
+ * Array of any value type.
+ */
+export interface ValueTypeArray {
+  type: 'array'
+  of: ValueType
+}
+
+/**
+ * Union of any value types.
+ */
+export interface ValueTypeUnion {
+  type: 'union'
+  types: Array<ValueType>
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { methods } from './methods.gen.ts'
+export { types } from './types.gen.ts'