@vkontakte/api-schema-typescript-generator 0.12.0 → 0.13.2

package/.eslintrc.json

@@ -22,6 +22,16 @@
     "@typescript-eslint/explicit-member-accessibility": "off",
     "@typescript-eslint/no-unnecessary-condition": "off",
     "@typescript-eslint/no-magic-numbers": "off",
-    "@typescript-eslint/no-extra-parens": "off"
-  }
+    "@typescript-eslint/no-extra-parens": "off",
+
+    "no-shadow": "off"
+  },
+  "overrides": [
+    {
+      "files": ["**/*.ts"],
+      "rules": {
+        "no-undef": "off"
+      }
+    }
+  ]
 }

package/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+yarn.lock  @VKCOM/vk-sec
+.yarnrc    @VKCOM/vk-sec

package/dist/constants.js

@@ -21,7 +21,7 @@ exports.scalarTypes = {
 exports.primitiveTypes = {
     ...exports.scalarTypes,
     array: 'any[]',
-    object: '{}',
+    object: '{ [key: string]: unknown }',
     mixed: 'any /* mixed primitive */',
 };
 exports.spaceChar = ' ';

package/dist/generators/APITypingsGenerator.js

@@ -37,6 +37,19 @@ class APITypingsGenerator {
         };
         this.resultFiles = {};
     }
