initial commit

Author: johnymontana

.babelrc

@@ -0,0 +1,8 @@
+{
+  presets: ['latest'],
+  plugins: [
+    'transform-runtime',
+    'transform-async-generator-functions',
+    'transform-object-rest-spread',
+  ],
+}

.gitignore

@@ -0,0 +1,64 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+.idea
+
+.DS_Store
+
+dist/

.npmignore

@@ -0,0 +1,4 @@
+src
+test
+.DS_Store
+.idea

LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -0,0 +1,68 @@
+# neo4j-graphql-js
+
+A GraphQL to Cypher query execution layer for Neo4j and JavaScript GraphQL implementations.
+
+## What is `neo4j-graphql-js`
+
+A package to make it easier to use GraphQL and Neo4j together. `neo4j-graphql-js` translates GraphQL queries to a single Cypher query, eliminating the need to write queries in GraphQL resolvers. It also exposes the Cypher query language through GraphQL via the `@cypher` schema directive.
+
+### Goals
+
+* Translate GraphQL queries to Cypher to simply the process of writing GraphQL resolvers
+* Allow for custom logic by overriding of any resolver function
+* Work with `graphl-tools`, `graphql-js`, and `apollo-server`
+* Support GraphQL servers that need to resolve data from multiple data services/databases
+* Expose the power of Cypher through GraphQL via the `@cypher` directive
+
+## `@cypher` directive
+
+GraphQL is fairly limited when it comes to expressing complex queries such as filtering, or aggregations. We expose the graph querying language Cypher through GraphQL via the `@cypher` directive. Annotate a field in your schema with the `@cypher` directive to map the results of that query to the annotated GraphQL field. For example:
+
+~~~
+type Movie {
+  movieId: ID!
+  title: String
+  year: Int
+  plot: String
+
+  similar(first: Int = 3, offset: Int = 0): [Movie] @cypher(statement: "WITH {this} AS this MATCH (this)-->(:Genre)<--(o:Movie) RETURN o ORDER BY COUNT(*) DESC")
+}
+~~~
+
+The field `similar` will be resolved using the Cypher query
+
+~~~
+MATCH (this)-->(:Genre)<--(o:Movie) RETURN o ORDER BY COUNT(*) DESC
+~~~
+
+to find movies with overlapping Genres. See the [examples](example/graphql-tools/movies.js) for more information.
+
+## Test
+
+We use the `ava` test runner.
+
+~~~
+npm install
+npm build
+npm test
+~~~
+
+Currently we only have simple unit tests verifying generated Cypher as translated from GraphQL queries and schema. More complete tests and CI integration coming soon.
+
+## Examples
+
+See [example/graphql-tools/movies.js](example/graphql-tools/movies.js)
+
+## Features
+
+- [x] translate basic GraphQL queries to Cypher by
+- [x] `first` and `offset` arguments for
+- [x] `@cypher` directive for mapping
+- [ ] Handle enumeration types
+- [ ] Handle interface types
+- [ ] Handle fragments
+- [ ] Handle named fragments
+- [ ] Ordering
+- [ ] Example with `graphql-js`
+- [ ] Example with `apollo-server`
+- [ ] Example with Apollo Launchpad

example/graphql-tools/movies.js

@@ -0,0 +1,92 @@
+import { makeExecutableSchema } from 'graphql-tools';
+import {neo4jgraphql} from '../../src/index';
+import express from 'express';
+import { graphqlExpress, graphiqlExpress } from 'graphql-server-express';
+import bodyParser from 'body-parser';
+import {v1 as neo4j} from 'neo4j-driver';
+
+
+
+// Simple Movie schema
+const typeDefs = `
+type Movie {
+  movieId: ID!
+  title: String
+  year: Int
+  plot: String
+  poster: String
+  imdbRating: Float
+  genres: [String]
+  similar(first: Int = 3, offset: Int = 0): [Movie] @cypher(statement: "WITH {this} AS this MATCH (this)--(:Genre)--(o:Movie) RETURN o")
+  mostSimilar: Movie @cypher(statement: "WITH {this} AS this RETURN this")
+  degree: Int @cypher(statement: "WITH {this} AS this RETURN SIZE((this)--())")
+  actors(first: Int = 3, offset: Int = 0): [Actor] @relation(name: "ACTED_IN", direction:"IN")
+  avgStars: Float
+}
+
+interface Person {
+	id: ID!
+  name: String
+}
+
+type Actor implements Person {
+  id: ID!
+  name: String
+  movies: [Movie]
+}
+
+type User implements Person {
+  id: ID!
+	name: String
+}
+
+
+type Query {
+  Movie(id: ID, title: String, year: Int, plot: String, poster: String, imdbRating: Float, first: Int, offset: Int): [Movie]
+}
+`;
+
+const resolvers = {
+  // root entry point to GraphQL service
+  Query: {
+    // fetch movies by title substring
+    Movie(object, params, ctx, resolveInfo) {
+      return neo4jgraphql(object, params, ctx, resolveInfo);
+    }
+  }
+};
+
+
+const schema = makeExecutableSchema({
+  typeDefs,
+  resolvers,
+});
+
+function context(headers, secrets) {
+  let driver = neo4j.driver(secrets.NEO4J_URI || "bolt://localhost:7687", neo4j.auth.basic(secrets.NEO4J_USER || "neo4j", secrets.NEO4J_PASSWORD || "letmein"))
+  return {driver};
+}
+
+const rootValue = {};
+
+
+const PORT = 3000;
+const server = express();
+
+server.use('/graphql', bodyParser.json(), graphqlExpress(request => ({
+  schema,
+  rootValue,
+  context: context(request.headers, process.env),
+})));
+
+server.use('/graphiql', graphiqlExpress({
+  endpointURL: '/graphql',
+  query: `{
+  
+}`,
+}));
+
+server.listen(PORT, () => {
+  console.log(`GraphQL Server is now running on http://localhost:${PORT}/graphql`);
+  console.log(`View GraphiQL at http://localhost:${PORT}/graphiql`);
+});

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "neo4j-graphql-js",
+  "version": "0.1.0",
+  "description": "A GraphQL to Cypher query execution layer for Neo4j. ",
+  "main": "./dist/index.js",
+  "scripts": {
+    "start": "nodemon ./example/graphql-tools/movies.js --exec babel-node -e js",
+    "build": "babel src --presets babel-preset-es2015 --out-dir dist",
+    "prepublish": "npm run build",
+    "test": "ava test/*.js"
+  },
+  "author": "William Lyon",
+  "license": "Apache 2.0",
+  "devDependencies": {
+    "ava": "^0.22.0",
+    "babel-cli": "^6.24.0",
+    "babel-plugin-transform-async-generator-functions": "^6.24.1",
+    "babel-plugin-transform-object-rest-spread": "^6.23.0",
+    "babel-plugin-transform-runtime": "^6.23.0",
+    "babel-preset-latest": "^6.23.0",
+    "nodemon": "^1.11.0"
+  },
+  "dependencies": {
+    "body-parser": "^1.17.1",
+    "express": "^4.15.2",
+    "graphql": "^0.11.3",
+    "graphql-server-core": "^1.1.0",
+    "graphql-server-express": "^0.6.0",
+    "graphql-tools": "^1.2.2",
+    "lodash": "^4.17.4",
+    "neo4j-driver": "^1.4.0"
+  }
+}