@nattyjs/types 0.0.1-beta.7 → 0.0.1-beta.70

package/dist/index.d.ts

@@ -7,6 +7,7 @@ interface TypeInfo {
     name: string;
     documentation?: string;
     type?: string;
+    tokenKey?: string;
 }
 
 interface ParameterInfo {
@@ -26,6 +27,7 @@ interface ClassTypeInfo extends TypeInfo {
     methods?: MethodInfo[];
     properties?: TypeInfo[];
     route?: DecoratorInfo;
+    jsDoc?: any;
 }
 
 interface BuildOptions {
@@ -33,6 +35,9 @@ interface BuildOptions {
     rootDir: string;
     port: number;
     commandName: string;
+    outDir?: string;
+    startupFilePath?: string;
+    clearScreen?: boolean;
 }
 
 type HttpRequestBodyInfo = {
@@ -41,6 +46,7 @@ type HttpRequestBodyInfo = {
     number?: number | number[];
     boolean?: boolean | boolean[];
     FormData?: FormData;
+    buffer?: any;
     ArrayBuffer?: ArrayBuffer;
     Blob?: Blob;
     json?: {
@@ -89,6 +95,7 @@ interface HttpResponseInit {
     headers?: HeadersInit;
     cookies?: Cookie[];
     enableContentNegotiation?: boolean;
+    isBuffer?: boolean;
 }
 
 interface NattyTestModule {
@@ -113,47 +120,32 @@ type ExceptionTypeInfo = string | number | boolean | {
 
 interface RouteConfig {
     controller: Function;
-    parameters: Array<{
-        name: string;
-        type: string;
-    }>;
+    parameters: TypeInfo[];
     get: {
         [key: string]: {
             name: string;
-            parameters: Array<{
-                name: string;
-                type: string;
-            }>;
+            parameters: TypeInfo[];
             returnType: string;
         };
     };
     post: {
         [key: string]: {
             name: string;
-            parameters: Array<{
-                name: string;
-                type: string;
-            }>;
+            parameters: TypeInfo[];
             returnType: string;
         };
     };
     put: {
         [key: string]: {
             name: string;
-            parameters: Array<{
-                name: string;
-                type: string;
-            }>;
+            parameters: TypeInfo[];
             returnType: string;
         };
     };
     delete: {
         [key: string]: {
             name: string;
-            parameters: Array<{
-                name: string;
-                type: string;
-            }>;
+            parameters: TypeInfo[];
             returnType: string;
         };
     };
@@ -249,10 +241,7 @@ interface RequestRouteInfo {
     path: string;
     methodInfo: MethodInfo;
     controller: any;
-    parameters: Array<{
-        name: string;
-        type: string;
-    }>;
+    parameters: TypeInfo[];
     configuredRoutePath: string;
     queryParams: {
         [key: string]: any;
@@ -262,16 +251,159 @@ interface RequestRouteInfo {
     };
 }
 
-interface PackageJsonConfig {
-    addExports: string[];
-}
+type ValidatorMeta = {
+    kind: "required";
+    options?: any;
+} | {
+    kind: "minLength";
+    value: number;
+} | {
+    kind: "maxLength";
+    value: number;
+} | {
+    kind: "min";
+    value: number;
+} | {
+    kind: "max";
+    value: number;
+} | {
+    kind: "regex";
+    pattern: string;
+    flags?: string;
+} | {
+    kind: "email";
+} | {
+    kind: "url";
+} | {
+    kind: "ip";
+} | {
+    kind: "enum";
+    values: (string | number)[];
+} | {
+    kind: "custom";
+    name: string;
+    args?: any[];
+};
 
-interface LibraryConfig {
-    packageJson: PackageJsonConfig;
-}
+type PropertyMeta = {
+    name: string;
+    type: "string" | "number" | "boolean" | "object" | "array";
+    ref?: string;
+    itemsType?: "string" | "number" | "boolean" | "object";
+    itemsRef?: string;
+    optional?: boolean;
+    enumValues?: (string | number)[];
+    validators?: ValidatorMeta[];
+    defaultValue?: any;
+    defaultValueText?: string;
+};
 
-interface NattyCliConfig {
-    library: Partial<LibraryConfig>;
-}
+type TypeMeta = {
+    kind: "object";
+    name: string;
+    properties: PropertyMeta[];
+} | {
+    kind: "enum";
+    name: string;
+    baseType: "string" | "number";
+    enumValues: (string | number)[];
+};
+
+type JsDocExample = {
+    kind: "request" | "response";
+    value: string;
+};
+
+type JsDocHeader = {
+    name: string;
+    required: boolean;
+    type?: string;
+    description?: string;
+};
+
+type JsDocParam = {
+    name: string;
+    type?: string;
+    description?: string;
+};
+
+type JsDocResponse = {
+    status: number;
+    description?: string;
+    type?: string;
+};
+
+type JsDocThrow = {
+    status?: number;
+    description?: string;
+};
+
+type JsDocInfo = {
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    params?: JsDocParam[];
+    returns?: string;
+    headers?: JsDocHeader[];
+    security?: string[];
+    responses?: JsDocResponse[];
+    throws?: JsDocThrow[];
+    examples?: JsDocExample[];
+    deprecated?: string | true;
+    custom?: Record<string, string[]>;
+};
+
+type RouteParamMeta = {
+    name: string;
+    in: "path" | "query";
+    required: boolean;
+    tsType?: string;
+};
+
+type RouteMeta = {
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    path: string;
+    controller: string;
+    action: string;
+    params?: RouteParamMeta[];
+    requestBody?: {
+        name: string;
+        tsType: string;
+        required?: boolean;
+    };
+    responseType?: string;
+    doc?: JsDocInfo;
+    auth?: {
+        isAnonymous?: boolean;
+        schemes?: string[];
+    };
+};
+
+type ClassDocBundle = {
+    className: string;
+    classDoc: JsDocInfo;
+    methods: Array<{
+        name: string;
+        doc: JsDocInfo;
+    }>;
+    properties: Array<{
+        name: string;
+        doc: JsDocInfo;
+    }>;
+};
+
+type GenerateOpenApiOptions = {
+    title: string;
+    version: string;
+    serverUrl?: string;
+    apiPrefix?: string;
+    includeApiPrefix?: boolean;
+    globalHeaders?: Array<{
+        name: string;
+        required?: boolean;
+        description?: string;
+    }>;
+    strict?: boolean;
+};
 
-export { BuildOptions, ClassTypeInfo, Cookie, DbFieldConfig, DecoratorInfo, DecoratorParams, ExceptionTypeInfo, HttpRequestBodyInfo, HttpRequestBodyInit, HttpRequestInit, HttpResponseInit, IExceptionContext, IHttpResult, IModelBindingContext, MethodInfo, ModelBinding, ModelConfig, NattyCliConfig, NattyTestModule, ParameterInfo, ProblemDetail, PropConfig, PropertyDecoratorConfig, RequestRouteInfo, RouteConfig, TypeInfo, TypesInfo };
+export { BuildOptions, ClassDocBundle, ClassTypeInfo, Cookie, DbFieldConfig, DecoratorInfo, DecoratorParams, ExceptionTypeInfo, GenerateOpenApiOptions, HttpRequestBodyInfo, HttpRequestBodyInit, HttpRequestInit, HttpResponseInit, IExceptionContext, IHttpResult, IModelBindingContext, JsDocHeader, JsDocInfo, JsDocParam, JsDocResponse, JsDocThrow, MethodInfo, ModelBinding, ModelConfig, NattyTestModule, ParameterInfo, ProblemDetail, PropConfig, PropertyDecoratorConfig, PropertyMeta, RequestRouteInfo, RouteConfig, RouteMeta, TypeInfo, TypeMeta, TypesInfo, ValidatorMeta };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@nattyjs/types",
-  "version": "0.0.1-beta.7",
+  "version": "0.0.1-beta.70",
   "keywords": [],
   "author": "ajayojha <ojhaajay@outlook.com>",
   "license": "ISC",
   "description": "",
-  "main": "./dist/index.d.ts",
+  "module": "./dist/index.mjs",
+  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"