@vkontakte/api-schema-typescript-generator 0.16.0 → 0.17.0

package/dist/objects/video/VideoVideoAlbumFull.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/video/VideoVideoFiles.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/video/VideoVideoFull.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/video/VideoVideoImage.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallAppPost.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallAttachedNote.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallCommentAttachment.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallCommentAttachmentType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallGeo.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallGetFilter.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallGraffiti.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallPostCopyright.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallPostSource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallPostSourceType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallPostType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallPostedPhoto.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallViews.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallComment.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallCommentDonut.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallCommentDonutPlaceholder.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostAttachment.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostAttachmentType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostCommentsDonut.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostCommentsDonutPlaceholder.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostDonut.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostDonutPlaceholder.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/wall/WallWallpostFull.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WallWallpostFullTopicIdEnumNames = void 0;
+// wall_wallpost_full topic_id enumNames
+exports.WallWallpostFullTopicIdEnumNames = {
+    EMPTY_TOPIC: 0,
+    ART: 1,
+    IT: 7,
+    GAMES: 12,
+    MUSIC: 16,
+    PHOTO: 19,
+    SCIENCE_AND_TECH: 21,
+    SPORT: 23,
+    TRAVEL: 25,
+    TV_AND_CINEMA: 26,
+    HUMOR: 32,
+    FASHION: 43,
+};

package/dist/objects/widgets/WidgetsCommentMedia.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/widgets/WidgetsCommentMediaType.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/widgets/WidgetsCommentReplies.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/widgets/WidgetsCommentRepliesItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/widgets/WidgetsWidgetComment.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/widgets/WidgetsWidgetLikes.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/objects/widgets/WidgetsWidgetPage.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This is auto-generated file, don't modify this file manually
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.js

@@ -1,6 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trimArray = exports.quoteJavaScriptValue = exports.trimStringDoubleSpaces = exports.arrayToMap = exports.sortArrayAlphabetically = exports.uniqueArray = exports.capitalizeFirstLetter = exports.isObject = exports.isString = exports.flatten = void 0;
+exports.flatten = flatten;
+exports.isString = isString;
+exports.isObject = isObject;
+exports.capitalizeFirstLetter = capitalizeFirstLetter;
+exports.uniqueArray = uniqueArray;
+exports.sortArrayAlphabetically = sortArrayAlphabetically;
+exports.arrayToMap = arrayToMap;
+exports.trimStringDoubleSpaces = trimStringDoubleSpaces;
+exports.quoteJavaScriptValue = quoteJavaScriptValue;
+exports.trimArray = trimArray;
 function flatten(input) {
     const stack = [...input];
     const result = [];
@@ -17,27 +26,21 @@ function flatten(input) {
     }
     return result.reverse();
 }
-exports.flatten = flatten;
 function isString(object) {
     return typeof object === 'string';
 }
-exports.isString = isString;
 function isObject(object) {
     return Object.prototype.toString.call(object) === '[object Object]';
 }
-exports.isObject = isObject;
 function capitalizeFirstLetter(string) {
     return string.charAt(0).toUpperCase() + string.slice(1);
 }
-exports.capitalizeFirstLetter = capitalizeFirstLetter;
 function uniqueArray(array) {
     return array.filter((v, i, a) => a.indexOf(v) === i);
 }
-exports.uniqueArray = uniqueArray;
 function sortArrayAlphabetically(array) {
     return array.sort((a, b) => a.localeCompare(b));
 }
-exports.sortArrayAlphabetically = sortArrayAlphabetically;
 function arrayToMap(array) {
     if (!array) {
         return {};
@@ -47,15 +50,12 @@ function arrayToMap(array) {
         return acc;
     }, {});
 }
-exports.arrayToMap = arrayToMap;
 function trimStringDoubleSpaces(string) {
     return string.trim().replace(/\s\s+/g, ' ');
 }
-exports.trimStringDoubleSpaces = trimStringDoubleSpaces;
 function quoteJavaScriptValue(value) {
     return isString(value) ? `'${value}'` : value;
 }
