convexpress - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

src/index.d.ts

+/// <reference types="body-parser" />
+/// <reference types="express" />
+import { OptionsJson } from "body-parser";
+import { RequestHandler, Router } from "express";
+
+declare namespace convexpress {
+    interface IResponseDefinition {
+        description?: string;
+        schema?: any;
+        headers?: any;
+        examples?: any;
+    }
+    interface IParameter {
+        name: string;
+        description?: string;
+        in: "body" | "path" | "query" | "header";
+        required?: boolean;
+        type?: string;
+        schema?: any;
+    }
+
+    interface IConvRoute {
+        path: string;
+        method: string;
+        handler: RequestHandler;
+        parameters?: IParameter[];
+        middleware?: RequestHandler[];
+        description?: string;
+        tags?: string[];
+        responses?: {
+            [statusCode: string]: IResponseDefinition;
+        };
+    }
+
+    interface IConvRouter extends Router {
+        convroute: (route: IConvRoute) => this;
+        serveSwagger: () => this;
+        loadFrom: (pattern: string) => this;
+    }
+
+    interface IOptions {
+        host: string;
+        basePath?: string;
+        info: string;
+        bodyParserOptions?: {
+            limit?: OptionsJson["limit"];
+            strict?: OptionsJson["strict"];
+            verify?: OptionsJson["verify"];
+        };
+    }
+}
+
+declare function convexpress(
+    options: convexpress.IOptions
+): convexpress.IConvRouter;
+
+export = convexpress;

CHANGELOG.md

@@ -0,1 +1,7 @@
+## 2.1.0 (November 19, 2017)
+
+Features:
+
+* add TypeScript type definitions
+
 ## 2.0.0 (November 19, 2017)
@@ -2,0 +8,0 @@

package.json

 {
   "name": "convexpress",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Employ conventions to register express routes",
   "main": "src/index.js",
+  "typings": "src/index.d.ts",
   "files": [
@@ -47,2 +48,4 @@ "src"
   "dependencies": {
+    "@types/body-parser": "^1.16.8",
+    "@types/express": "^4.0.39",
     "ajv": "^5.3.0",
@@ -49,0 +52,0 @@ "body-parser": "^1.18.2",

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20843

8.44%

Number of package files

11

10%

Lines of code

384

15.32%

Number of medium supply chain risk alerts

1

-50%

Worsened metrics

Dependency count

10

25%

Dependency changes

• + Added

  @types/body-parser@^1.16.8

• + Added

  @types/express@^4.0.39

• + Added

  @types/body-parser@1.19.6
  (transitive)

• + Added

  @types/connect@3.4.38
  (transitive)

• + Added

  @types/express@4.17.25
  (transitive)

• + Added

  @types/express-serve-static-core@4.19.8
  (transitive)

• + Added

  @types/http-errors@2.0.5
  (transitive)

• + Added

  @types/mime@1.3.5
  (transitive)

• + Added

  @types/node@25.5.0
  (transitive)

• + Added

  @types/qs@6.15.0
  (transitive)

• + Added

  @types/range-parser@1.2.7
  (transitive)

• + Added

  @types/send@0.17.61.2.1
  (transitive)

• + Added

  @types/serve-static@1.15.10
  (transitive)

• + Added

  undici-types@7.18.2
  (transitive)