Merge pull request #2 from Sako-K/main

[FIX] - Remove option, and make false on schema work

Author: agjs

README.md

@@ -43,15 +43,24 @@ fastify.register(enforceSchema, options);
 
 - **exclude**: Endpoints to exclude by the _routeOptions.path_. Each exclude is an object, with a `url` and optional, `excludeSchemas` array. If the `excludeSchemas` array is not passed, validation for all 3 schemas (`body`, `respone`, `params`) is disabled.
 
-- **excludeOnFalseSchema** - If your controllers aren't returning anything, make sure to set the `response` schema to false. And then, set `excludeOnFalseSchema` to `true`, so that this plugin doesn't return errors for any given controller that has a response schema set to false.
+### **Excluding specific schemas**
+
+To disable schema validation for all three types (response, body, and params), you can set { schema: false }. If you only want to disable the schema for a specific type, you can do so by setting the corresponding key to false. For example, to disable schema validation for the response, you can use { response: false }.
 
 ```js
 await fastify.register(enforceSchema, {
- required: ["response"],
- excludeOnFalseSchema: true,
+ required: ["response", "body", "params"],
 });
 
-fastify.get("/foo", { schema: { response: false } }, (req, reply) => {
+fastify.get("/foo", { schema: false }, (req, reply) => {
  reply.code(200);
 });
+
+fastify.get(
+ "/bar",
+ { schema: { response: false, body: false, params: false } },
+ (req, reply) => {
+ reply.code(200);
+ }
+);
 ```

index.js

@@ -1,137 +1,115 @@
-const fp = require("fastify-plugin");
+const fp = require('fastify-plugin')
 const {
  getErrrorMessage,
  hasProperties,
  initialExcludes,
  isSchemaTypeExcluded,
- SCHEMA_TYPES,
- isHTTPVerbExcluded,
-} = require("./utils");
+ SCHEMA_TYPES
+} = require('./utils')
 