-exports.quoteJavaScriptValue = quoteJavaScriptValue;
 /**
  * Removes empty string array elements from start and end of array, trim array elements and returns the new array
  *
@@ -71,4 +71,3 @@ function trimArray(array) {
     }
     return trimmedArray;
 }
-exports.trimArray = trimArray;

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@vkontakte/api-schema-typescript-generator",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "license": "MIT",
   "description": "VK API TypeScript generator",
   "author": {
     "name": "VK",
     "url": "https://vk.com"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "keywords": [
     "VK",
     "VK API",
@@ -46,13 +49,13 @@
   },
   "devDependencies": {
     "@types/jest": "^28.1.5",
-    "@types/node": "^18.17.3",
-    "@typescript-eslint/eslint-plugin": "5.30.6",
+    "@types/node": "^22.0.0",
+    "@typescript-eslint/eslint-plugin": "5.62.0",
     "@typescript-eslint/parser": "5.62.0",
     "@vkontakte/eslint-config": "3.1.0",
-    "eslint": "8.19.0",
-    "eslint-plugin-react": "7.33.1",
-    "eslint-plugin-react-hooks": "4.6.0",
+    "eslint": "8.57.1",
+    "eslint-plugin-react": "7.37.5",
+    "eslint-plugin-react-hooks": "5.0.0",
     "jest": "28.1.3",
     "pre-commit": "1.2.2",
     "rimraf": "^3.0.2",

package/src/generators/APITypingsGenerator.ts

@@ -382,14 +382,14 @@ export class APITypingsGenerator {
 
   private generateMethodParams(methodInfo: SchemaObject) {
     const section = getMethodSection(methodInfo.name);
-    const interfaceName = `${methodInfo.name} params`;
+    const interfaceName = getInterfaceName(`${methodInfo.name} params`);
 
     let imports: RefsDictionary = {};
     let codeBlocks: CodeBlocksArray = [];
 
     const codeBlock = new TypeCodeBlock({
       type: TypeScriptCodeTypes.Interface,
-      interfaceName: getInterfaceName(interfaceName),
+      interfaceName: interfaceName,
       needExport: true,
       allowEmptyInterface: true,
       properties: [],
@@ -417,6 +417,8 @@ export class APITypingsGenerator {
 
     this.appendToFileMap(section, imports, [...codeBlocks, codeBlock]);
     this.generateObjectsFromImports(imports);
+
+    return interfaceName;
   }
 
   private getResponseObjectRef(ref: string): SchemaObject | undefined {
@@ -543,7 +545,7 @@ export class APITypingsGenerator {
   public generateResponse(section: string, response: SchemaObject) {
     const result = this.getResponseCodeBlock(response);
     if (!result) {
-      return;
+      throw new Error('Unable to generate response');
     }
 
     const { codeBlocks, imports } = result;
@@ -578,16 +580,67 @@ export class APITypingsGenerator {
     method = normalizedMethod;
     this.generateObjectsFromRefs(parameterRefs);
 
-    this.generateMethodParams(new SchemaObject(method.name, method));
+    const methodParamsInterfaceName = this.generateMethodParams(
+      new SchemaObject(method.name, method),
+    );
 
-    Object.entries(method.responses).forEach(([responseName, responseObject]) => {
-      if (this.ignoredResponses[methodName] && this.ignoredResponses[methodName][responseName]) {
-        return;
-      }
+    const methodResponsesInterfaceName = Object.entries(method.responses)
+      .map(([responseName, responseObject]) => {
+        if (this.ignoredResponses[methodName] && this.ignoredResponses[methodName][responseName]) {
+          return;
+        }
+
+        const name = `${methodName}_${responseName}`;
+        const interfaceName = getInterfaceName(name);
+        try {
+          this.generateResponse(section, new SchemaObject(name, responseObject));
+          return interfaceName;
+        } catch (e) {
+          return;
+        }
+      })
+      .filter(Boolean) as string[];
+
+    this.generateMethodType(methodName, methodParamsInterfaceName, methodResponsesInterfaceName);
+  }
+
+  private generateMethodType(
+    methodName: string,
+    methodParamsInterfaceName: string,
+    methodResponsesInterfaceName: string[],
+  ) {
+    const codeBlock = new TypeCodeBlock({
+      type: TypeScriptCodeTypes.Interface,
+      interfaceName: getInterfaceName(`${methodName} method`),
+      needExport: true,
+      allowEmptyInterface: true,
+      properties: [],
+    });
+
+    codeBlock.addProperty({
+      name: 'method',
+      value: methodName,
+      isRequired: true,
+      wrapValue: true,
+    });
 
-      const name = `${methodName}_${responseName}`;
-      this.generateResponse(section, new SchemaObject(name, responseObject));
+    codeBlock.addProperty({
+      name: 'request',
+      value: methodParamsInterfaceName,
+      isRequired: true,
     });
+
+    codeBlock.addProperty({
+      name: 'response',
+      value:
+        methodResponsesInterfaceName.length > 0
+          ? methodResponsesInterfaceName.join(' | ')
+          : 'unknown',
+      isRequired: true,
+    });
+
+    const section = getMethodSection(methodName);
+    this.appendToFileMap(section, {}, [codeBlock]);
   }
 
   private generateMethods() {
@@ -601,11 +654,38 @@ export class APITypingsGenerator {
 
     Object.keys(this.methodFilesMap).forEach((section) => {
       const { imports, codeBlocks } = this.methodFilesMap[section];
+      const methodNames: string[] = [];
       codeBlocks.forEach((codeBlock) => {
         if (codeBlock instanceof TypeCodeBlock && codeBlock.needExport && codeBlock.interfaceName) {
+          /**
+           * for interfaceName structure
+           * @see this.generateMethodType
+           */
+          if (codeBlock.interfaceName.endsWith('Method')) {
+            methodNames.push(codeBlock.interfaceName);
+            // Skip export as it will be exported in union type
+            return;
+          }
+
           this.registerExport(`./methods/${section}`, codeBlock.interfaceName);
         }
       });
