perfect-payload 1.8.0-beta.0 → 2.0.0-beta.1

package/dist/types/errors.d.ts

@@ -0,0 +1,5 @@
+export interface ValidationError {
+    path: string;
+    code: string;
+    message: string;
+}

package/dist/types/errors.js

@@ -0,0 +1 @@
+export {};

package/dist/types/framework.d.ts

@@ -0,0 +1,26 @@
+import type { ValidationRules } from "./rules.js";
+import type { PerfectPayloadOptions } from "./options.js";
+import type { ValidationError } from "./errors.js";
+export type RequestSource = "headers" | "params" | "query" | "body";
+export type FrameworkRule = Partial<Record<RequestSource, ValidationRules>>;
+export type FrameworkData = Partial<Record<RequestSource, Record<string, unknown>>>;
+export interface FrameworkConfig {
+    rule?: FrameworkRule;
+    options?: PerfectPayloadOptions;
+}
+export interface FrameworkValidationInput extends FrameworkConfig {
+    data?: FrameworkData;
+}
+export type FrameworkValidatedPayload = Partial<Record<RequestSource, Record<string, unknown>>>;
+export interface FrameworkValidationSuccess {
+    valid: true;
+    validatedPayload: FrameworkValidatedPayload;
+}
+export interface FrameworkValidationFailure {
+    statusCode?: number;
+    valid: false;
+    message?: string;
+    errors: Array<string | ValidationError>;
+    [key: string]: unknown;
+}
+export type FrameworkValidationResult = FrameworkValidationSuccess | FrameworkValidationFailure;

package/dist/types/framework.js

@@ -0,0 +1 @@
+export {};

package/dist/types/options.d.ts

@@ -0,0 +1,14 @@
+import type { InvalidPayloadResponse, ValidPayloadResponse } from "./results.js";
+export type UnknownFieldsMode = "strip" | "allow" | "reject";
+export interface PerfectPayloadOptions {
+    unknownFields?: UnknownFieldsMode;
+    prettyErrors?: boolean;
+    validPayloadResponse?: ValidPayloadResponse;
+    inValidPayloadResponse?: InvalidPayloadResponse;
+}
+export interface StructuredErrorOptions extends PerfectPayloadOptions {
+    prettyErrors?: false;
+}
+export interface PrettyErrorOptions extends PerfectPayloadOptions {
+    prettyErrors: true;
+}

package/dist/types/options.js

@@ -0,0 +1 @@
+export {};

package/dist/types/results.d.ts

@@ -0,0 +1,19 @@
+import type { ValidationError } from "./errors.js";
+export interface ValidPayloadResponse {
+    statusCode: number;
+    valid: true;
+    [key: string]: unknown;
+}
+export interface InvalidPayloadResponse {
+    statusCode: number;
+    valid: false;
+    message: string;
+    [key: string]: unknown;
+}
+export interface ValidationSuccess<T = Record<string, unknown>> extends ValidPayloadResponse {
+    validatedPayload: T;
+}
+export interface ValidationFailure<E = ValidationError> extends InvalidPayloadResponse {
+    errors: E[];
+}
+export type ValidationResult<T = Record<string, unknown>, E = ValidationError> = ValidationSuccess<T> | ValidationFailure<E>;

package/dist/types/results.js

@@ -0,0 +1 @@
+export {};

package/dist/types/rules.d.ts

@@ -0,0 +1,49 @@
+export type ValidationValueType = "number" | "string" | "boolean" | "email" | "url" | "enum" | "uuid" | "uuidv1" | "uuidv3" | "uuidv4" | "uuidv5" | "objectId" | "array" | "object";
+export type TransformFunction = (value: unknown, payload: Record<string, unknown>) => unknown;
+export type CustomValidator = (value: unknown, payload: Record<string, unknown>) => boolean | Promise<boolean>;
+export interface DependencyRule {
+    setDependencyRule: (value: unknown, dependencyValue: unknown) => AttributeValidationRules;
+}
+export type DependencyRules = Record<string, DependencyRule>;
+export interface AttributeValidationRules {
+    mandatory?: boolean;
+    allowNull?: boolean;
+    allowEmptyObject?: boolean;
+    allowEmptyArray?: boolean;
+    type?: ValidationValueType;
+    enumValues?: unknown[];
+    path?: string;
+    mandatoryError?: string;
+    allowNullError?: string;
+    emptyObjectError?: string;
+    emptyArrayError?: string;
+    elementConstraintsError?: string;
+    regexError?: string;
+    typeError?: string;
+    minLengthError?: string;
+    maxLengthError?: string;
+    preventDecimalError?: string;
+    minError?: string;
+    maxError?: string;
+    rangeError?: string;
+    customValidatorError?: string;
+    customValidatorCode?: string;
+    minLength?: number;
+    maxLength?: number;
+    min?: number;
+    max?: number;
+    range?: string;
+    preventDecimal?: boolean;
+    minItems?: number;
+    maxItems?: number;
+    regex?: RegExp;
+    objectAttr?: ValidationRules;
+    elementConstraints?: AttributeValidationRules;
+    dependency?: DependencyRules;
+    customValidator?: CustomValidator;
+    transform?: TransformFunction;
+    trim?: boolean;
+    lowercase?: boolean;
+    uppercase?: boolean;
+}
+export type ValidationRules = Record<string, AttributeValidationRules>;

