feat: send args to custom format function (#267)

fixes #266 

Co-authored-by: James Mortemore <[email protected]>

Author: avaly

index.d.ts

@@ -39,14 +39,24 @@ interface DocumentationOptions {
     };
 }
 
+interface StringArguments {
+    maxLength?: number;
+    minLength?: number;
+    startsWith?: string;
+    endWith?: string;
+    contains?: string;
+    notContains?: string;
+    pattern?: string;
+}
+
 interface PluginOptions {
-    formats: Record<string, (value: unknown) => boolean>;
+    formats: Record<string, (value: string, args?: StringArguments) => boolean>;
 }
 
 /**
  * Schema transformer which adds @constraint directives documentation to the fields and arguments descriptions.
  * Documentation not added if it already exists (`header` is present in the field or argument description)
- * 
+ *
  * @param options options to customize the documentation process
  */
 export function constraintDirectiveDocumentation (options: DocumentationOptions) : (schema: GraphQLSchema) => GraphQLSchema;
@@ -58,7 +68,7 @@ export const constraintDirectiveTypeDefs: string
 
 /**
  * Method for query validation based on the @constraint directives defined in the schema.
- * 
+ *
  * @param schema GraphQL schema to look for directives
  * @param query GraphQL query to validate
  * @param variables used in the query to validate

scalars/string.js

@@ -86,7 +86,7 @@ function validate (fieldName, args, value, options = {}) {
     }
 
     try {
-      formatter(value) // Will throw if invalid
+      formatter(value, args) // Will throw if invalid
     } catch (e) {
       throw new ValidationError(fieldName,
         e.message,

test/string.test.js

@@ -923,13 +923,13 @@ module.exports.test = function (setup, implType) {
           createBook(input: BookInput): Book
         }
         input BookInput {
-          title: String! @constraint(format: "test-format")
+          title: String! @constraint(minLength: 1, format: "test-format")
         }`
 
-            const testFormat = (value) => {
+            const testFormat = (value, args) => {
               if (value === 'this is a test value') return true
 
-              throw new GraphQLError('Must be in test format format')
+              throw new GraphQLError(`Must be in test format format and have a minimum length of ${args.minLength}`)
             }
 
             const pluginOptions = { formats: { 'test-format': testFormat } }
@@ -959,7 +959,7 @@ module.exports.test = function (setup, implType) {
 
             isStatusCodeError(statusCode, implType)
             strictEqual(body.errors[0].message,
-              'Variable "$input" got invalid value "a" at "input.title"' + valueByImplType(implType, '; Expected type "title_String_NotNull_format_test-format"') + '. Must be in test format format')
+              'Variable "$input" got invalid value "a" at "input.title"' + valueByImplType(implType, '; Expected type "title_String_NotNull_format_test-format"') + '. Must be in test format format and have a minimum length of 1')
           })
         })
       }