graphql-validity/src/validation.d.ts

Make business logic validation easy on the graphql side without adding any declarations or modifications to the existing graphql schema.

/*!
 * The MIT License (MIT)
 *
 * Copyright (c) 2017 Vlad Martynenko <vladimir.martynenko.work@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
export declare const FieldValidationDefinitions: any;
/**
 * Builds errors array, using validation results
 *
 * @param validity - an object injected to request at the beginning of the http call
 * @param data - result of graphql call
 */
export declare function getResponseValidationResults(validity: any, data: any): void;
/**
 * Returns lists of graphql validation messages arrays from request object
 *
 * @param request - express request object
 * @returns {validationResults: any[]} - list of validation result messages
 */
export declare function getValidationResults(validity: any): any;
/**
 * Return list of local and global validators
 *
 * @param field - field which will be validated
 * @param {string} parentTypeName - name of the parent object where field belongs to
 * @param validity - an object injected to request at the beginning of the http call
 *
 * @returns {validators: any[]}
 * - list of local and global validator functions
 */
export declare function getValidators(field: any, parentTypeName: string, validity: any): any;
/**
 * Modifies express response with validation results
 *
 * @param req - express request
 * @param data - response original data
 * @param profilingResultHandler - profiling function
 *
 * @returns {string} - response modified data
 */
export declare function applyValidation(req: any, data: any, profilingResultHandler: Function): string;