@g1cloud/api-gen 1.0.0

package/src/types/index.ts

@@ -0,0 +1,238 @@
+// CLI Options
+export interface CLIOptions {
+  source: string[];    // Multiple source directories for class parsing
+  apiSource?: string;  // Optional: specific directory to search for RestControllers
+  output?: string;
+  outDir?: string;
+  title: string;
+  version: string;
+  basePath?: string;
+}
+
+// Java Parsing Types
+export interface JavaAnnotation {
+  name: string;
+  values: Record<string, string | string[] | boolean>;
+}
+
+export interface JavaParameter {
+  name: string;
+  type: string;
+  genericType?: string;
+  annotations: JavaAnnotation[];
+}
+
+export interface JavaField {
+  name: string;
+  type: string;
+  genericType?: string;
+  annotations: JavaAnnotation[];
+  accessModifier: string;
+  javadoc?: string;
+}
+
+export interface JavadocInfo {
+  description?: string;
+  params: Record<string, string>;  // param name -> description
+  returns?: string;
+}
+
+export interface JavaMethod {
+  name: string;
+  returnType: string;
+  returnGenericType?: string;
+  parameters: JavaParameter[];
+  annotations: JavaAnnotation[];
+  javadoc?: string;
+  javadocInfo?: JavadocInfo;
+}
+
+export interface JavaClass {
+  name: string;
+  packageName: string;
+  annotations: JavaAnnotation[];
+  methods: JavaMethod[];
+  fields: JavaField[];
+  filePath: string;
+  javadoc?: string;
+  superClass?: string;  // Name of the superclass (if any)
+  isEnum?: boolean;     // True if this is an enum
+  enumValues?: string[]; // Enum constant names (if isEnum is true)
+}
+
+// Controller Analysis Types
+export interface EndpointInfo {
+  path: string;
+  method: HttpMethod;
+  operationId: string;
+  summary: string;
+  description?: string;
+  returnDescription?: string;  // @return from javadoc
+  parameters: ParameterInfo[];
+  requestBody?: RequestBodyInfo;
+  responses: ResponseInfo[];
+  security: SecurityInfo;
+  hasSearchParam: boolean;
+  hasPaginatedList: boolean;
+  paginatedListItemType?: string;
+}
+
+export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
+
+export interface ParameterInfo {
+  name: string;
+  in: 'query' | 'path' | 'header';
+  required: boolean;
+  type: string;
+  description?: string;
+  defaultValue?: string;
+  schema?: SchemaInfo;
+}
+
+export interface RequestBodyInfo {
+  required: boolean;
+  contentType: string;
+  schema: SchemaInfo;
+  description?: string;
+}
+
+export interface ResponseInfo {
+  statusCode: string;
+  description: string;
+  contentType?: string;
+  schema?: SchemaInfo;
+  headers?: Record<string, HeaderInfo>;
+}
+
+export interface HeaderInfo {
+  schema: { type: string };
+  description: string;
+}
+
+export interface SecurityInfo {
+  roles: string[];
+  authorities: string[];
+  securityExpression?: string;
+  hasComplexExpression: boolean;
+}
+
+// Schema Types
+export interface SchemaInfo {
+  type?: string;
+  format?: string;
+  items?: SchemaInfo;
+  $ref?: string;
+  properties?: Record<string, SchemaInfo>;
+  required?: string[];
+  additionalProperties?: boolean | SchemaInfo;
+  enum?: string[];
+  description?: string;
+  minLength?: number;
+  maxLength?: number;
+  minimum?: number;
+  maximum?: number;
+  pattern?: string;
+}
+
+export interface DTOInfo {
+  name: string;
+  fields: FieldInfo[];
+  packageName: string;
+}
+
+export interface FieldInfo {
+  name: string;
+  type: string;
+  genericType?: string;
+  required: boolean;
+  format?: string;
+  minLength?: number;
+  maxLength?: number;
+  minimum?: number;
+  maximum?: number;
+  pattern?: string;
+  enumValues?: string[];
+}
+
+// OpenAPI Types
+export interface TagInfo {
+  name: string;
+  description?: string;
+}
+
+export interface OpenAPISpec {
+  openapi: string;
+  info: {
+    title: string;
+    version: string;
+  };
+  servers?: Array<{
+    url: string;
+  }>;
+  tags?: TagInfo[];
+  paths: Record<string, PathItem>;
+  components: {
+    schemas: Record<string, SchemaInfo>;
+    securitySchemes?: Record<string, SecurityScheme>;
+  };
+}
+
+export interface PathItem {
+  [method: string]: OperationObject;
+}
+
+export interface OperationObject {
+  tags?: string[];
+  summary?: string;
+  description?: string;
+  operationId?: string;
+  parameters?: ParameterObject[];
+  requestBody?: RequestBodyObject;
+  responses: Record<string, ResponseObject>;
+  security?: Array<Record<string, string[]>>;
+  'x-required-roles'?: string[];
+  'x-security-expression'?: string;
+}
+
+export interface ParameterObject {
+  name: string;
+  in: string;
+  required?: boolean;
+  schema: SchemaInfo;
+  description?: string;
+}
+
+export interface RequestBodyObject {
+  required?: boolean;
+  description?: string;
+  content: Record<string, { schema: SchemaInfo }>;
+}
+
+export interface ResponseObject {
+  description: string;
+  headers?: Record<string, { schema: { type: string }; description: string }>;
+  content?: Record<string, { schema: SchemaInfo }>;
+}
+
+export interface SecurityScheme {
+  type: string;
+  scheme?: string;
+  bearerFormat?: string;
+}
+
+// Controller Info for Analysis
+export interface ControllerInfo {
+  className: string;
+  basePath: string;
+  endpoints: EndpointInfo[];
+  javaClass: JavaClass;
+}
+
+// Processing Context
+export interface ProcessingContext {
+  javaClasses: Map<string, JavaClass>;
+  controllers: ControllerInfo[];
+  dtoSchemas: Map<string, SchemaInfo>;
+  referencedTypes: Set<string>;
+  apiSourcePath?: string;  // Optional: restrict RestController search to this directory
+}