package/dist/types/rules.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,22 +1,31 @@
 {
   "name": "perfect-payload",
-  "version": "1.8.0-beta.0",
+  "version": "2.0.0-beta.1",
   "type": "module",
   "description": "Lightweight JSON payload validation library with structured errors, nested validation, field paths, and customizable validation rules.",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./index.js",
-    "./express": "./express.js",
-    "./fastify": "./fastify.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./express": {
+      "types": "./dist/express.d.ts",
+      "import": "./dist/express.js"
+    },
+    "./fastify": {
+      "types": "./dist/fastify.d.ts",
+      "import": "./dist/fastify.js"
+    }
   },
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc",
+    "test:types": "tsc type-test.ts --noEmit --strict --module NodeNext --moduleResolution NodeNext --target ES2022 --ignoreConfig --skipLibCheck"
   },
   "files": [
-    "index.js",
-    "framework.js",
-    "express.js",
-    "fastify.js"
+    "dist"
   ],
   "jest": {
     "testPathIgnorePatterns": [
@@ -56,7 +65,12 @@
   "devDependencies": {
     "@babel/core": "^7.25.2",
     "@babel/preset-env": "^7.25.4",
+    "@types/express": "^5.0.6",
+    "@types/node": "^26.6.2",
     "babel-jest": "^29.7.0",
-    "jest": "^29.7.0"
+    "express": "^5.2.1",
+    "fastify": "^5.12.5",
+    "jest": "^29.7.0",
+    "typescript": "^7.0.2"
   }
 }

package/express.js

@@ -1,75 +0,0 @@
-import {
-  validateFrameworkConfig,
-  validateFrameworkSources,
-  validateFrameworkSourcesAsync,
-} from "./framework.js";
-
-export function validatePayload(config = {}) {
-  const { rule, options = {} } = config;
-
-  // Validate developer configuration when middleware is created,
-  // not on every incoming request.
-  validateFrameworkConfig({
-    rule,
-    options,
-  });
-
-  return function perfectPayloadExpressMiddleware(req, res, next) {
-    try {
-      const result = validateFrameworkSources({
-        data: {
-          headers: req.headers,
-          params: req.params,
-          query: req.query,
-          body: req.body,
-        },
-        rule,
-        options,
-      });
-
-      if (result.valid === true) {
-        req.validatedPayload = result.validatedPayload;
-        return next();
-      }
-
-      return res.status(result.statusCode ?? 400).json(result);
-    } catch (error) {
-      return next(error);
-    }
-  };
-}
-
-export function validatePayloadAsync(config = {}) {
-  const { rule, options = {} } = config;
-
-  // Validate developer configuration when middleware is created,
-  // not on every incoming request.
-  validateFrameworkConfig({
-    rule,
-    options,
-  });
-
-  return async function perfectPayloadExpressAsyncMiddleware(req, res, next) {
-    try {
-      const result = await validateFrameworkSourcesAsync({
-        data: {
-          headers: req.headers,
-          params: req.params,
-          query: req.query,
-          body: req.body,
-        },
-        rule,
-        options,
-      });
-
-      if (result.valid === true) {
-        req.validatedPayload = result.validatedPayload;
-        return next();
-      }
-
-      return res.status(result.statusCode ?? 400).json(result);
-    } catch (error) {
-      return next(error);
-    }
-  };
-}

package/fastify.js

@@ -1,67 +0,0 @@
-import {
-  validateFrameworkConfig,
-  validateFrameworkSources,
-  validateFrameworkSourcesAsync,
-} from "./framework.js";
-
-export function validatePayload(config = {}) {
-  const { rule, options = {} } = config;
-
-  // Validate developer configuration when the hook is created,
-  // not on every incoming request.
-  validateFrameworkConfig({
-    rule,
-    options,
-  });
-
-  return async function perfectPayloadFastifyHook(request, reply) {
-    const result = validateFrameworkSources({
-      data: {
-        headers: request.headers,
-        params: request.params,
-        query: request.query,
-        body: request.body,
-      },
-      rule,
-      options,
-    });
-
-    if (result.valid === true) {
-      request.validatedPayload = result.validatedPayload;
-      return;
-    }
-
-    return reply.code(result.statusCode ?? 400).send(result);
-  };
-}
-
-export function validatePayloadAsync(config = {}) {
-  const { rule, options = {} } = config;
-
-  // Validate developer configuration when the hook is created,
-  // not on every incoming request.
-  validateFrameworkConfig({
-    rule,
-    options,
-  });
-
-  return async function perfectPayloadFastifyAsyncHook(request, reply) {
-    const result = await validateFrameworkSourcesAsync({
-      data: {
-        headers: request.headers,
-        params: request.params,
-        query: request.query,
-        body: request.body,
-      },
-      rule,
-      options,
-    });
-
-    if (result.valid === true) {
-      request.validatedPayload = result.validatedPayload;
-      return;
-    }
-
-    return reply.code(result.statusCode ?? 400).send(result);
-  };
-}

package/framework.js

@@ -1,175 +0,0 @@
-import { perfectPayload, perfectPayloadAsync } from "./index.js";
-
-const SUPPORTED_REQUEST_SOURCES = ["headers", "params", "query", "body"];
-
-export function validateFrameworkConfig({ rule, options } = {}) {
-  if (!rule || typeof rule !== "object" || Array.isArray(rule)) {
-    throw new Error("perfect-payload:- framework rule must be an object");
-  }
-
-  const configuredSources = Object.keys(rule);
-
-  if (configuredSources.length === 0) {
-    throw new Error(
-      "perfect-payload:- framework rule must contain at least one request source",
-    );
-  }
-
-  for (const source of configuredSources) {
-    if (!SUPPORTED_REQUEST_SOURCES.includes(source)) {
-      throw new Error(`perfect-payload:- unsupported request source ${source}`);
-    }
-
-    const sourceRule = rule[source];
-
-    if (
-      !sourceRule ||
-      typeof sourceRule !== "object" ||
-      Array.isArray(sourceRule)
-    ) {
-      throw new Error(
-        `perfect-payload:- rule for request source ${source} must be an object`,
-      );
-    }
-  }
-
-  if (
-    options !== undefined &&
-    (options === null || typeof options !== "object" || Array.isArray(options))
-  ) {
-    throw new Error("perfect-payload:- framework options must be an object");
-  }
-
-  return SUPPORTED_REQUEST_SOURCES.filter((source) =>
-    Object.prototype.hasOwnProperty.call(rule, source),
-  );
-}
-
-export function validateFrameworkSources({
-  data = {},
-  rule,
-  options = {},
-} = {}) {
-  const configuredSources = validateFrameworkConfig({
-    rule,
-    options,
-  });
-
-  const validatedPayload = {};
-  const errors = [];
-
-  let invalidResponse = null;
-
-  for (const source of configuredSources) {
-    const sourceData =
-      data?.[source] !== undefined && data?.[source] !== null
-        ? data[source]
-        : {};
-
-    const result = perfectPayload(sourceData, rule[source], options);
-
-    if (result.valid === true) {
-      validatedPayload[source] = result.validatedPayload;
-      continue;
-    }
-
-    if (!invalidResponse) {
-      const { errors: _errors, ...response } = result;
-      invalidResponse = response;
-    }
-
-    for (const error of result.errors ?? []) {
-      if (typeof error === "string") {
-        errors.push(error);
-      } else {
-        errors.push({
-          ...error,
-          path: `${source}.${error.path}`,
-        });
-      }
-    }
-  }
-
-  if (errors.length > 0) {
-    return {
-      ...invalidResponse,
-      errors,
-    };
-  }
-
-  return {
-    valid: true,
-    validatedPayload,
-  };
-}
-
-export async function validateFrameworkSourcesAsync({
-  data = {},
-  rule,
-  options = {},
-} = {}) {
-  const configuredSources = validateFrameworkConfig({
-    rule,
-    options,
-  });
-
-  const results = await Promise.all(
-    configuredSources.map(async (source) => {
-      const sourceData =
-        data?.[source] !== undefined && data?.[source] !== null
-          ? data[source]
-          : {};
-
-      const result = await perfectPayloadAsync(
-        sourceData,
-        rule[source],
-        options,
-      );
-
-      return {
-        source,
-        result,
-      };
-    }),
-  );
-
-  const validatedPayload = {};
-  const errors = [];
-
-  let invalidResponse = null;
-
-  for (const { source, result } of results) {
-    if (result.valid === true) {
-      validatedPayload[source] = result.validatedPayload;
-      continue;
-    }
-
-    if (!invalidResponse) {
-      const { errors: _errors, ...response } = result;
-      invalidResponse = response;
-    }
-
-    for (const error of result.errors ?? []) {
-      if (typeof error === "string") {
-        errors.push(error);
-      } else {
-        errors.push({
-          ...error,
-          path: `${source}.${error.path}`,
-        });
-      }
-    }
-  }
-
-  if (errors.length > 0) {
-    return {
-      ...invalidResponse,
-      errors,
-    };
-  }
-
-  return {
-    valid: true,
-    validatedPayload,
-  };
-}