@buildvision/nest-sdk-generator 2.3.0 → 3.0.0

package/build/utils.js

@@ -1,8 +1,42 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFilesRecursive = exports.findFileAbove = void 0;
-const fs = require("fs");
-const path = require("path");
+exports.findFileAbove = findFileAbove;
+exports.findFilesRecursive = findFilesRecursive;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
 function findFileAbove(pattern, dir) {
     if (!path.isAbsolute(dir)) {
         // Get an absolute path to allow getting its parent using path.dirname()
@@ -27,7 +61,6 @@ function findFileAbove(pattern, dir) {
     // Success!
     return path.resolve(dir, items[0]);
 }
-exports.findFileAbove = findFileAbove;
 /**
  * Find all files matching a pattern, recursively
  * @param pattern The pattern to look for
@@ -52,5 +85,4 @@ function findFilesRecursive(pattern, dir, relative = true) {
     }
     return find(pattern, dir, dir);
 }
-exports.findFilesRecursive = findFilesRecursive;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEseUJBQXdCO0FBQ3hCLDZCQUE0QjtBQUU1QixTQUFnQixhQUFhLENBQUMsT0FBd0IsRUFBRSxHQUFXO0lBQ2pFLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7UUFDMUIsd0VBQXdFO1FBQ3hFLEdBQUcsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBRSxHQUFHLENBQUMsQ0FBQTtJQUN4QyxDQUFDO0lBRUQseUJBQXlCO0lBQ3pCLHVGQUF1RjtJQUN2Riw4QkFBOEI7SUFDOUIsNEdBQTRHO0lBQzVHLElBQUksT0FBTyxHQUFHLEdBQUcsQ0FBQTtJQUVqQixJQUFJLEtBQUssR0FBRyxFQUFFLENBQUE7SUFFZCx3Q0FBd0M7SUFDeEMsT0FBTyxDQUFDLEtBQUssR0FBRyxFQUFFLENBQUMsV0FBVyxDQUFDLEdBQUcsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQyxPQUFPLFlBQVksTUFBTSxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxPQUFPLEtBQUssSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDLE1BQU0sS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN4SSxtQ0FBbUM7UUFDbkMsR0FBRyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUE7UUFFdkIseUZBQXlGO1FBQ3pGLElBQUksQ0FBQyxHQUFHLElBQUksT0FBTyxLQUFLLEdBQUcsRUFBRSxDQUFDO1lBQzVCLE9BQU8sSUFBSSxDQUFBO1FBQ2IsQ0FBQztRQUVELE9BQU8sR0FBRyxHQUFHLENBQUE7SUFDZixDQUFDO0lBRUQsV0FBVztJQUNYLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUE7QUFDcEMsQ0FBQztBQTdCRCxzQ0E2QkM7QUFFRDs7Ozs7O0dBTUc7QUFDSCxTQUFnQixrQkFBa0IsQ0FBQyxPQUF3QixFQUFFLEdBQVcsRUFBRSxRQUFRLEdBQUcsSUFBSTtJQUN2RixNQUFNLEdBQUcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUE7SUFFekIsU0FBUyxJQUFJLENBQUMsT0FBd0IsRUFBRSxPQUFlLEVBQUUsT0FBZTtRQUN0RSxPQUFPLEVBQUU7YUFDTixXQUFXLENBQUMsT0FBTyxDQUFDO2FBQ3BCLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxFQUFFO1lBQ1osTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLENBQUE7WUFFNUMsT0FBTyxFQUFFLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxDQUFDLFdBQVcsRUFBRTtnQkFDekMsQ0FBQyxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsT0FBTyxFQUFFLFFBQVEsQ0FBQztnQkFDbEMsQ0FBQyxDQUFDLENBQUMsT0FBTyxPQUFPLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO29CQUNyRSxDQUFDLENBQUMsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsT0FBTyxFQUFFLFFBQVEsQ0FBQyxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxPQUFPLEVBQUUsSUFBSSxDQUFDLENBQUM7b0JBQ2xGLENBQUMsQ0FBQyxFQUFFLENBQUE7UUFDVixDQUFDLENBQUM7YUFDRCxJQUFJLEVBQUUsQ0FBQTtJQUNYLENBQUM7SUFFRCxPQUFPLElBQUksQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFBO0FBQ2hDLENBQUM7QUFuQkQsZ0RBbUJDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvdXRpbHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLE1BQVksRUFBRSwrQkFBVTtBQUN4QixNQUFZLElBQUksaUNBQVk7QUFFNUIsdUJBQThCLE9BQXdCLEVBQUUsR0FBVztJQUNqRSxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDO1FBQzFCLHdFQUF3RTtRQUN4RSxHQUFHLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUUsR0FBRyxDQUFDLENBQUE7SUFDeEMsQ0FBQztJQUVELHlCQUF5QjtJQUN6Qix1RkFBdUY7SUFDdkYsOEJBQThCO0lBQzlCLDRHQUE0RztJQUM1RyxJQUFJLE9BQU8sR0FBRyxHQUFHLENBQUE7SUFFakIsSUFBSSxLQUFLLEdBQUcsRUFBRSxDQUFBO0lBRWQsd0NBQXdDO0lBQ3hDLE9BQU8sQ0FBQyxLQUFLLEdBQUcsRUFBRSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRSxDQUFDLENBQUMsT0FBTyxZQUFZLE1BQU0sQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxLQUFLLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7UUFDeEksbUNBQW1DO1FBQ25DLEdBQUcsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFBO1FBRXZCLHlGQUF5RjtRQUN6RixJQUFJLENBQUMsR0FBRyxJQUFJLE9BQU8sS0FBSyxHQUFHLEVBQUUsQ0FBQztZQUM1QixPQUFPLElBQUksQ0FBQTtRQUNiLENBQUM7UUFFRCxPQUFPLEdBQUcsR0FBRyxDQUFBO0lBQ2YsQ0FBQztJQUVELFdBQVc7SUFDWCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFBO0FBQ3BDLENBQUM7QUFFRDs7Ozs7O0dBTUc7QUFDSCw0QkFBbUMsT0FBd0IsRUFBRSxHQUFXLEVBQUUsUUFBUSxHQUFHLElBQUk7SUFDdkYsTUFBTSxHQUFHLEdBQUcsT0FBTyxDQUFDLEdBQUcsRUFBRSxDQUFBO0lBRXpCLFNBQVMsSUFBSSxDQUFDLE9BQXdCLEVBQUUsT0FBZSxFQUFFLE9BQWU7UUFDdEUsT0FBTyxFQUFFO2FBQ04sV0FBVyxDQUFDLE9BQU8sQ0FBQzthQUNwQixHQUFHLENBQUMsQ0FBQyxJQUFJLEVBQUUsRUFBRTtZQUNaLE1BQU0sUUFBUSxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLElBQUksQ0FBQyxDQUFBO1lBRTVDLE9BQU8sRUFBRSxDQUFDLFNBQVMsQ0FBQyxRQUFRLENBQUMsQ0FBQyxXQUFXLEVBQUU7Z0JBQ3pDLENBQUMsQ0FBQyxJQUFJLENBQUMsT0FBTyxFQUFFLE9BQU8sRUFBRSxRQUFRLENBQUM7Z0JBQ2xDLENBQUMsQ0FBQyxDQUFDLE9BQU8sT0FBTyxLQUFLLFFBQVEsQ0FBQyxDQUFDLENBQUMsSUFBSSxLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztvQkFDckUsQ0FBQyxDQUFDLENBQUMsUUFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLE9BQU8sRUFBRSxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsT0FBTyxFQUFFLElBQUksQ0FBQyxDQUFDO29CQUNsRixDQUFDLENBQUMsRUFBRSxDQUFBO1FBQ1YsQ0FBQyxDQUFDO2FBQ0QsSUFBSSxFQUFFLENBQUE7SUFDWCxDQUFDO0lBRUQsT0FBTyxJQUFJLENBQUMsT0FBTyxFQUFFLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQTtBQUNoQyxDQUFDIn0=

package/package.json

@@ -1,36 +1,51 @@
 {
   "name": "@buildvision/nest-sdk-generator",
   "author": "BuildVision <christophe@buildvision.io>",
-  "version": "2.3.0",
-  "description": "A full-powered SDK generator for NestJS",
+  "version": "3.0.0",
+  "description": "Generate fully-typed RTK Query API clients from NestJS controllers",
   "keywords": [
     "nest",
     "nestjs",
+    "rtk-query",
+    "redux-toolkit",
+    "redux",
+    "react",
+    "api-client",
     "sdk",
     "generator",
-    "typescript",
-    "frontend",
-    "api"
+    "typescript"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/build-vision/nest-sdk-generator.git"
+  },
+  "homepage": "https://github.com/build-vision/nest-sdk-generator#readme",
+  "bugs": {
+    "url": "https://github.com/build-vision/nest-sdk-generator/issues"
+  },
   "main": "build/bin.js",
   "scripts": {
     "prepare": "npm run build",
-    "build": "tsc -p tsconfig.json --outDir build",
+    "build": "rm -rf build && node node_modules/typescript/bin/tsc -p tsconfig.json --outDir build",
+    "build:baseline": "./scripts/build-baseline.sh",
     "start": "npm run build && node build/bin.js",
-    "typecheck": "bun tsc --project tsconfig.json --noEmit",
-    "lint": "bun eslint --quiet . --fix"
+    "test": "npm run build && node --test 'test/*.test.mjs'",
+    "typecheck": "node node_modules/typescript/bin/tsc --project tsconfig.json --noEmit",
+    "lint": "node --require ./scripts/eslint-with-typescript-6.cjs node_modules/eslint/bin/eslint.js --quiet . --fix"
   },
   "bin": "build/bin.js",
   "dependencies": {
     "chalk": "~4.1.2",
     "minimist": "~1.2.7",
     "prettier": "^3.2.5",
-    "ts-morph": "~16.0.0"
+    "ts-morph": "~16.0.0",
+    "typescript": "7.0.2"
   },
   "devDependencies": {
+    "@reduxjs/toolkit": "^2.13.0",
     "@types/minimist": "^1.2.2",
     "@types/node": "~18.11.9",
-    "typescript": "^5.2.2",
+    "@types/react": "^19.3.0",
     "@typescript-eslint/eslint-plugin": "^6.13.2",
     "@typescript-eslint/parser": "^6.13.2",
     "eslint": "^8.50.0",
@@ -40,6 +55,9 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-sort-destructure-keys": "^1.5.0",
-    "eslint-plugin-typescript-sort-keys": "^3.1.0"
+    "eslint-plugin-typescript-sort-keys": "^3.1.0",
+    "react": "^19.3.0",
+    "react-redux": "^9.3.0",
+    "typescript-6": "npm:typescript@6.0.3"
   }
 }

package/src/analyzer/controller.ts

@@ -8,38 +8,10 @@ import { Node, Project } from 'ts-morph'
 
 import { debug, warn } from '../logging'
 
-import { analyzeMethods, SdkMethod } from './methods'
+import { analyzeMethods } from './methods'
+import { camelcase, SdkController } from './sdk'
 
-/**
- * Convert a string to camel case
- * @param str
- */
-function camelcase(str: string): string {
-  return str
-    .split(/[^a-zA-Z0-9_]/g)
-    .map((p, i) => {
-      const f = p.substr(0, 1)
-      return (i === 0 ? f.toLocaleLowerCase() : f.toLocaleUpperCase()) + p.substr(1)
-    })
-    .join('')
-}
-
-/**
- * SDK interface of a controller
- */
-export interface SdkController {
-  /** Name of the controller's class, camel cased */
-  readonly className: string
-
-  /** Controller's methods */
-  readonly methods: SdkMethod[]
-
-  /** Original controller file's path */
-  readonly path: string
-
-  /** Name the controller is registered under */
-  readonly registrationName: string
-}
+export { SdkController }
 
 /**
  * Generate a SDK interface for a controller

package/src/analyzer/controllers.ts

@@ -10,10 +10,11 @@ import { Project } from 'ts-morph'
 import { debug, format, panic, warn } from '../logging'
 import { findFileAbove } from '../utils'
 
-import { analyzeController, SdkController } from './controller'
+import { analyzeController } from './controller'
 import { getModuleName } from './module'
+import { SdkController, SdkModules } from './sdk'
 
-export type SdkModules = Map<string, Map<string, SdkController>>
+export { SdkModules }
 
 export function analyzeControllers(controllers: string[], absoluteSrcPath: string, project: Project): SdkModules {
   /** Hierarchised SDK informations */

package/src/analyzer/extractor.ts

@@ -10,45 +10,27 @@ import { MagicType } from '../config'
 import { debug, format, panic, unreachable, warn } from '../logging'
 
 import { analyzeClassDeps } from './classdeps'
-import { SdkModules } from './controllers'
-import { getParamResolvedTypes } from './params'
+import {
+  ExtractedType,
+  flattenSdkResolvedTypes,
+  locateTypesFile,
+  MODULE_EXTENSIONS,
+  TypeLocation,
+  TypeLocationWithExt,
+  TypesExtractorContent,
+} from './sdk'
 import { getImportResolvedType, ResolvedTypeDeps, resolveTypeDependencies } from './typedeps'
 
-/** Valid extensions for TypeScript module files */
-export const MODULE_EXTENSIONS = ['.ts', '.d.ts', '.tsx', '.d.tsx', '.js', '.jsx']
-
-/**
- * Location of an imported type
- */
-export interface TypeLocation {
-  readonly relativePathNoExt: string
-  readonly typename: string
+export {
+  ExtractedType,
+  flattenSdkResolvedTypes,
+  locateTypesFile,
+  MODULE_EXTENSIONS,
+  TypeLocation,
+  TypeLocationWithExt,
+  TypesExtractorContent,
 }
 
-/**
- * Location of an imported type after figuring out its extension
- */
-export interface TypeLocationWithExt extends TypeLocation {
-  readonly relativePath: string
-}
-
-/**
- * Extracted imported type
- */
-export interface ExtractedType extends TypeLocationWithExt {
-  /** Type's declaration */
-  readonly content: string
-
-  /** Types this one depends on */
-  readonly dependencies: TypeLocationWithExt[]
-
-  /** Type parameters (e.g. <T>) */
-  readonly typeParams: string[]
-}
-
-// Maps files to records mapping themselves type names to their declaration code
-export type TypesExtractorContent = Map<string, Map<string, ExtractedType>>
-
 /**
  * Types extractor
  */
@@ -427,54 +409,3 @@ export class TypesExtractor {
     return extracted
   }
 }
-
-/**
- * Locate the files containing a list of a resolved types
- * @param resolvedTypes
- * @returns
- */
-export function locateTypesFile(resolvedTypes: Array<ResolvedTypeDeps>): TypeLocation[] {
-  const out = new Array<TypeLocation>()
-
-  for (const resolved of resolvedTypes) {
-    for (const [file, types] of resolved.dependencies) {
-      for (const typename of types) {
-        if (!out.find((loc) => loc.typename === typename && loc.relativePathNoExt === file)) {
-          out.push({ typename, relativePathNoExt: file })
-        }
-      }
-    }
-
-    for (const typename of resolved.localTypes) {
-      if (!out.find((loc) => loc.typename === typename && loc.relativePathNoExt === resolved.relativeFilePath)) {
-        out.push({ typename, relativePathNoExt: resolved.relativeFilePath })
-      }
-    }
-  }
-
-  return out
-}
-
-/**
- * Flatten a tree of resolved type dependencies
- * @param sdkModules
- * @returns
- */
-export function flattenSdkResolvedTypes(sdkModules: SdkModules): ResolvedTypeDeps[] {
-  const flattened = new Array<ResolvedTypeDeps>()
-
-  for (const module of sdkModules.values()) {
-    for (const controller of module.values()) {
-      for (const method of controller.methods.values()) {
-        const { bodyParams, queryParams, routeParams } = method.params
-
-        flattened.push(method.returnType)
-        flattened.push(...getParamResolvedTypes(routeParams))
-        flattened.push(...getParamResolvedTypes(queryParams))
-        flattened.push(...getParamResolvedTypes(bodyParams))
-      }
-    }
-  }
-
-  return flattened
-}

package/src/analyzer/index.ts

@@ -11,13 +11,11 @@ import { Config } from '../config'
 import { debug, panic } from '../logging'
 
 import { builtinMagicTypes } from './builtin'
-import { analyzeControllers, SdkModules } from './controllers'
-import { flattenSdkResolvedTypes, locateTypesFile, TypesExtractor, TypesExtractorContent } from './extractor'
+import { analyzeControllers } from './controllers'
+import { TypesExtractor } from './extractor'
+import { flattenSdkResolvedTypes, locateTypesFile, SdkContent, serializeSdkContent } from './sdk'
 
-export interface SdkContent {
-  readonly modules: SdkModules
-  readonly types: TypesExtractorContent
-}
+export { SdkContent }
 
 export interface MagicType {
   readonly content: string
@@ -126,11 +124,7 @@ export async function analyzerCli(config: Config): Promise<SdkContent> {
   }
 
   if (config.jsonOutput) {
-    fs.writeFileSync(
-      config.jsonOutput,
-      JSON.stringify(content, (_, v) => (v instanceof Map ? Object.fromEntries(v) : v), config.jsonPrettyOutput ? 4 : 0),
-      'utf8'
-    )
+    fs.writeFileSync(config.jsonOutput, serializeSdkContent(content, !!config.jsonPrettyOutput), 'utf8')
   }
 
   debug('\n===== Done in {green}! ====', ((Date.now() - started) / 1000).toFixed(2) + 's')

package/src/analyzer/methods.ts

@@ -7,43 +7,12 @@ import { ClassDeclaration, MethodDeclaration, Node } from 'ts-morph'
 
 import { debug, format } from '../logging'
 
-import { extractParams, SdkMethodParams } from './params'
-import { analyzeUri, debugUri, Route } from './route'
-import { ResolvedTypeDeps, resolveTypeDependencies } from './typedeps'
+import { extractParams } from './params'
+import { analyzeUri, debugUri } from './route'
+import { SdkHttpMethod, SdkMethod } from './sdk'
+import { resolveTypeDependencies } from './typedeps'
 
-/**
- * SDK interface for a single controller's method
- */
-export interface SdkMethod {
-  /** Method's HTTP method (e.g. GET / POST) */
-  readonly httpMethod: SdkHttpMethod
-
-  /** Method's name */
-  readonly name: string
-
-  /** Method's parameters */
-  readonly params: SdkMethodParams
-
-  /** Method's return type with resolved dependencies */
-  readonly returnType: ResolvedTypeDeps
-
-  /** Method's parsed route */
-  readonly route: Route
-
-  /** Method's URI path */
-  readonly uriPath: string
-}
-
-/**
- * HTTP method of a controller's method
- */
-export enum SdkHttpMethod {
-  Delete = 'DELETE',
-  Get = 'GET',
-  Patch = 'PATCH',
-  Post = 'POST',
-  Put = 'PUT',
-}
+export { SdkHttpMethod, SdkMethod }
 
 /**
  * Generate a SDK interface for a controller

package/src/analyzer/params.ts

@@ -6,61 +6,25 @@ import { ClassDeclaration, Decorator, MethodDeclaration, Node, ParameterDeclarat
 
 import { debug, panic } from '../logging'
 
-import { SdkHttpMethod } from './methods'
 import { paramsFromRoute, Route } from './route'
-import { ResolvedTypeDeps, resolveTypeDependencies } from './typedeps'
-
-/**
- * Type of a parameter that must be passed to an SDK method: Body, Query or Route Param
- * Supports accessing parameters individually by key or as a whole object
- *
- * EXAMPLE
- *
- * Controller Method:
- *
- * getStuff(@Query('email') email: string, @Query('companyId'): CompanyId)
- *
- * SDK Method Param:
- * { email: string, companyId: CompanyId }
- *
- * OR
- *
- * Controller Method:
- * type EmailAndCompanyId = { email: string, companyId: CompanyId }
- * getStuff(@Query(): EmailAndCompanyId)
- *
- * SDK Method Param:
- * EmailAndCompanyId
- */
-
-export type SdkMethodParam = SdkMethodParamMap | ResolvedTypeDeps | null
-export type SdkMethodParamMap = { [key: string]: ResolvedTypeDeps }
-
-export const isParamResolvedType = (param: SdkMethodParam): param is ResolvedTypeDeps => {
-  if (param === null) {
-    return false
-  }
-  return 'rawType' in param && 'resolvedType' in param && 'relativeFilePath' in param && 'dependencies' in param && 'localTypes' in param
-}
-
-export const getParamResolvedTypes = (param: SdkMethodParam): ResolvedTypeDeps[] => {
-  if (param === null) {
-    return []
-  }
-  if (isParamResolvedType(param)) {
-    return [param]
-  }
-  return Object.values(param)
-}
+import {
+  ArgDecorator,
+  SdkMethodParams as BaseSdkMethodParams,
+  getParamResolvedTypes,
+  isParamResolvedType,
+  SdkHttpMethod,
+  SdkMethodParam,
+  SdkMethodParamMap,
+} from './sdk'
+import { resolveTypeDependencies } from './typedeps'
+
+export { ArgDecorator, getParamResolvedTypes, isParamResolvedType, SdkMethodParam, SdkMethodParamMap }
 
 /**
  * SDK interface for a controller's method's parameters
  */
-export interface SdkMethodParams {
-  bodyParams: SdkMethodParam
+export interface SdkMethodParams extends BaseSdkMethodParams {
   context: MethodContext
-  queryParams: SdkMethodParam
-  routeParams: SdkMethodParam
 }
 
 export type MethodContext = {
@@ -72,12 +36,6 @@ export type MethodContext = {
   route: Route
 }
 
-export enum ArgDecorator {
-  Body = 'Body',
-  Param = 'Param',
-  Query = 'Query',
-}
-
 export type DecoratedArg = {
   arg: ParameterDeclaration
   argParamKey: string | null