@grom.js/bot-api-spec 0.6.0 → 0.6.2

package/README.md

@@ -1,8 +1,8 @@
 [![bot-api](https://img.shields.io/badge/v9.3-000?style=flat&logo=telegram&logoColor=%2325A3E1&label=Bot%20API&labelColor=%23000&color=%2325A3E1)][bot-api]
-[![npm](https://img.shields.io/npm/v/%40grom.js%2Fbot-api-spec?style=flat&logo=npm&logoColor=%23BB443E&logoSize=auto&label=%C2%A0&labelColor=%23fff&color=%23BB443E)](https://www.npmjs.com/package/@grom.js/tgx)
-[![jsr](https://img.shields.io/jsr/v/%40grom/bot-api-spec?style=flat&logo=jsr&logoColor=%231B3646&logoSize=auto&label=%C2%A0&labelColor=%23F3E051&color=%231B3646)](https://jsr.io/@grom/tgx)
+[![npm](https://img.shields.io/npm/v/%40grom.js%2Fbot-api-spec?style=flat&logo=npm&logoColor=%23BB443E&logoSize=auto&label=%C2%A0&labelColor=%23fff&color=%23BB443E)](https://www.npmjs.com/package/@grom.js/bot-api-spec)
+[![jsr](https://img.shields.io/jsr/v/%40grom/bot-api-spec?style=flat&logo=jsr&logoColor=%231B3646&logoSize=auto&label=%C2%A0&labelColor=%23F3E051&color=%231B3646)](https://jsr.io/@grom/bot-api-spec)
 
-[Telegram Bot API](https://core.telegram.org/bots/api) specification as a collection of JavaScript objects in a [custom format](#format).
+[Telegram Bot API][bot-api] specification as a collection of JavaScript objects in a [custom format](#format).
 
 ## Motivation
 
@@ -20,10 +20,7 @@ deno add jsr:@grom/bot-api-spec
 
 ## Usage
 
-Root module exports two objects:
-
-1. `types` — definition of all Bot API types
-2. `methods` — definition of all Bot API methods
+Root module exports two objects: `types` and `methods`, containing definitions of all Bot API types and methods respectively.
 
 ```ts
 import { types, methods } from '@grom.js/bot-api-spec' // '@grom/bot-api-spec' for JSR

package/dist/format.d.ts

@@ -1,9 +1,18 @@
+/**
+ * This module exports types for representing Bot API methods and types
+ * in a structured format.
+ *
+ * @module
+ */
 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;
+/**
+ * Bot API type represented as an object with fields.
+ */
 export interface ApiTypeObject {
     /**
      * Name of the type.
@@ -19,6 +28,9 @@ export interface ApiTypeObject {
     fields: Array<FieldOrParam>;
     oneOf?: never;
 }
+/**
+ * Bot API type represented as a union of other types.
+ */
 export interface ApiTypeOneOf {
     /**
      * Name of the type.
@@ -34,6 +46,9 @@ export interface ApiTypeOneOf {
     oneOf: Array<ValueTypeApiType>;
     fields?: never;
 }
+/**
+ * Bot API method with parameters and return type.
+ */
 export interface ApiMethod {
     /**
      * Name of the method.
@@ -52,6 +67,9 @@ export interface ApiMethod {
      */
     returnType: ValueType;
 }
+/**
+ * Field of a type or parameter of a method.
+ */
 export interface FieldOrParam {
     /**
      * Name of the field/parameter.

package/dist/format.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAE3C;;;GAGG;AACH,MAAM,MAAM,OAAO,GACb,aAAa,GACb,YAAY,CAAA;AAElB,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAE3B,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;IAE9B,MAAM,CAAC,EAAE,KAAK,CAAA;CACf;AAED,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAE/B;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACf,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,cAAc,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAA;IACX,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,YAAY,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,OAAO,KAAK,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,EAAE,EAAE,SAAS,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;CACxB"}
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAE3C;;;GAGG;AACH,MAAM,MAAM,OAAO,GACb,aAAa,GACb,YAAY,CAAA;AAElB;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAE3B,KAAK,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAA;IAE9B,MAAM,CAAC,EAAE,KAAK,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;IAE/B;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,SAAS,CAAA;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IAExB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GACf,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,cAAc,GACd,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,cAAc,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,CAAA;IACX,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,YAAY,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,OAAO,KAAK,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,EAAE,EAAE,SAAS,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;CACxB"}

package/dist/format.js

@@ -1,2 +1,8 @@
+/**
+ * This module exports types for representing Bot API methods and types
+ * in a structured format.
+ *
+ * @module
+ */
 export {};
 //# sourceMappingURL=format.js.map

package/dist/format.js.map

@@ -1 +1 @@
-{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":""}
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/index.d.ts

@@ -1,3 +1,8 @@
+/**
+ * This module exports definitions of all Bot API methods and types.
+ *
+ * @module
+ */
 export { methods } from './methods.gen.ts';
 export { types } from './types.gen.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/index.js

@@ -1,3 +1,8 @@
+/**
+ * This module exports definitions of all Bot API methods and types.
+ *
+ * @module
+ */
 export { methods } from "./methods.gen.js";
 export { types } from "./types.gen.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grom.js/bot-api-spec",
   "type": "module",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "Telegram Bot API specification as a collection of JavaScript objects in a custom format.",
   "license": "MIT",
   "repository": {

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.

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'