feat(graphql): disable default mutations (#182)

Add an option to disable default mutations. Closes #170

All credit goes to @grncdr.

This introduces a new CLI flag & option: --disable-default-mutations

When default mutations are disabled, the only mutation operations available
will be those exposed by user defined functions.

* Use options objects all the way down

This seems more consistent with the rest of the codebase

* pass disableDefaultMutations option through BuildToken

* typo

* Update docs on library usage

* Add integration test for disableDefaultMutations

* Commit updated snapshots

* Revert "Commit updated snapshots"

This reverts commit 6db9086.

* add new schema snapshot

Author: calebmer

docs/library.md

@@ -44,6 +44,7 @@ Arguments include:
 - **`options`**: An object containing other miscellaneous options. Options could be:
   - `classicIds`: Enables classic ids for Relay 1 support. Instead of using the field name `__id` for globally unique ids, PostGraphQL will instead use the field name `id` for its globally unique ids. This means that table `id` columns will also get renamed to `rowId`.
   - `dynamicJson`: Setting this to `true` enables dynamic JSON which will allow you to use any JSON as input and get any arbitrary JSON as output. By default JSON types are just a JSON string.
+  - `disableDefaultMutations`: Setting this to `true` will prevent the creation of the default mutation types & fields. Database mutation will only be possible through Postgres functions.
   - `graphiql`: Set this to `true` to enable the GraphiQL interface.
   - `graphqlRoute`: The endpoint the GraphQL executer will listen on. Defaults to `/graphql`.
   - `graphiqlRoute`: The endpoint the GraphiQL query interface will listen on (**NOTE:** GraphiQL will not be enabled unless the `graphiql` option is set to `true`). Defaults to `/graphiql`.

src/graphql/schema/BuildToken.ts

@@ -27,6 +27,9 @@ interface BuildToken {
     // By default, JSON is output as a string in our GraphQL queries. If true
     // then JSON will be output as a dynamic object.
     readonly dynamicJson: boolean,
+    // If true then the default mutations for tables (e.g. createMyTable) will
+    // not be created
+    readonly disableDefaultMutations: boolean,
   },
   // Hooks for adding custom fields/types into our schema.
   readonly _hooks: _BuildTokenHooks,

src/graphql/schema/createGqlSchema.ts

@@ -12,6 +12,9 @@ export type SchemaOptions = {
   // If true then any literal will be accepted to this type and its output will
   // be plain JSON.
   dynamicJson?: boolean,
+  // If true then the default mutations for tables (e.g. createMyTable) will
+  // not be created
+  disableDefaultMutations?: boolean,
   // Some hooks to allow extension of the schema. Currently this API is
   // private. Use at your own risk.
   _hooks?: _BuildTokenHooks,
@@ -33,6 +36,7 @@ export default function createGqlSchema (inventory: Inventory, options: SchemaOp
     options: {
       nodeIdFieldName: options.nodeIdFieldName || '__id',
       dynamicJson: options.dynamicJson || false,
+      disableDefaultMutations: options.disableDefaultMutations || false,
     },
     _hooks: options._hooks || {},
     _typeOverrides: options._typeOverrides || new Map(),

src/graphql/schema/getMutationGqlType.ts

@@ -18,7 +18,7 @@ export default getMutationGqlType
  * @private
  */
 function createMutationGqlType (buildToken: BuildToken): GraphQLObjectType<mixed> | undefined {
-  const { inventory } = buildToken
+  const { inventory, options } = buildToken
 
   // A list of all the mutations we are able to run.
   const mutationFieldEntries: Array<[string, GraphQLFieldConfig<mixed, mixed>]> = [
@@ -29,12 +29,14 @@ function createMutationGqlType (buildToken: BuildToken): GraphQLObjectType<mixed
         : []
     ),
     ...(
-      // Get the mutations for all of our collections and creates mutations
-      // for them.
-      inventory
-        .getCollections()
-        .map(collection => createCollectionMutationFieldEntries(buildToken, collection))
-        .reduce((a, b) => a.concat(b), [])
+      options.disableDefaultMutations
+        ? []
+        : // Get the mutations for all of our collections and creates mutations
+          // for them.
+          inventory
+            .getCollections()
+            .map(collection => createCollectionMutationFieldEntries(buildToken, collection))
+            .reduce((a, b) => a.concat(b), [])
     ),
   ]