-function FastifyEnforceSchema(fastify, opts, done) {
+function FastifyEnforceSchema (fastify, opts, done) {
  if (!opts) {
- opts = {};
+ opts = {}
  }
 
- if (!Object.prototype.hasOwnProperty.call(opts, "required")) {
- opts.required = [];
+ if (!Object.prototype.hasOwnProperty.call(opts, 'required')) {
+ opts.required = []
  }
 
- if (!Object.prototype.hasOwnProperty.call(opts, "exclude")) {
- opts.exclude = [];
+ if (!Object.prototype.hasOwnProperty.call(opts, 'exclude')) {
+ opts.exclude = []
  }
 
- if (!Object.prototype.hasOwnProperty.call(opts, 'excludeOnFalseSchema')) {
- opts.excludeOnFalseSchema = false;
- }
-
- const { required, exclude, excludeOnFalseSchema } = opts;
+ const { required, exclude } = opts
 
- fastify.addHook("onRoute", (routeOptions) => {
+ fastify.addHook('onRoute', (routeOptions) => {
  if (
- routeOptions.path === "*" ||
+ routeOptions.path === '*' ||
  !routeOptions.path ||
- (excludeOnFalseSchema && routeOptions.schema === false)
+ routeOptions.schema === false
  ) {
- done();
- return;
- }
-
- if (excludeOnFalseSchema && typeof routeOptions.schema === "object") {
- const excludedEntity = exclude.find(
- ({ url }) => url === routeOptions.path
- );
- const excludedSchemas = [];
-
- Object.entries(routeOptions.schema).forEach(([key, value]) => {
- if (value === false) {
- excludedSchemas.push(key);
- }
- });
-
- if (excludedEntity) {
- excludedEntity.excludedSchemas = [
- ...new Set([...excludedEntity.excludedSchemas, ...excludedSchemas]),
- ];
- } else {
- exclude.push({ url: routeOptions.path, excludedSchemas });
- }
+ done()
+ return
  }
 
  const excludedEntity = [...initialExcludes, ...exclude].find(
  ({ url }) => url === routeOptions.path
- );
+ )
 
  const hasSchemas =
- typeof excludedEntity === "object" &&
- Object.prototype.hasOwnProperty.call(excludedEntity, "excludedSchemas");
+ typeof excludedEntity === 'object' &&
+ Object.prototype.hasOwnProperty.call(excludedEntity, 'excludedSchemas')
 
  if (excludedEntity && !hasSchemas) {
- done();
- return;
+ done()
+ return
  }
 
  if (!routeOptions?.schema) {
  throw new Error(
  `schema missing at the path ${routeOptions.method}: "${routeOptions.path}"`
- );
+ )
  }
 
  if (
+ routeOptions?.schema?.response !== false &&
  !isSchemaTypeExcluded(excludedEntity, SCHEMA_TYPES.response) &&
  required.indexOf(SCHEMA_TYPES.response) !== -1
  ) {
- const schema = Object.keys(routeOptions?.schema?.response || []);
+ const schema = Object.keys(routeOptions?.schema?.response || [])
 
  if (!routeOptions?.schema?.response) {
- throw new Error(getErrrorMessage(SCHEMA_TYPES.response, routeOptions));
+ throw new Error(getErrrorMessage(SCHEMA_TYPES.response, routeOptions))
  }
 
  if (
  routeOptions?.schema?.response &&
  !Object.keys(routeOptions?.schema?.response || []).length
  ) {
- throw new Error(`No HTTP status codes provided in the response schema`);
+ throw new Error('No HTTP status codes provided in the response schema')
  }
 
- schema.forEach(value => {
+ schema.forEach((value) => {
  if (!Number.isInteger(parseInt(value, 10))) {
  throw new Error(
  `"${value}" is not a number. HTTP status codes from 100 - 599 supported`
- );
+ )
  }
 
  if (value < 100 || value > 599) {
- throw new Error(`HTTP status codes from 100 - 599 supported`);
+ throw new Error('HTTP status codes from 100 - 599 supported')
  }
- });
+ })
  }
  if (
+ routeOptions?.schema?.body !== false &&
  !isSchemaTypeExcluded(excludedEntity, SCHEMA_TYPES.body) &&
- ["POST", "PUT", "PATCH"].includes(routeOptions.method) &&
+ ['POST', 'PUT', 'PATCH'].includes(routeOptions.method) &&
  required.indexOf(SCHEMA_TYPES.body) !== -1 &&
  !hasProperties(routeOptions, SCHEMA_TYPES.body)
  ) {
- throw new Error(getErrrorMessage(SCHEMA_TYPES.body, routeOptions));
+ throw new Error(getErrrorMessage(SCHEMA_TYPES.body, routeOptions))
  }
 
  if (
+ routeOptions?.schema?.params !== false &&
+ new RegExp(/:\w+/).test(routeOptions.url) &&
  !isSchemaTypeExcluded(excludedEntity, SCHEMA_TYPES.params) &&
  required.indexOf(SCHEMA_TYPES.params) !== -1 &&
  !hasProperties(routeOptions, SCHEMA_TYPES.params)
  ) {
- throw new Error(getErrrorMessage(SCHEMA_TYPES.params, routeOptions));
+ throw new Error(getErrrorMessage(SCHEMA_TYPES.params, routeOptions))
  }
- });
+ })
 
- done();
+ done()
 }
 
 const _fastifyEnforceSchema = fp(FastifyEnforceSchema, {
- fastify: "4.x",
- name: "fastify-enforce-schema",
-});
+ fastify: '4.x',
+ name: 'fastify-enforce-schema'
+})
 
-module.exports = _fastifyEnforceSchema;
-module.exports.FastifyEnforceSchema = _fastifyEnforceSchema;
-module.exports.default = _fastifyEnforceSchema;
+module.exports = _fastifyEnforceSchema
+module.exports.FastifyEnforceSchema = _fastifyEnforceSchema
+module.exports.default = _fastifyEnforceSchema

package.json

@@ -2,7 +2,7 @@
  "name": "fastify-enforce-schema",
  "url": "",
  "author": "Aleksandar Grbic - (https://programmer.network)",
- "version": "1.0.6",
+ "version": "1.0.7",
  "description": "Enforce AJV schemas across your endpoints.",
  "repository": {
  "type": "git",
@@ -12,7 +12,7 @@
  "types": "index.d.ts",
  "scripts": {
  "coverage": "tap --cov --coverage-report=html test",
- "lint": "npm run lint:standard && npm run lint:typescript",
+ "lint": "npm run lint:standard",
  "lint:fix": "standard --fix",
  "lint:standard": "standard",
  "lint:typescript": "standard --parser @typescript-eslint/parser --plugin @typescript-eslint/eslint-plugin test/*.ts",