Move all types into a index.d.ts

Author: stephenbaldwin

ApiBlueprint.ts

@@ -0,0 +1,41 @@
+import Router from './Router';
+import express from 'express';
+import IMountableItem from './IMountableItem';
+
+export default class ApiBlueprint implements IMountableItem {
+  public path: string = '/docs/blueprint';
+  public httpMethod: string = 'get';
+  protected router: Router;
+
+  constructor() {
+    throw new Error('not yet implemented');
+  }
+
+  onMount(router: Router): this {
+    this.router = router;
+
+    return this;
+  }
+
+  at(path: string): this {
+    this.path = path;
+
+    return this;
+  }
+ 
+  withOptions(options: {}): this {
+    return this;
+  }
+
+  asExpressRoute(): (req: express.Request, res: express.Response) => void {
+    throw new Error('Not yet implemented');
+  }
+
+  asKoaRoute() {
+    throw new Error('not yet implemented');
+  }
+
+  asMetal() {
+    throw new Error('not yet implemented');
+  }
+}

ICacheEngine.ts

@@ -1,4 +1,4 @@
-import ICacheEngine from './ICacheEngine';
+import { ICacheEngine } from '.';
 
 const STORE_EXPIRATION_CHECK_IN_MS = 10;
 const DEFAULT_CACHE_TIME_IN_MS = 10;

IMountableItem.ts

@@ -1,16 +1,8 @@
-import IMountableItem from './IMountableItem';
+import { IMountableItem, IOperationVariable, IOpenApiOptions,  } from '.';
 import describeRouteVariables from './describeRouteVariables';
 import Router from './Router';
