(apimocker:new) new type definition for apimocker library (DefinitelyTyped#36952)

* (lib) initial source for @types/apimocker

* (test) typical, documented use case

* (cleanup) prep for PR

* (apimocker) updates

* (apimocker) fixed sample code

* (apimocker:refactor) fixes from linting notes

* (apimocker:check) generated with dts-gen & tweaked

* (apimocker:build) wip to fix CI build

* (apimocker:build) fixed header formatting

* (apimocker:build) removed .gitignore

* (apimocker:build) tweaks

* (apimocker:wip) tslint.json issues

* (apimocker:build) added package.json & ts3.1/*

* (apimocker:refactor) tweaks to fix build

* (apimocker:build) removed offending test

* (apimocker:build) Removed unused file

* (apimocker:refactor) more build fixes 😭

* (feedback) cleanup comments & removed package.json

* (feedback) more tweaks from review notes

Author: uchilaka

types/apimocker/apimocker-tests.ts

@@ -0,0 +1,14 @@
+import * as ApiMocker from 'apimocker';
+
+const PORT = 7878;
+
+// $ExpectType ApiMocker
+const server = ApiMocker.createServer({ quiet: false });
+
+// $ExpectType ApiMocker
+server.start(PORT, () => {
+    console.log(`API mocker started successfully @${PORT}`);
+
+    // $ExpectType ApiMocker
+    server.stop(() => console.log('API mocker stopped successully'));
+});

types/apimocker/index.d.ts

@@ -0,0 +1,49 @@
+// Type definitions for apimocker 1.1
+// Project: https://www.npmjs.com/package/apimocker
+// Definitions by: Uchenna <https://github.com/uchilaka>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.2
+
+import { RequestHandler, Application } from 'express';
+
+export interface ConfigOptions {
+    port?: string;
+    mockDirectory?: string;
+    allowedDomains?: string[];
+    allowedHeaders?: string[];
+    logRequestHeaders?: boolean;
+    allowAvoidPreFlight?: boolean;
+    useUploadFieldname?: boolean;
+    webServices?: any;
+    quiet?: boolean;
+}
+
+export interface ApiMocker {
+    express: Application;
+    middlewares: RequestHandler[];
+    setConfigFile: (file: string) => ApiMocker;
+    loadConfigFile: () => void;
+    setRoutes: (webServices: any) => void;
+    /**
+     * Set the route for express, in case it was not set yet
+     */
+    setRoute: (options: any) => void;
+    /**
+     * Start a new instance of API Mocker
+     */
+    start: (serverPort: string | number, callback?: () => void) => ApiMocker;
+    /**
+     * Stop the referenced instance of API Mocker
+     */
+    stop: (callback?: () => void) => ApiMocker;
+}
+
+export const middlewares: RequestHandler[];
+
+export function createServer(options?: ConfigOptions): ApiMocker;
+
+export function setConfigFile(file: string): ApiMocker;
+
+export function start(serverPort: string | number, callback?: () => void): ApiMocker;
+
+export function stop(callback?: () => void): ApiMocker;

types/apimocker/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6"],
+        "baseUrl": "../",
+        "typeRoots": ["../"],
+        "types": [],
+        "noEmit": true,
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "apimocker-tests.ts"
+    ]
+}

types/apimocker/tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "dtslint/dt.json"
+}