+
+      if (methodNames.length > 0) {
+        const sectionMethodsCodeBlock = new TypeCodeBlock({
+          type: TypeScriptCodeTypes.Type,
+          interfaceName: getInterfaceName(`${section} methods union`),
+          needExport: true,
+          allowEmptyInterface: true,
+          value: methodNames.join(' | '),
+          properties: [],
+        });
+
+        codeBlocks.push(sectionMethodsCodeBlock);
+
+        this.registerExport(`./methods/${section}`, sectionMethodsCodeBlock.interfaceName);
+      }
+
       const code = [generateImportsBlock(imports, null), ...codeBlocks];
 
       this.registerResultFile(
@@ -685,8 +765,23 @@ export class APITypingsGenerator {
       }).toString(),
     );
 
+    code.push(`
+type MethodOf<M> = M extends { method: string } ? M['method'] : never;
+type RequestOf<M> = M extends { request: unknown } ? M['request'] : never;
+type ResponseOf<M> = M extends { response: unknown } ? M['response'] : never;
+
+export type CreateMethodMap<Type extends { method: string }> = {
+  [Property in Type as Property['method']]: {
+    method: MethodOf<Property>;
+    request: RequestOf<Property>;
+    response: ResponseOf<Property>;
+  };
+};
+    `);
+
     this.registerExport('./common/common', 'API_VERSION');
     this.registerExport('./common/common', getInterfaceName(baseAPIParamsInterfaceName));
+    this.registerExport('./common/common', 'CreateMethodMap');
     this.registerResultFile(path.join('common', 'common.ts'), code.join(newLineChar.repeat(2)));
   }
 
@@ -698,6 +793,60 @@ export class APITypingsGenerator {
 
     const blocks: string[] = [];
     let exportedObjects: Dictionary<boolean> = {};
+    let methodNames = new Set<string>();
+
+    sortArrayAlphabetically(Object.keys(this.exports)).forEach((path) => {
+      if (!path.startsWith('./methods/')) {
+        return;
+      }
+
+      const objects = Object.keys(this.exports[path]);
+      if (!objects.length) {
+        return;
+      }
+
+      const blockLines: string[] = [];
+
+      sortArrayAlphabetically(objects).forEach((object) => {
+        /**
+         * for interfaceName structure
+         * @see this.generateMethods
+         */
+        if (!methodNames.has(object) && /^[A-Z][a-zA-Z0-9]*MethodsUnion$/.test(object)) {
+          methodNames.add(object);
+          exportedObjects[object] = true; // To skip in export block
+          blockLines.push(`  ${object},`);
+        }
+      });
+
+      if (blockLines.length > 0) {
+        blockLines.unshift('import type {');
+        blockLines.push(`} from '${path.replace('.ts', '')}';`);
+
+        blocks.push(blockLines.join(newLineChar));
+      }
+    });
+
+    blocks.push("import type { CreateMethodMap } from './common/common';");
+
+    const methodsCodeBlock = new TypeCodeBlock({
+      type: TypeScriptCodeTypes.Type,
+      interfaceName: 'ApiMethodsUnion',
+      needExport: false,
+      properties: [],
+      value: Array.from(methodNames).join(' | '),
+    });
+    blocks.push(methodsCodeBlock.toString());
+
+    blocks.push(
+      new TypeCodeBlock({
+        type: TypeScriptCodeTypes.Type,
+        interfaceName: 'ApiMethodsMap',
+        needExport: true,
+        properties: [],
+        value: `CreateMethodMap<${methodsCodeBlock.interfaceName}>`,
+      }).toString(),
+    );
 
     sortArrayAlphabetically(Object.keys(this.exports)).forEach((path) => {
       const objects = Object.keys(this.exports[path]);