feat(app): rename app to server (#44)

goldcaddy77 · Jan 26, 2019 · aa279f4 · aa279f4
1 parent 533d838
commit aa279f4
Show file tree

Hide file tree

Showing 11 changed files with 40 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -79,11 +79,11 @@ export class UserResolver extends BaseResolver<User> {
 
 import 'reflect-metadata';
 import { Container } from 'typedi';
-import { App } from 'warthog';
+import { Server } from 'warthog';
 
 async function bootstrap() {
-  const app = new App({ container: Container });
-  return app.start();
+  const server = new Server({ container: Container });
+  return server.start();
 }
 
 bootstrap()

diff --git a/examples/1-simple-model/src/index.ts b/examples/1-simple-model/src/index.ts
@@ -4,15 +4,15 @@ import { Container } from 'typedi';
 
 dotenv.config();
 
-import { App } from '../../../src/';
+import { Server } from '../../../src/';
 
 async function bootstrap() {
-  const app = new App({
+  const server = new Server({
     container: Container,
     warthogImportPath: '../../../src' // Path written in generated classes
   });
 
-  return app.start();
+  return server.start();
 }
 
 bootstrap().catch((error: Error) => {

diff --git a/examples/2-complex-example/src/index.test.ts b/examples/2-complex-example/src/index.test.ts
@@ -3,18 +3,18 @@ import 'reflect-metadata';
 
 import { Binding } from '../generated/binding';
 
-import { getServer } from './app';
 import { User } from './modules/user/user.model';
+import { getServer } from './server';
 
-const app = getServer({}, { logging: false });
+const server = getServer({}, { logging: false });
 let binding: Binding;
 let testUser: User;
 
 beforeAll(async done => {
   console.error = jest.fn();
 
-  await app.start();
-  binding = ((await app.getBinding()) as unknown) as Binding; // TODO: clean this up
+  await server.start();
+  binding = ((await server.getBinding()) as unknown) as Binding; // TODO: clean this up
 
   const key = new Date().getTime();
 
@@ -34,7 +34,7 @@ beforeAll(async done => {
 
 afterAll(async done => {
   (console.error as any).mockRestore();
-  await app.stop();
+  await server.stop();
   done();
 });
 

diff --git a/examples/2-complex-example/src/index.ts b/examples/2-complex-example/src/index.ts
@@ -2,13 +2,13 @@ import 'reflect-metadata';
 
 import * as dotenv from 'dotenv';
 
-import { getServer } from './app';
+import { getServer } from './server';
 
 dotenv.config();
 
 async function bootstrap() {
-  const app = getServer();
-  await app.start();
+  const server = getServer();
+  await server.start();
 }
 
 bootstrap().catch((error: Error) => {

diff --git a/examples/2-complex-example/src/app.ts → examples/2-complex-example/src/server.ts b/examples/2-complex-example/src/app.ts → examples/2-complex-example/src/server.ts
@@ -2,7 +2,7 @@ import 'reflect-metadata';
 
 import { Container } from 'typedi';
 
-import { App, BaseContext } from '../../../src/';
+import { BaseContext, Server } from '../../../src/';
 
 // import { User } from './modules/user/user.model';
 
@@ -15,7 +15,7 @@ interface Context extends BaseContext {
 }
 
 export function getServer(AppOptions = {}, dbOptions = {}) {
-  return new App<Context>(
+  return new Server<Context>(
     {
       container: Container,
       // Inject a fake user.  In a real app you'd parse a JWT to add the user

diff --git a/examples/2-complex-example/tools/generate.ts b/examples/2-complex-example/tools/generate.ts
@@ -1,6 +1,6 @@
 import * as Debug from 'debug';
 
-import { getServer } from '../src/app';
+import { getServer } from '../src/server';
 
 const logger = Debug('warthog:generate');
 

diff --git a/examples/2-complex-example/tools/seed.ts b/examples/2-complex-example/tools/seed.ts
@@ -1,7 +1,7 @@
 import * as Debug from 'debug';
 import * as Faker from 'faker';
 
-import { getServer } from '../src/app';
+import { getServer } from '../src/server';
 
 if (process.env.NODE_ENV !== 'development') {
   throw 'Seeding only available in development environment';
@@ -12,10 +12,10 @@ const logger = Debug('warthog:seed');
 const NUM_USERS = 100;
 
 async function seedDatabase() {
-  const app = getServer();
-  await app.start();
+  const server = getServer();
+  await server.start();
 
-  const binding = await app.getBinding();
+  const binding = await server.getBinding();
 
   for (let index = 0; index < NUM_USERS; index++) {
     const random = new Date()
@@ -45,7 +45,7 @@ async function seedDatabase() {
     }
   }
 
-  return app.stop();
+  return server.stop();
 }
 
 seedDatabase()

diff --git a/examples/3-one-to-many-relationship/src/index.ts b/examples/3-one-to-many-relationship/src/index.ts
@@ -1,18 +1,18 @@
-import 'reflect-metadata';
 import * as dotenv from 'dotenv';
+import 'reflect-metadata';
 import { Container } from 'typedi';
 
 dotenv.config();
 
-import { App } from '../../../src/';
+import { Server } from '../../../src/';
 
 async function bootstrap() {
-  const app = new App({
+  const server = new Server({
     container: Container,
     warthogImportPath: '../../../src' // Path written in generated classes
   });
 
-  await app.start();
+  await server.start();
 }
 
 bootstrap().catch((error: Error) => {

diff --git a/examples/4-many-to-many-relationship/src/index.ts b/examples/4-many-to-many-relationship/src/index.ts
@@ -1,18 +1,18 @@
-import 'reflect-metadata';
 import * as dotenv from 'dotenv';
+import 'reflect-metadata';
 import { Container } from 'typedi';
 
 dotenv.config();
 
-import { App } from '../../../src/';
+import { Server } from '../../../src/';
 
 async function bootstrap() {
-  const app = new App({
+  const server = new Server({
     container: Container,
     warthogImportPath: '../../../src' // Path written in generated classes
   });
 
-  await app.start();
+  await server.start();
 }
 
 bootstrap().catch((error: Error) => {

diff --git a/src/core/index.ts b/src/core/index.ts
@@ -1,4 +1,4 @@
-export * from './app';
+export * from './server';
 export * from './BaseModel';
 export * from './Context';
 export * from './types';
diff --git a/src/core/app.ts → src/core/server.ts b/src/core/app.ts → src/core/server.ts
@@ -24,21 +24,22 @@ import { CodeGenerator } from './code-generator';
 import { BaseContext } from './Context';
 import { Maybe } from './types';
 
-export interface AppOptions<T> {
-  authChecker?: AuthChecker<T>;
+export interface ServerOptions<T> {
   container: Container;
+
+  authChecker?: AuthChecker<T>;
   context?: (request: Request) => object;
   host?: string;
   generatedFolder?: string;
   middlewares?: any[]; // TODO: fix
   mockDBConnection?: boolean;
   openPlayground?: boolean;
   port?: string | number;
-  resolversPath: string[];
+  resolversPath?: string[];
   warthogImportPath?: string;
 }
 
-export class App<C extends BaseContext> {
+export class Server<C extends BaseContext> {
   appHost: string;
   appPort: number;
   authChecker: AuthChecker<C>;
@@ -52,7 +53,7 @@ export class App<C extends BaseContext> {
   schema?: GraphQLSchema;
 
   constructor(
-    private appOptions: AppOptions<C>,
+    private appOptions: ServerOptions<C>,
     private dbOptions: Partial<ConnectionOptions> = {}
   ) {
     if (!process.env.NODE_ENV) {
@@ -190,3 +191,6 @@ export class App<C extends BaseContext> {
     return process.env.NODE_ENV === 'development';
   }
 }
+
+// Backwards compatability.  This was renamed.
+export const App = Server;