@platformatic/sql-graphql 0.43.1 → 0.45.0

package/index.d.ts

@@ -1,6 +1,7 @@
 import { FastifyPluginAsync } from 'fastify'
 import { GraphQLScalarType } from 'graphql'
 import { IResolverObject, IResolverOptions, MercuriusContext } from 'mercurius'
+import { FastifyError } from '@fastify/error'
 
 type IEnumResolver = {
   [key: string]: string | number | boolean
@@ -8,12 +9,12 @@ type IEnumResolver = {
 
 export interface IResolvers<TSource = any, TContext = MercuriusContext> {
   [key: string]:
-    | (() => any)
-    | IResolverObject<TSource, TContext>
-    | IResolverOptions<TSource, TContext>
-    | GraphQLScalarType
-    | IEnumResolver
-    | undefined
+  | (() => any)
+  | IResolverObject<TSource, TContext>
+  | IResolverOptions<TSource, TContext>
+  | GraphQLScalarType
+  | IEnumResolver
+  | undefined
 }
 
 export interface SQLGraphQLPluginOptions {
@@ -25,9 +26,9 @@ export interface SQLGraphQLPluginOptions {
    * Parameter that enables federation metadata support.
    */
   federationMetadata?: boolean,
-    /**
-   * Object with graphql resolver functions.
-   */
+  /**
+ * Object with graphql resolver functions.
+ */
   resolvers?: IResolvers,
   /*
    * The graphql schema.
@@ -37,3 +38,13 @@ export interface SQLGraphQLPluginOptions {
 
 declare const plugin: FastifyPluginAsync<SQLGraphQLPluginOptions>
 export default plugin
+
+/**
+ * All the errors thrown by the plugin.
+ */
+export module errors {
+  export const UnableToGenerateGraphQLEnumTypeError: () => FastifyError
+  export const UnsupportedKindError: (kind: string) => FastifyError
+  export const ErrorPrintingGraphQLSchema: () => FastifyError
+}
+

package/index.js

@@ -8,6 +8,7 @@ const { mercuriusFederationPlugin } = require('@mercuriusjs/federation')
 const establishRelations = require('./lib/relationship')
 const setupSubscriptions = require('./lib/subscriptions')
 const scalars = require('graphql-scalars')
+const errors = require('./lib/errors')
 
 async function mapperToGraphql (app, opts) {
   const mapper = app.platformatic
@@ -128,7 +129,7 @@ async function mapperToGraphql (app, opts) {
     /* istanbul ignore next */
     app.log.debug({ query, mutation, subscription }, 'GraphQL input schema')
     /* istanbul ignore next */
-    const newError = new Error('Error printing the GraphQL schema')
+    const newError = new errors.ErrorPrintingGraphQLSchema()
     /* istanbul ignore next */
     newError.cause = error
     /* istanbul ignore next */
@@ -173,3 +174,4 @@ async function mapperToGraphql (app, opts) {
 }
 
 module.exports = fp(mapperToGraphql)
+module.exports.errors = errors

package/lib/entity-to-type.js

@@ -6,6 +6,7 @@ const {
   sqlTypeToGraphQL,
   fromSelectionSet
 } = require('./utils')
+const errors = require('./errors')
 
 const ascDesc = new graphql.GraphQLEnumType({
   name: 'OrderByDirection',
@@ -73,7 +74,7 @@ function constructGraph (app, entity, opts, ignore) {
         meta.type = new graphql.GraphQLEnumType({ name, values: enumValues })
       } catch (error) {
         app.log.error({ key, enumValues, entityName, table: entity.table, schema: entity.schema })
-        throw new Error('Unable to generate GraphQLEnumType')
+        throw new errors.UnableToGenerateGraphQLEnumTypeError()
       }
     } else {
       meta.type = sqlTypeToGraphQL(field.sqlType)

package/lib/errors.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const createError = require('@fastify/error')
+
+const ERROR_PREFIX = 'PLT_SQL_GRAPHQL'
+
+module.exports = {
+  UnableToGenerateGraphQLEnumTypeError: createError(`${ERROR_PREFIX}_UNABLE_GENERATE_GRAPHQL_ENUM_TYPE`, 'Unable to generate GraphQLEnumType'),
+  UnsupportedKindError: createError(`${ERROR_PREFIX}_UNSUPPORTED_KIND`, 'Unsupported kind: %s'),
+  ErrorPrintingGraphQLSchema: createError(`${ERROR_PREFIX}_ERROR_PRINTING_GRAPHQL_SCHEMA`, 'Error printing the GraphQL schema')
+}

package/lib/utils.js

@@ -3,6 +3,7 @@
 const graphql = require('graphql')
 const scalars = require('graphql-scalars')
 const { GraphQLJSONObject } = require('graphql-type-json')
+const errors = require('./errors')
 
 // The sqlTypeToGraphQL is shared between
 // all database adapters.
@@ -71,7 +72,7 @@ function fromSelectionSet (selectionSet, fields = new Set()) {
     } else if (s.kind === 'InlineFragment') {
       fromSelectionSet(s.selectionSet, fields)
     } else {
-      throw new Error('Unsupported kind: ' + s.kind)
+      throw new errors.UnsupportedKindError(s.kind)
     }
   }
   return fields

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-graphql",
-  "version": "0.43.1",
+  "version": "0.45.0",
   "description": "Map SQL dbs to GraphQL",
   "main": "index.js",
   "types": "index.d.ts",
@@ -22,10 +22,11 @@
     "tap": "^16.3.6",
     "tsd": "^0.29.0",
     "ws": "^8.13.0",
-    "@platformatic/sql-events": "0.43.1",
-    "@platformatic/sql-mapper": "0.43.1"
+    "@platformatic/sql-events": "0.45.0",
+    "@platformatic/sql-mapper": "0.45.0"
   },
   "dependencies": {
+    "@fastify/error": "^3.2.1",
     "@mercuriusjs/federation": "^2.0.0",
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.0",

package/test/types/errors.test-d.ts

@@ -0,0 +1,15 @@
+import { expectType } from 'tsd'
+import { FastifyError } from '@fastify/error'
+import {
+  errors
+} from '../../index'
+
+// Errors
+type ErrorWithNoParams = () => FastifyError
+type ErrorWithOneParam = (param: string) => FastifyError
+
+expectType<ErrorWithNoParams>(errors.UnableToGenerateGraphQLEnumTypeError)
+expectType<ErrorWithOneParam>(errors.UnsupportedKindError)
+expectType<ErrorWithNoParams>(errors.ErrorPrintingGraphQLSchema)
+
+