vkcom / api-schema-typescript-generator Goto Github PK

Для удобства чтения больших юнионов

// До
export declare type Foobar = 'foo' | 'bar'

// После
export declare type Foobar =
  | 'foo'
  | 'bar'

Если бекенд принимает список через запятую, то есть массив строк. То генерируется тип который указывает что нужно прокидывать строку. Хотелось бы иметь хоть какую-ту подсказку через комментарии, что туда не просто строка прокидывается, а список через запятую или можно алиас.

/** Список элементов через запятую */
type ArrayAsString = string

Сейчас типы в функцию вызова апи можно передавать только через дженерики. Хотелось бы иметь мапу с

method_name => method_request_params, (method_response1 | method_response2)

Зачем это нужно? Чтобы лучше контролировать строгость вызовов апи функций, если сделать дженерики обязательными, то люди смогут по ошибке передавать туда неверные параметры респонса, тем самым смысл типизации теряется. С мапой у тебя нет возможности ошибиться

Generate tuple from minItems and maxItems:

minItems:

"propertyName": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "minItems": 2
}

propertyName: [string, string, ...string[]];

maxItems:

"propertyName": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "maxItems": 4
}

propertyName: [string, string, string, string];

Schema:

{
  "some_response": {
    "type": "object",
    "properties": {
      "response": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "integer"
          },
          "payload": {
            "type": "object"
          }
        },
        "required": [
          "user_id",
          "payload"
        ]
      }
    },
    "required": [
      "response"
    ]
  }
}

Current output:

export interface SomeResponse {
  user_id: number;
  payload: {};
}

Desired output:

export interface SomeResponse {
  user_id: number;
  payload: {
    [k: string]: unknown;
  };
}

В #41 предлагалось генерировать константы для ошибок.

Кажется более эффективным способом именования было бы использование кода ошибки в имени.

// было
export const API_ERROR_ACCESS = 15
// стало
export const API_ERROR_15_ACCESS = 15

У этого 2 бенефита:

1. из имени ошибки было легко понятен и ее код и ее назначение
2. иногда ты знаешь код ошибки, но не знаешь ее название (например увидел ошибку в девтулзах) в таком случае в новом именовании можно удобно воспользоваться автокомплитом, набрав API_ERROR_15_, без необходимости лазить по исходникам библиотеки

Кроме того, раз уж мы делаем брейкинг чейндж, можно сократить префикс до API_ERR_, чтобы уменьшить длину констант.

enum'ы по ссылке, которые используются больше одного раза, всё-таки генерировать как отдельный union-тип, а не дублировать в каждом месте. Например, WallWallpostAttachmentType.