@grom.js/bot-api-spec 0.6.1 → 0.7.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grom.js/bot-api-spec",
   "type": "module",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "Telegram Bot API specification as a collection of JavaScript objects in a custom format.",
   "license": "MIT",
   "repository": {
@@ -26,26 +26,25 @@
     "node": ">=22.18"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "7.0.1",
-    "@types/node": "22.19.7",
+    "@antfu/eslint-config": "7.3.0",
+    "@types/node": "22.19.10",
     "@types/turndown": "5.0.6",
-    "bumpp": "10.4.0",
-    "cheerio": "1.1.2",
+    "bumpp": "10.4.1",
+    "cheerio": "1.2.0",
     "domhandler": "5.0.3",
     "eslint": "9.39.2",
-    "eslint-plugin-format": "1.3.1",
+    "eslint-plugin-format": "1.4.0",
     "taze": "19.9.2",
     "turndown": "7.2.2",
     "typescript": "5.9.3",
-    "zod": "4.3.5"
+    "zod": "4.3.6"
   },
   "scripts": {
     "typecheck": "tsc --build --noEmit",
     "build": "tsc --build",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "gen:spec": "node ./scripts/gen.ts",
-    "gen:return-types": "node --env-file=./.env ./scripts/gen-return-types.ts",
+    "gen": "node ./scripts/generate.ts",
     "deps": "taze --write --interactive --include-locked minor",
     "release": "bumpp"
   }

package/src/format.ts

@@ -1,3 +1,10 @@
+/**
+ * This module exports types for representing Bot API methods and types
+ * in a structured format.
+ *
+ * @module
+ */
+
 import type { types } from './types.gen.ts'
 
 /**
@@ -8,6 +15,9 @@ export type ApiType
   = | ApiTypeObject
     | ApiTypeOneOf
 
+/**
+ * Bot API type represented as an object with fields.
+ */
 export interface ApiTypeObject {
   /**
    * Name of the type.
@@ -27,6 +37,9 @@ export interface ApiTypeObject {
   oneOf?: never
 }
 
+/**
+ * Bot API type represented as a union of other types.
+ */
 export interface ApiTypeOneOf {
   /**
    * Name of the type.
@@ -46,6 +59,9 @@ export interface ApiTypeOneOf {
   fields?: never
 }
 
+/**
+ * Bot API method with parameters and return type.
+ */
 export interface ApiMethod {
   /**
    * Name of the method.
@@ -68,6 +84,9 @@ export interface ApiMethod {
   returnType: ValueType
 }
 
+/**
+ * Field of a type or parameter of a method.
+ */
 export interface FieldOrParam {
   /**
    * Name of the field/parameter.
@@ -88,11 +107,6 @@ export interface FieldOrParam {
    * Description of the field/parameter.
    */
   description: Description
-
-  /**
-   * Whether this field/parameter should be JSON-serialized.
-   */
-  jsonSerialized: boolean
 }
 
 /**

package/src/index.ts

@@ -1,2 +1,9 @@
+/**
+ * This module exports definitions of all Bot API methods and types.
+ *
+ * @module
+ */
+
 export { methods } from './methods.gen.ts'
+
 export { types } from './types.gen.ts'