Merge pull request #1 from ltwlf/dev

arangorizeSchema

Author: ltwlf

.github/workflows/nodejs.yml

@@ -4,23 +4,22 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [10.x, 12.x]
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: npm install, build, and test
-      run: |
-        npm ci
-        npm run build --if-present
-        npm test
-      env:
-        CI: true
+      - uses: actions/checkout@v1
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: npm install, build, and test
+        run: |
+          npm ci
+          npm run build --if-present
+          npm test
+        env:
+          CI: true

README.md

@@ -99,18 +99,6 @@ You may also need to install peer dependencies if you don't have them:
 npm i --save graphql arangojs
 ```
 
-### Directive type definitions
-
-To use the directives in this library, you need to add type definitions for them. The library exports pre-built type definitions for all directives, you just need to include them in your type definitions.
-
-```ts
-import { directiveTypeDefs } from 'graphql-arangodb';
-
-const typeDefs = [directiveTypeDefs, ...allYourAppsOtherTypeDefs];
-
-makeExecutableSchema({ typeDefs });
-```
-
 ### Adding a Database instance
 
 The easiest way to connect `graphql-arangodb` to your ArangoDB database is to instantiate a `Database` class from `arangojs` and assign it to the `arangoDb` field of your GraphQL `context`:
@@ -129,6 +117,61 @@ const context = {
 // pass the context into your GraphQL server according to documentation of the server
 ```
 
+### Directive type definitions
+
+To use the directives in this library, you need to add type definitions for them. The library exports pre-built type definitions for all directives, you can either include them manually,
+
+```ts
+import { directiveTypeDefs } from 'graphql-arangodb';
+
+const typeDefs = [directiveTypeDefs, ...allYourAppsOtherTypeDefs];
+
+makeExecutableSchema({ typeDefs });
+```
+
+or you can use the arangorizeSchema generator. arangorizeSchema can additionaly automatically create document and edge collections and indexes:
+
+Schema example:
+
+```graphql
+type User @aqlCollection(name: "users" ) {
+  id: String! @aqlIndex(type: UNIQUE)
+  name: String!
+  friends: [FriendOfEdge!]!
+    @aqlEdge(
+      collection: "friendOf"
+      direction: ANY
+      sort: { property: "name", sortOn: "$field_node" }
+    )
+}
+
+@aqlCollection(name: "friendOf", type: EDGE )
+type FriendOfEdge {
+  strength: Int
+  user: User! @aqlEdgeNode
+}
+```
+
+```TS
+import { arangorizeSchema } from 'graphql-arangodb';
+
+const typeDefs = [...allYourAppsOtherTypeDefs];
+const resolvers = { ...allYourResolvers}
+
+await arangorizeSchema({ typeDefs, resolvers }, db );
+```
+
+As an optional, last parameter you can add a database name when you want to ensure a database exisits. If the database does not exists it will be created.
+
+```TS
+import { arangorizeSchema } from 'graphql-arangodb';
+
+const typeDefs = [...allYourAppsOtherTypeDefs];
+const resolvers = { ...allYourResolvers}
+
+await arangorizeSchema({ typeDefs, resolvers }, db, 'myAwesomeDB');
+```
+
 ### Resolvers
 
 To start resolving queries using AQL, you need to set up resolvers for fields which will be resolved using those queries. For most use cases, this means all of the top-level fields in the root query and mutation types.