@nattyjs/types 0.0.1-beta.52 → 0.0.1-beta.54

package/dist/index.d.ts

@@ -311,11 +311,95 @@ type PropertyMeta = {
     optional?: boolean;
     enumValues?: (string | number)[];
     validators?: ValidatorMeta[];
+    defaultValue?: any;
+    defaultValueText?: string;
 };
 
 type TypeMeta = {
+    kind: "object";
     name: string;
     properties: PropertyMeta[];
+} | {
+    kind: "enum";
+    name: string;
+    baseType: "string" | "number";
+    enumValues: (string | number)[];
+};
+
+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 JsDocInfo = {
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    params?: JsDocParam[];
+    returns?: string;
+    headers?: JsDocHeader[];
+    security?: string[];
+    responses?: JsDocResponse[];
+    deprecated?: string | true;
+    custom?: Record<string, string[]>;
+};
+
+type JsDocThrow = {
+    status?: number;
+    description?: 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;
+    }>;
 };
 
-export { BuildOptions, ClassTypeInfo, Cookie, DbFieldConfig, DecoratorInfo, DecoratorParams, ExceptionTypeInfo, HttpRequestBodyInfo, HttpRequestBodyInit, HttpRequestInit, HttpResponseInit, IExceptionContext, IHttpResult, IModelBindingContext, MethodInfo, ModelBinding, ModelConfig, NattyTestModule, ParameterInfo, ProblemDetail, PropConfig, PropertyDecoratorConfig, PropertyMeta, RequestRouteInfo, RouteConfig, TypeInfo, TypeMeta, TypesInfo, ValidatorMeta };
+export { BuildOptions, ClassDocBundle, ClassTypeInfo, Cookie, DbFieldConfig, DecoratorInfo, DecoratorParams, ExceptionTypeInfo, 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,6 +1,6 @@
 {
   "name": "@nattyjs/types",
-  "version": "0.0.1-beta.52",
+  "version": "0.0.1-beta.54",
   "keywords": [],
   "author": "ajayojha <ojhaajay@outlook.com>",
   "license": "ISC",