Merge pull request #453 from ExpressGateway/features/plugin-typings

Provide plugin typings

appveyor.yml

@@ -2,11 +2,8 @@ environment:
   matrix:
     - nodejs_version: "6"
     - nodejs_version: "8"
-cache:
-  - node_modules
 install:
   - ps: Install-Product node $env:nodejs_version
-  - if exist node_modules npm rebuild
   - npm install
 build: off
 test_script:

index.d.ts

@@ -0,0 +1,39 @@
+import express = require("express");
+import { EventEmitter } from "events";
+
+declare global {
+  namespace Express {
+    export interface Request {
+      egContext: any
+    }
+  }
+
+  namespace ExpressGateway {
+    interface Policy {
+      name: string,
+      policy(actionParams): express.RequestHandler
+    }
+
+    interface Condition {
+      name: string,
+      handler(req: express.Request, conditionConfig): boolean
+    }
+
+    interface PluginContext {
+      registerPolicy(policy: Policy): void,
+      registerCondition(condition: Condition): void,
+      registerGatewayRoute(gatewayRoutesDeclaration: (gatewayExpressApp: express.Application) => void): void,
+      registerAdminRoute(adminRoutesDeclaration: (adminExpressApp: express.Application) => void): void,
+      registerCLIExtension(cliExtension): void
+      eventBus: EventEmitter
+    }
+
+    export interface Plugin {
+      version?: string,
+      policies?: Array<string>,
+      init(context: PluginContext): void
+      options?: object
+    }
+  }
+}
+

package.json

@@ -31,7 +31,7 @@
   },
   "scripts": {
     "start": "node lib/index.js",
-    "start-dev": "LOG_LEVEL=debug node lib/index.js",
+    "start-dev": "cross-env LOG_LEVEL=debug node lib/index.js",
     "lint": "eslint --fix .",
     "clean": "rimraf dist/",
     "pretest": "eslint .",
@@ -53,6 +53,7 @@
       "coverage"
     ]
   },
+  "types": "./index.d.ts",
   "dependencies": {
     "bcrypt": "1.0.2",
     "body-parser": "1.17.2",
@@ -96,6 +97,7 @@
     "yeoman-generator": "1.1.1"
   },
   "devDependencies": {
+    "@types/express": "^4.0.37",
     "chai": "3.5.0",
     "codecov": "^2.2.0",
     "cpr": "2.2.0",