+    needEmit;
+    outDirPath;
+    methodsPattern;
+    methodsDefinitions;
+    methodsList;
+    objects;
+    responses;
+    visitedRefs;
+    generatedObjects;
+    methodFilesMap;
+    exports;
+    ignoredResponses;
+    resultFiles;
     convertJSONSchemaDictionary(objects) {
         const dictionary = {};
         Object.keys(objects).forEach((name) => {
@@ -154,7 +167,6 @@ class APITypingsGenerator {
         let imports = {};
         let codeBlocks = [];
         const properties = this.getObjectProperties(object);
-        const requiredProperties = utils_1.arrayToMap(object.required);
         const codeBlock = new TypeCodeBlock_1.TypeCodeBlock({
             type: TypeCodeBlock_1.TypeScriptCodeTypes.Interface,
             refName: object.name,
@@ -176,7 +188,7 @@ class APITypingsGenerator {
                 name: property.name,
                 description: [property.description, description].join(constants_1.newLineChar),
                 value,
-                isRequired: helpers_1.isPatternProperty(property.name) || requiredProperties[property.name],
+                isRequired: helpers_1.isPatternProperty(property.name) || property.isRequired,
             });
         });
         return {
@@ -341,7 +353,7 @@ class APITypingsGenerator {
     }
     getResponseCodeBlockAsType(object, response) {
         const { imports, value, codeBlocks, description, } = typeString_1.generateTypeString(response, this.objects, {
-            objectParentName: ' ',
+            objectParentName: ' ', // TODO: Refactor
         });
         const codeBlock = new TypeCodeBlock_1.TypeCodeBlock({
             type: TypeCodeBlock_1.TypeScriptCodeTypes.Type,

package/dist/generators/CommentCodeBlock.js

@@ -8,6 +8,7 @@ class CommentCodeBlock extends BaseCodeBlock_1.BaseCodeBlock {
         super();
         this.lines = lines;
     }
+    lines;
     appendLines(lines) {
         this.lines = [
             ...this.lines,

package/dist/generators/SchemaObject.js

@@ -68,6 +68,20 @@ class SchemaObject {
             this.allOf = object.allOf.map((item) => new SchemaObject(name, item));
         }
     }
+    name;
+    parentObjectName;
+    type;
+    description;
+    ref;
+    required;
+    isRequired;
+    enum;
+    enumNames;
+    properties;
+    parameters;
+    items;
+    oneOf;
+    allOf;
     setName(name) {
         this.name = name;
         if (Array.isArray(this.properties)) {

package/dist/generators/TypeCodeBlock.js

@@ -26,6 +26,15 @@ class TypeCodeBlock extends BaseCodeBlock_1.BaseCodeBlock {
         this.value = options.value;
         this.needExport = options.needExport;
     }
+    options;
+    type;
+    refName;
+    interfaceName;
+    extendsInterfaces;
+    description;
+    properties;
+    value;
+    needExport;
     addProperty(property) {
         this.properties.push(property);
     }

package/dist/generators/methods.js

@@ -13,6 +13,7 @@ function normalizeMethodInfo(method) {
         // For method params "boolean" type means 1 or 0
         // Real "false" boolean value will be detected by API as true
         if (parameter.type === 'boolean') {
+            // @ts-expect-error
             delete parameter.type;
             parameter.$ref = constants_1.baseBoolIntRef;
         }

package/dist/helpers.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -58,6 +58,8 @@ function writeFile(filePath, code, insertAutoGeneratedNote = true) {
             '/**',
             ' * This is auto-generated file, don\'t modify this file manually',
             ' */',
+            // '/* eslint-disable max-len */',
+            // '/* eslint-disable @typescript-eslint/no-empty-interface */',
         ].join(constants_1.newLineChar) + constants_1.newLineChar.repeat(2) + code.trim();
     }
     fs_1.default.mkdirSync(filePath.replace(path_1.default.basename(filePath), ''), { recursive: true });
@@ -124,7 +126,7 @@ function areQuotesNeededForProperty(name) {
     if (isPatternProperty(name)) {
         return false;
     }
-    if (/[&]/.test(name)) {
+    if (/[&-]/.test(name)) {
         return true;
     }
     return !(/^[a-z_]([a-z0-9_])+$/i.test(name) || /^[a-z_]/i.test(name));

package/dist/helpers.test.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const helpers_1 = require("./helpers");
+test('areQuotesNeededForProperty', () => {
+    expect(helpers_1.areQuotesNeededForProperty('user_id')).toBe(false);
+    expect(helpers_1.areQuotesNeededForProperty('uuid4')).toBe(false);
+    expect(helpers_1.areQuotesNeededForProperty('_foo')).toBe(false);
+    expect(helpers_1.areQuotesNeededForProperty('4uuid')).toBe(true);
+    expect(helpers_1.areQuotesNeededForProperty('user-id')).toBe(true);
+    expect(helpers_1.areQuotesNeededForProperty('user&id')).toBe(true);
+    expect(helpers_1.areQuotesNeededForProperty('идентификатор')).toBe(true);
+});

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vkontakte/api-schema-typescript-generator",
-  "version": "0.12.0",
+  "version": "0.13.2",
   "license": "MIT",
   "description": "VK API TypeScript generator",
   "author": {
@@ -23,7 +23,8 @@
   ],
   "repository": "https://github.com/VKCOM/api-schema-typescript-generator",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=12.0.0",
+    "yarn": "^1.21.1"
   },
   "bin": {
     "vk-api-schema-typescript-generator": "./bin/vk-api-schema-typescript-generator.js"
@@ -32,7 +33,7 @@
     "clear": "rimraf dist/*",
     "build": "yarn clear && tsc",
     "watch": "yarn clear && tsc --watch",
-    "test": "tsc --noEmit && eslint src --ext .ts"
+    "test": "jest && tsc --noEmit && eslint src --ext .ts"
   },
   "pre-commit": [
     "test"
@@ -42,15 +43,18 @@
     "chalk": "4.1.0"
   },
   "devDependencies": {
+    "@types/jest": "^28.1.5",
     "@types/node": "^14.0.13",
-    "@typescript-eslint/eslint-plugin": "2.34.0",
-    "@typescript-eslint/parser": "2.0.0",
-    "@vkontakte/eslint-config": "2.5.0",
-    "eslint": "6.8.0",
-    "eslint-plugin-react": "7.19.0",
-    "eslint-plugin-react-hooks": "3.0.0",
+    "@typescript-eslint/eslint-plugin": "5.30.6",
+    "@typescript-eslint/parser": "5.30.6",
+    "@vkontakte/eslint-config": "3.1.0",
+    "eslint": "8.19.0",
+    "eslint-plugin-react": "7.30.1",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "jest": "28.1.3",
     "pre-commit": "1.2.2",
     "rimraf": "^3.0.2",
-    "typescript": "3.9.5"
+    "ts-jest": "^28.0.6",
+    "typescript": "4.3.5"
   }
 }

package/src/constants.ts

@@ -23,7 +23,7 @@ export const scalarTypes: Dictionary<string> = {
 export const primitiveTypes: Dictionary<string> = {
   ...scalarTypes,
   array: 'any[]',
-  object: '{}',
+  object: '{ [key: string]: unknown }',
   mixed: 'any /* mixed primitive */',
 };
 

package/src/generators/APITypingsGenerator.ts

@@ -15,7 +15,7 @@ import {
 } from '../helpers';
 import { CodeBlocksArray, GeneratorResultInterface } from './BaseCodeBlock';
 import { TypeCodeBlock, TypeScriptCodeTypes } from './TypeCodeBlock';
-import { arrayToMap, isObject, sortArrayAlphabetically, uniqueArray } from '../utils';
+import { isObject, sortArrayAlphabetically, uniqueArray } from '../utils';
 import {
   baseAPIParamsInterfaceName,
   baseBoolIntRef,
@@ -229,7 +229,6 @@ export class APITypingsGenerator {
     let codeBlocks: CodeBlocksArray = [];
 
     const properties = this.getObjectProperties(object);
-    const requiredProperties = arrayToMap(object.required);
 
     const codeBlock = new TypeCodeBlock({
       type: TypeScriptCodeTypes.Interface,
@@ -261,7 +260,7 @@ export class APITypingsGenerator {
         name: property.name,
         description: [property.description, description].join(newLineChar),
         value,
-        isRequired: isPatternProperty(property.name) || requiredProperties[property.name],
+        isRequired: isPatternProperty(property.name) || property.isRequired,
       });
     });
 

package/src/generators/methods.ts

@@ -18,6 +18,7 @@ export function normalizeMethodInfo(method: Schema.Method): NormalizeMethodInfoR
     // For method params "boolean" type means 1 or 0
     // Real "false" boolean value will be detected by API as true
     if (parameter.type === 'boolean') {
+      // @ts-expect-error
       delete parameter.type;
       parameter.$ref = baseBoolIntRef;
     }

package/src/helpers.test.ts

@@ -0,0 +1,12 @@
+import { areQuotesNeededForProperty } from './helpers';
+
+test('areQuotesNeededForProperty', () => {
+  expect(areQuotesNeededForProperty('user_id')).toBe(false);
+  expect(areQuotesNeededForProperty('uuid4')).toBe(false);
+  expect(areQuotesNeededForProperty('_foo')).toBe(false);
+
+  expect(areQuotesNeededForProperty('4uuid')).toBe(true);
+  expect(areQuotesNeededForProperty('user-id')).toBe(true);
+  expect(areQuotesNeededForProperty('user&id')).toBe(true);
+  expect(areQuotesNeededForProperty('идентификатор')).toBe(true);
+});

package/src/helpers.ts

@@ -111,9 +111,10 @@ export function areQuotesNeededForProperty(name: string | number): boolean {
     return false;
   }
 
-  if (/[&]/.test(name)) {
+  if (/[&-]/.test(name)) {
     return true;
   }
+
   return !(/^[a-z_]([a-z0-9_])+$/i.test(name) || /^[a-z_]/i.test(name));
 }