@nattyjs/types 0.0.1-beta.63 → 0.0.1-beta.65

package/dist/index.d.ts

@@ -7,6 +7,7 @@ interface TypeInfo {
     name: string;
     documentation?: string;
     type?: string;
+    tokenKey?: string;
 }
 
 interface ParameterInfo {
@@ -34,9 +35,9 @@ interface BuildOptions {
     rootDir: string;
     port: number;
     commandName: string;
-    outDir: string;
-    startupFilePath: string;
-    clearScreen: boolean;
+    outDir?: string;
+    startupFilePath?: string;
+    clearScreen?: boolean;
 }
 
 type HttpRequestBodyInfo = {
@@ -119,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;
         };
     };
@@ -255,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;
@@ -326,6 +309,11 @@ type TypeMeta = {
     enumValues: (string | number)[];
 };
 
+type JsDocExample = {
+    kind: "request" | "response";
+    value: string;
+};
+
 type JsDocHeader = {
     name: string;
     required: boolean;
@@ -345,6 +333,11 @@ type JsDocResponse = {
     type?: string;
 };
 
+type JsDocThrow = {
+    status?: number;
+    description?: string;
+};
+
 type JsDocInfo = {
     summary?: string;
     description?: string;
@@ -354,15 +347,12 @@ type JsDocInfo = {
     headers?: JsDocHeader[];
     security?: string[];
     responses?: JsDocResponse[];
+    throws?: JsDocThrow[];
+    examples?: JsDocExample[];
     deprecated?: string | true;
     custom?: Record<string, string[]>;
 };
 
-type JsDocThrow = {
-    status?: number;
-    description?: string;
-};
-
 type RouteParamMeta = {
     name: string;
     in: "path" | "query";

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@nattyjs/types",
-  "version": "0.0.1-beta.63",
+  "version": "0.0.1-beta.65",
   "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"