@grom.js/bot-api-spec 0.1.0 → 0.3.0

package/README.md

@@ -1,7 +1,5 @@
 [Telegram Bot API](https://core.telegram.org/bots/api) specification as a collection of JavaScript objects in a [custom format](#format).
 
-> ⚠️ Work in progress.
-
 ## Motivation
 
 Automatically generate tools, libraries, MCP servers, custom documentations, etc.
@@ -25,17 +23,16 @@ We define custom value types to represent types of the fields and parameters, to
 
 Below are the rules how we map type of a field/parameter to the `ValueType`:
 
-- _Type_ is _String_ — `{ kind: 'str' }`
-- _Type_ is _Integer_ — `{ kind: 'int32' }`
-- _Type_ is _Integer_ and _Description_ says "...may have more than 32 significant bits...but it has at most 52 significant bits..." — `{ kind: 'int52' }`
-- _Type_ is _Boolean_ — `{ kind: 'bool' }`
-- _Type_ is _True_ — `{ kind: 'bool', literal: true }`
-- _Type_ is _Float_ — `{ kind: 'float' }`
-- _Description_ says "always X" — `{ kind: ..., literal: X }`
-- _Type_ is _InputFile_ — `{ kind: 'input-file' }`
-- _Type_ is _X_, where X is any API type — `{ kind: 'api-type', name: X }`
-- _Type_ is _Array of X_ — `{ kind: 'array', of: X }`
-- _Type_ is _X or Y or ..._ — `{ kind: 'union', types: [X, Y, ...] }`
+- _Type_ is _String_ — `{ type: 'str' }`
+- _Type_ is _Integer_ — `{ type: 'int32' }`
+- _Type_ is _Integer_ and _Description_ says "...may have more than 32 significant bits...but it has at most 52 significant bits..." — `{ type: 'int52' }`
+- _Type_ is _Boolean_ — `{ type: 'bool' }`
+- _Type_ is _True_ — `{ type: 'bool', literal: true }`
+- _Type_ is _Float_ — `{ type: 'float' }`
+- _Type_ is _InputFile_ — `{ type: 'input-file' }`
+- _Type_ is _X_, where X is any API type — `{ type: 'api-type', name: X }`
+- _Type_ is _Array of X_ — `{ type: 'array', of: X }`
+- _Type_ is _X or Y or ..._ — `{ type: 'union', types: [X, Y, ...] }`
 
 ### Descriptions
 
@@ -44,4 +41,4 @@ Objects also include descriptions of the API types, methods, fields, and paramet
 - Description is an object with a single `markdown` property, a string containing the description in Markdown format with formatting (**bold**, _italic_, etc.) and links preserved.
 - "_Optional._" prefix in field descriptions is omitted; instead, the `required` property is set to `false` for such fields.
 - "JSON-serialized..." in field/parameter descriptions is omitted; instead, the `jsonSerialized` property is set to `true` for such fields/parameters.
-- "...may have more than 32 significant bits...but it has at most 52 significant bits..." in _Integer_ field/parameter descriptions is omitted; instead, `kind` is set to `int52` for such fields/parameters.
+- "...may have more than 32 significant bits...but it has at most 52 significant bits..." in _Integer_ field/parameter descriptions is omitted; instead, `type` is set to `int52` for such fields/parameters.

package/dist/index.d.ts

@@ -17,6 +17,7 @@ interface ApiTypeObject {
    * Fields of the object representing this type.
    */
   fields: Array<FieldOrParam>;
+  oneOf?: never;
 }
 interface ApiTypeOneOf {
   /**
@@ -31,6 +32,7 @@ interface ApiTypeOneOf {
    * Array of possible types this type can be.
    */
   oneOf: Array<ValueTypeApiType>;
+  fields?: never;
 }
 interface ApiMethod {
   /**
@@ -86,21 +88,21 @@ type ValueType = ValueTypeString | ValueTypeBoolean | ValueTypeInteger32 | Value
  * `String` value type.
  */
 interface ValueTypeString {
-  kind: 'str';
+  type: 'str';
   literal?: string;
 }
 /**
  * `Boolean` value type.
  */
 interface ValueTypeBoolean {
-  kind: 'bool';
+  type: 'bool';
   literal?: boolean;
 }
 /**
  * `Integer` value type, which fits in a 32-bit integer.
  */
 interface ValueTypeInteger32 {
-  kind: 'int32';
+  type: 'int32';
   literal?: number;
 }
 /**
@@ -109,39 +111,39 @@ interface ValueTypeInteger32 {
  * type are safe for storing values of this type.
  */
 interface ValueTypeInteger52 {
-  kind: 'int52';
+  type: 'int52';
 }
 /**
  * `Float` value type.
  */
 interface ValueTypeFloat {
-  kind: 'float';
+  type: 'float';
 }
 /**
  * [`InputFile`](https://core.telegram.org/bots/api#inputfile) value type.
  */
 interface ValueTypeInputFile {
-  kind: 'input-file';
+  type: 'input-file';
 }
 /**
  * Any {@link ApiType} value type.
  */
 interface ValueTypeApiType {
-  kind: 'api-type';
+  type: 'api-type';
   name: keyof typeof types;
 }
 /**
  * Array of any value type.
  */
 interface ValueTypeArray {
-  kind: 'array';
+  type: 'array';
   of: ValueType;
 }
 /**
  * Union of any value types.
  */
 interface ValueTypeUnion {
-  kind: 'union';
+  type: 'union';
   types: Array<ValueType>;
 }
 //#endregion