-import Route, { IOperationVariable } from './Route'; import express from 'express';
-
-interface IOpenApiOptions {
-  title: string;
-  version: string;
-  termsOfService?: string;
-  license?: string;
-  basePath?: string;
-  host?: string;
-}
+import Route from './Route';
+import express from 'express';
 
 interface IParameter {
   name: string;
@@ -145,10 +137,12 @@ function buildParametersArray({ variableDefinitions, variableLocation, refLocati
 }
 
 class MountableDocument implements IMountableItem {
-  public path: string = '/docs/openapi/v2';
+  public path: string = '/docs/openapi';
   public httpMethod: string = 'get';
 
-  constructor(protected options: IOpenApiOptions, protected router?: Router) {
+  protected router?: Router;
+
+  constructor(protected options: IOpenApiOptions) {
   }
 
   onMount(router: Router): this {
@@ -207,6 +201,8 @@ class MountableDocument implements IMountableItem {
 }
 
 export class V2 extends MountableDocument {
+  public path: string = '/docs/swagger';
+
   protected async generateDocumentation(): Promise<any> {
     const router = this.getRouter();
 

InMemoryCache.ts

@@ -1,48 +1,15 @@
-import IMountableItem from './IMountableItem';
+import {
+  IMountableItem, IConstructorRouteOptions, IRouteOptions,
+  IOperationVariable, IResponse,
+}  from '.';
+
 import { IncomingHttpHeaders } from 'http';
 import { DocumentNode, parse, print, getOperationAST } from 'graphql';
 import { AxiosTransformer, AxiosInstance, AxiosRequestConfig } from 'axios';
 import * as express from 'express';
 
 const PATH_VARIABLES_REGEX = /:([A-Za-z]+)/g
 
-export interface IConstructorRouteOptions {
-  schema: DocumentNode | string; // GraphQL Document Type
-  operationName: string;
-  axios: AxiosInstance;
-  path?: string;
-  cacheTimeInMs?: number;
-  method?: string;
-
-  passThroughHeaders?: string[];
-
-  staticVariables?: {};
-  defaultVariables?: {};
-}
-
-export interface IRouteOptions {
-  path?: string;
-  cacheTimeInMs?: number;
-  method?: string;
-  passThroughHeaders?: string[];
-
-  staticVariables?: {};
-  defaultVariables?: {};
-}
-
-export interface IOperationVariable {
-  name: string;
-  required: boolean;
-  type: string;
-  array: boolean;
-  defaultValue?: string | boolean | number;
-}
-
-export interface IResponse {
-  statusCode: number;
-  body: {};
-}
-
 /*
 enum EHTTPMethod {
   GET = 'get',

OpenApi.ts

@@ -1,23 +1,15 @@
-import IMountableItem from './IMountableItem';
-import ICacheEngine from './ICacheEngine';
-import Route, { IConstructorRouteOptions } from './Route';
+import {
+  IGlobalConfiguration,
+  IMountableItem,
+  ICacheEngine,
+  IConstructorRouteOptions,
+} from '.';
+import Route from './Route';
 import express from 'express';
-import axios, { AxiosBasicCredentials, AxiosProxyConfig, AxiosInstance, AxiosRequestConfig } from 'axios';
+import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
 import { parse, DocumentNode, getOperationAST } from 'graphql';
 import { version } from './package.json';
 
-interface IGlobalConfiguration {
-  cacheEngine?: ICacheEngine;
-  defaultTimeoutInMs?: number;
-  defaultCacheTimeInMs?: number;
-  autoDiscoverEndpoints?: boolean;
-  optimizeQueryRequest?: boolean;
-  headers?: {};
-  passThroughHeaders?: string[];
-  auth?: AxiosBasicCredentials;
-  proxy?: AxiosProxyConfig;
-}
-
 const DEFAULT_CONFIGURATION: IGlobalConfiguration = {
   cacheEngine: undefined,
   auth: undefined,

Route.ts

@@ -0,0 +1,84 @@
+import express from 'express';
+import Router from './Router';
+import { DocumentNode } from 'graphql';
+import axios, {
+  AxiosBasicCredentials, AxiosProxyConfig, AxiosInstance
+} from 'axios';
+
+export interface IGlobalConfiguration {
+  cacheEngine?: ICacheEngine;
+  defaultTimeoutInMs?: number;
+  defaultCacheTimeInMs?: number;
+  autoDiscoverEndpoints?: boolean;
+  optimizeQueryRequest?: boolean;
+  headers?: {};
+  passThroughHeaders?: string[];
+  auth?: AxiosBasicCredentials;
+  proxy?: AxiosProxyConfig;
+}
+
+export interface IConstructorRouteOptions {
+  schema: DocumentNode | string; // GraphQL Document Type
+  operationName: string;
+  axios: AxiosInstance;
+  path?: string;
+  cacheTimeInMs?: number;
+  method?: string;
+
+  passThroughHeaders?: string[];
+
+  staticVariables?: {};
+  defaultVariables?: {};
+}
+
+export interface IRouteOptions {
+  path?: string;
+  cacheTimeInMs?: number;
+  method?: string;
+  passThroughHeaders?: string[];
+
+  staticVariables?: {};
+  defaultVariables?: {};
+}
+
+export interface IOperationVariable {
+  name: string;
+  required: boolean;
+  type: string;
+  array: boolean;
+  defaultValue?: string | boolean | number;
+}
+
+export interface IResponse {
+  statusCode: number;
+  body: {};
+}
+
+export interface IOpenApiOptions {
+  title: string;
+  version: string;
+  termsOfService?: string;
+  license?: string;
+  basePath?: string;
+  host?: string;
+}
+
+export interface IMountableItem {
+  path: string;
+  httpMethod: string;
+
+  at: (path: string) => this;
+
+  asExpressRoute: () => (req: express.Request, res: express.Response) => void;
+  asKoaRoute: () => void;
+  asMetal: () => void;
+
+  withOptions: (options: any) => this;
+
+  onMount?: (router: Router) => this
+}
+
+export interface ICacheEngine {
+  get: (key: string, setFn?: () => string|number|boolean) => string|number|boolean;
+  set: (key: string, value: string|number|boolean) => void;
+}

Router.ts

@@ -1,5 +1,8 @@
 import Router from './Router';
 import Route from './Route';
 
+import * as OpenApi from './OpenApi';
+import ApiBlueprint from './ApiBlueprint';
+
 export default Router;
-export { Route };
+export { Route, OpenApi, ApiBlueprint };

index.d.ts

@@ -3,7 +3,8 @@
   "version": "1.0.0-alpha.10",
   "description": "",
   "main": "index.js",
-  "files": ["*.js"],
+  "types": "./index.d.ts",
+  "files": ["*.js", "index.d.ts"],
   "scripts": {
     "build": "tsc -p .",
     "prepare": "npm run build",