Decorators less verbose and subscriptions

README.md

@@ -44,32 +44,26 @@ export class RootSchema {
 
 Example usage of @Ctx and @Root.
 ```typescript
-import { NonNull, ObjectType, Ctx, List, Field, Description, Root } from 'graphql-decorator';
+import { ObjectType, Ctx, Field, Root } from 'graphql-decorator';
 import { GraphQLID, GraphQLString, GraphQLList } from 'graphql';
 import * as AnswerTypes from 'graphql/answer/types/index';
 
-@ObjectType()
-@Description('An user')
+@ObjectType({description: 'An user'})
 export class UserType {
 
-    @NonNull()
-    @Field({type: GraphQLID})
+    @Field({type: GraphQLID, nonNull: true})
     id: number;
 
-    @NonNull()
-    @Field({type: GraphQLString})
+    @Field({type: GraphQLString, })
     name: string;
 
-    @NonNull()
-    @Field({type: GraphQLString})
+    @Field({type: GraphQLString, nonNull: true})
     avatarUrl: string;
 
-    @NonNull()
-    @Field({type: GraphQLString})
+    @Field({type: GraphQLString, nonNull: true})
     email: string;
 
-    @List() 
-    @Field({type: AnswerTypes.AnswerType}) 
+    @Field({type: AnswerTypes.AnswerType, isList: true}) 
     answers(@Ctx() context: any, @Root() root: any) {
         // Get answers using ctx and root.
     }
@@ -79,30 +73,28 @@ export class UserType {
 
 Use of @Pagination with @OrderBy
 ```typescript
-import { ObjectType, Arg, Pagination, Ctx, List, Field, Description } from 'graphql-decorator';
+import { ObjectType, Arg, Ctx, List, Field } from 'graphql-decorator';
 
-@ObjectType()
-@Description("Get all users query.")
+@ObjectType({description: 'Get all users query.'})
 export class UsersQuery {
 
-  @Pagination()
-  @Field({type: UserType}) 
-  users(@Ctx() context: any, @Arg({name: "offset"}) offset: number, @Arg({name: "limit"}) limit: number, @OrderBy() orderBy: orderByItem[])  {
+  @Field({type: UserType, pagination: true}) 
+  users(
+    @Ctx() context: any, 
+    @Arg({name: "offset"}) offset: number, 
+    @Arg({name: "limit"}) limit: number, 
+    @OrderBy() orderBy: orderByItem[]
+  )  {
     // Get users
   }
 
-@ObjectType()
-@Description("An user.")
+@ObjectType({description: 'An user.'})
 export class UserType {
 
-    @NonNull()
-    @Description("User id")
-    @Field({type: GraphQLID})
+    @Field({type: GraphQLID, description: 'User id', nonNull: true})
     id: number;
 
-    @NonNull()
-    @Description("User name")
-    @Field({type: GraphQLString})
+    @Field({type: GraphQLString, description: 'User name', nonNull: true})
     name: string;
 }
 
@@ -139,20 +131,16 @@ Use of @EnumType and @Value
 ```typescript
 import { EnumType, Description, Value } from 'graphql-schema-decorator';
 
-@EnumType()
-@Description('An user role. Either ADMIN or DEFAULT')
+@EnumType({description: 'An user role. Either ADMIN or DEFAULT'})
 export class UserRoleType {
 
-    @Value(0)
-    @Description("Admin role")
+    @Value(0, {description: 'Admin role'})
     ADMIN: string;
 
-    @Value("value")
-    @Description("Default role")
+    @Value('value', {description: 'Default role'})
     DEFAULT: string;
 
     @Value()
-    @Description("God role")
     GOD: string;
 
 }
@@ -162,12 +150,10 @@ And you can use the just declared enum like this.
 import { ObjectType, Arg, Pagination, Field, Description } from 'graphql-schema-decorator';
 import * as UserTypes from 'graphql-schema/user/type';
 
-@ObjectType()
-@Description("Get all users query.")
+@ObjectType({description: 'Get all users query.'})
 export class UsersQuery {
 
-  @Pagination()
-  @Field({type: UserTypes.UserType}) 
+  @Field({type: UserTypes.UserType, pagination: true}) 
   users(@Arg({name: "role", type: UserTypes.UserRoleType }) role: any) {
     // The role value will either be 0, "value" or GOD.
     // Get users by role.
@@ -184,8 +170,7 @@ import * as BannerTypes from 'graphql-schema/banner/type/banner.type';
 import { BannerRepository, BannerLocalDataSource } from 'data/source/banner';
 import { ModuleRepository } from 'data/source/module';
 
-@ObjectType()
-@Description("Get a list of banners.")
+@ObjectType({description: 'Get a list of banners.'})
 @UseContainer(Container)
 @Service()
 export class BannersQuery {
@@ -194,8 +179,7 @@ export class BannersQuery {
 		private readonly bannerRepository: BannerRepository
 	) { }
 
-	@List()
-	@Field({type: BannerTypes.BannerType}) 
+	@Field({type: BannerTypes.BannerType, isList: true}) 
 	banners()  {
 		return this.bannerRepository.getBanners();
 	}
@@ -343,13 +327,13 @@ You can use `@NonNull` and `@List` decorator. For example:
 ```ts
 @ObjectType()
 class User {
-  @NonNull() @Field({type: graphql.GraphQLID})
+  @Field({type: graphql.GraphQLID, nonNull: true})
   id: string;
 }
 
 @ObjectType()
 class Query {
-  @List() @Field({type: User}) getAllUsers(): Promise<User[]> {
+  @Field({type: User, isList: true}) getAllUsers(): Promise<User[]> {
     /* implementation for fetch all users */
   }
 }

examples/apollo-server/.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = tab
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

examples/apollo-server/README.md

@@ -0,0 +1,44 @@
+# Simple CRUD example
+
+## Install
+
+```sh
+npm i
+```
+
+### Run
+
+```sh
+npm start
+```
+
+And open http://localhost:3000/ in your browser. 
+
+
+##### Subscribe
+```gql
+subscription {
+  userAdded {
+    id
+    name
+    email
+  }
+}
+```
+
+
+##### Push
+```gql
+mutation {
+  addUser(input: {name: "Ezeki", email: "ez@jok.io"}) {
+    id
+  }
+}
+```
+
+
+##### View Generated Schema
+```
+http://localhost:3000/schema
+```
+

examples/apollo-server/nodemon.json

@@ -0,0 +1,10 @@
+{
+    "watch": [
+        "src"
+    ],
+    "ext": "ts",
+    "ignore": [
+        "src/**/*.spec.ts"
+    ],
+    "exec": "ts-node ./src/server.ts"
+}

examples/apollo-server/package.json

@@ -0,0 +1,35 @@
+{
+	"name": "simple-crud",
+	"version": "1.0.0",
+	"description": "CRUD example of graphql-decortor",
+	"main": "index.js",
+	"scripts": {
+		"start": "nodemon"
+	},
+	"dependencies": {
+		"@types/hapi": "^16.1.10",
+		"apollo-server-express": "^1.1.7",
+		"apollo-server-hapi": "^1.1.7",
+		"cors": "^2.8.4",
+		"express": "^4.14.0",
+		"express-graphql": "^0.5.3",
+		"graphql": "0.11.7",
+		"graphql-decorator": "file:../../",
+		"graphql-subscriptions": "^0.5.4",
+		"hapi": "^16.6.2",
+		"nodemon": "^1.12.1",
+		"subscriptions-transport-ws": "^0.9.1",
+		"typescript": "2.5.3"
+	},
+	"peerDependencies": {
+		"graphql": "0.11.7"
+	},
+	"keywords": [],
+	"author": "Quramy",
+	"license": "ISC",
+	"devDependencies": {
+		"@types/express": "^4.0.23-alpha",
+		"@types/node": "7.0.5",
+		"@types/graphql": "^0.11.5"
+	}
+}

examples/apollo-server/src/common/pubsub.ts

@@ -0,0 +1,3 @@
+import { PubSub } from 'graphql-subscriptions';
+
+export const pubsub = new PubSub();

examples/apollo-server/src/common/server.express.ts

@@ -0,0 +1,49 @@
+import * as express from 'express';
+import * as bodyParser from 'body-parser';
+import { createServer, Server } from 'http';
+import { graphqlExpress, graphiqlExpress } from 'apollo-server-express';
+import { SubscriptionServer } from 'subscriptions-transport-ws';
+import { execute, subscribe, printSchema } from 'graphql';
+import * as cors from 'cors';
+
+
+export default function startGraphQLServer(
+	schema,
+	domain = 'localhost',
+	port = process.env.PORT,
+	path = '/graphql',
+) {
+	const PORT = port;
+	// const myGraphQLSchema: any = schema; // ... define or import your schema here!
+
+	const app: express.Express = express();
+
+	// bodyParser is needed just for POST.
+	app.use('/', cors(), bodyParser.json(), graphqlExpress({ schema }));
+
+	app.get('/debug', graphiqlExpress({
+		endpointURL: '/',
+		editorTheme: '',
+		subscriptionsEndpoint: `ws://${domain}:${PORT}/subscriptions`,
+	})); // if you want GraphiQL enabled
+
+	app.get('/schema', (req, res) => {
+		const schemaString = printSchema(schema);
+
+		res.write(schemaString);
+		res.end();
+	});
+
+	const ws: Server = createServer(app);
+
+	ws.listen(PORT, () => {
+		console.log(`GraphQL Server is now running on http://${domain}:${PORT}`);
+
+		// set up the WebSocket for handling GraphQL subscriptions
+		const sub: SubscriptionServer = new SubscriptionServer({
+			execute,
+			subscribe,
+			schema,
+		}, { server: ws, path: '/subscriptions' });
+	});
+}

examples/apollo-server/src/common/server.hapi.ts

@@ -0,0 +1,74 @@
+import * as hapi from 'hapi';
+import { graphqlHapi, graphiqlHapi, HapiPluginOptions, HapiGraphiQLPluginOptions } from 'apollo-server-hapi';
+import { SubscriptionServer } from 'subscriptions-transport-ws';
+import { execute, subscribe, printSchema } from 'graphql';
+
+
+export default function serverHapi(
+	schema,
+	domain = 'localhost',
+	port = process.env.PORT || 3000,
+	path = '/graphql',
+) {
+	const server = new hapi.Server({ debug: false });
+
+	const HOST = domain;
+	const PORT = port;
+	const SUBSCRIPTIONS_PATH = '/subscriptions';
+
+	const graphqlOptions: HapiPluginOptions = {
+		path,
+		graphqlOptions: {
+			schema,
+		},
+		route: {
+			cors: true,
+		},
+	};
+
+	const graphiqlOptions: HapiGraphiQLPluginOptions = {
+		path: '/',
+		graphiqlOptions: {
+			endpointURL: path,
+			subscriptionsEndpoint: `ws://${HOST}:${PORT}${SUBSCRIPTIONS_PATH}`,
+		},
+	};
+
+	server.connection({
+		host: HOST,
+		port: PORT,
+	});
+
+	server.register({
+		register: graphqlHapi,
+		options: graphqlOptions,
+	});
+
+	server.register({
+		register: graphiqlHapi,
+		options: graphiqlOptions,
+	});
+
+	server.route({
+		method: 'GET',
+		path: '/schema',
+		handler: (request, reply) =>
+			reply.response(printSchema(schema)).type('text/plain'),
+	});
+
+
+
+	server.start((err) => {
+		if (err) {
+			throw err;
+		}
+
+		const sub: SubscriptionServer = new SubscriptionServer({
+			execute,
+			subscribe,
+			schema,
+		}, { server: server.listener, path: SUBSCRIPTIONS_PATH });
+
+		console.log(`Server running at: ${server.info.uri}`);
+	});
+}