Address validator-cfworker review feedback

Author: morgan-coded

CHANGELOG.md

@@ -16,6 +16,16 @@ should change the heading of the (upcoming) version to include a major version b
 
 -->
 
+# 6.8.0
+
+## @rjsf/validator-cfworker
+
+- Added an eval-free, draft-2020-12 validator package backed by `@cfworker/json-schema`, including undefined form-data normalization and per-schema-id caching, fixing [#3269](https://github.com/rjsf-team/react-jsonschema-form/issues/3269) and contributing to [#4923](https://github.com/rjsf-team/react-jsonschema-form/issues/4923)
+
+## Dev / docs / playground
+
+- Added `@rjsf/validator-cfworker` to the playground validator selector and API documentation
+
 # 6.7.1
 
 ## @rjsf/core
@@ -134,18 +144,13 @@ should change the heading of the (upcoming) version to include a major version b
 - Updated `transformRJSFValidationErrors()` to detect field name for `allOf` and `if-then-else` by falling back to the root schema to find the title, fixing [#5134](https://github.com/rjsf-team/react-jsonschema-form/issues/5134)
 - Updated the `ata-validator` dependency to `^1.0.0`, its first stable release; no API changes for `@rjsf/validator-ata` consumers ([#5157](https://github.com/rjsf-team/react-jsonschema-form/pull/5157))
 
-## @rjsf/validator-cfworker
-
-- Added an eval-free, draft-2020-12 validator package backed by `@cfworker/json-schema`, including undefined form-data normalization and per-schema-id caching, fixing [#3269](https://github.com/rjsf-team/react-jsonschema-form/issues/3269) and contributing to [#4923](https://github.com/rjsf-team/react-jsonschema-form/issues/4923)
-
 ## Dev / docs / playground
 
 - Updated `@rjsf/snapshots` to add a test case to `formTests` that verifies the new Cycle detection UI
 - Updated the `custom-templates.md` and `custom-widgets-fields.md` for the new feature
 - Updated `utility-functions.md` to document `logUnsupportedDefaultForEnum()`
 - Updated the playground to add a selector for the `nestedDefaultsPrecedence` option
 - Replaced npm with pnpm v10 for development
-- Added `@rjsf/validator-cfworker` to the playground validator selector and API documentation
 
 # 6.6.2
 

README.md

@@ -43,6 +43,7 @@
 - [@rjsf/utils](https://github.com/rjsf-team/react-jsonschema-form/tree/main/packages/utils)
 - [@rjsf/validator-ajv8](https://github.com/rjsf-team/react-jsonschema-form/tree/main/packages/validator-ajv8)
 - [@rjsf/validator-ata](https://github.com/rjsf-team/react-jsonschema-form/tree/main/packages/validator-ata)
+- [@rjsf/validator-cfworker](https://github.com/rjsf-team/react-jsonschema-form/tree/main/packages/validator-cfworker)
 
 ## Documentation
 

packages/playground/src/app.tsx

@@ -10,7 +10,7 @@ import { Theme as SuiTheme } from '@rjsf/semantic-ui';
 import { Theme as shadcnTheme } from '@rjsf/shadcn';
 import v8Validator, { customizeValidator } from '@rjsf/validator-ajv8';
 import ataValidator, { customizeValidator as customizeAtaValidator } from '@rjsf/validator-ata';
-import cfworkerValidator from '@rjsf/validator-cfworker';
+import cfworkerValidator, { customizeValidator as customizeCfworkerValidator } from '@rjsf/validator-cfworker';
 import localize_es from 'ajv-i18n/localize/es';
 import Ajv2019 from 'ajv/dist/2019.js';
 import Ajv2020 from 'ajv/dist/2020.js';
@@ -25,6 +25,8 @@ const AJV8_2020 = customizeValidator({ AjvClass: Ajv2020 });
 const AJV8_DISC = customizeValidator({ ajvOptionsOverrides: { discriminator: true } });
 const AJV8_DATA_REF = customizeValidator({ ajvOptionsOverrides: { $data: true } });
 const ataCoerce = customizeAtaValidator({ ataOptionsOverrides: { coerceTypes: true } });
+const cfworkerDraft7 = customizeCfworkerValidator({ draft: '7' });
+const cfworkerDraft2019 = customizeCfworkerValidator({ draft: '2019-09' });
 
 const validators: PlaygroundProps['validators'] = {
   AJV8: v8Validator,
@@ -35,6 +37,8 @@ const validators: PlaygroundProps['validators'] = {
   'AJV8 (2020)': AJV8_2020,
   ATA: ataValidator,
   'ATA (coerceTypes)': ataCoerce,
+  'CFWorker (Draft 7)': cfworkerDraft7,
+  'CFWorker (2019-09)': cfworkerDraft2019,
   'CFWorker (2020-12)': cfworkerValidator,
 };
 

packages/playground/tsconfig.json

@@ -67,6 +67,9 @@
     },
     {
       "path": "../validator-ata"
+    },
+    {
+      "path": "../validator-cfworker"
     }
   ]
 }

packages/playground/vite.config.ts

@@ -29,6 +29,7 @@ export default defineConfig({
       '@rjsf/utils': path.resolve(__dirname, '../utils/src'),
       '@rjsf/validator-ajv8': path.resolve(__dirname, '../validator-ajv8/src'),
       '@rjsf/validator-ata': path.resolve(__dirname, '../validator-ata/src'),
+      '@rjsf/validator-cfworker': path.resolve(__dirname, '../validator-cfworker/src'),
       '@rjsf/daisyui': path.resolve(__dirname, '../daisyui/src'),
     },
   },

packages/validator-cfworker/README.md

@@ -1,6 +1,7 @@
 # @rjsf/validator-cfworker
 
-`@rjsf/validator-cfworker` is an additional validator option for CSP-constrained RJSF users. It uses [`@cfworker/json-schema`](https://github.com/cfworker/cfworker/tree/main/packages/json-schema) to interpret schemas without `eval` or `new Function`, and defaults to JSON Schema draft 2020-12.
+`@rjsf/validator-cfworker` is an additional validator option for CSP-constrained RJSF users.
+It uses [`@cfworker/json-schema`](https://github.com/cfworker/cfworker/tree/main/packages/json-schema) to interpret schemas without `eval` or `new Function`, and defaults to JSON Schema draft 2020-12.
 
 It is not an AJV replacement. Choose it when an eval-free runtime is more important than AJV-specific keywords, extensions, localization, or code generation.
 

packages/validator-cfworker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/validator-cfworker",
-  "version": "6.6.2",
+  "version": "6.7.1",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",

packages/validator-cfworker/src/createCfworkerInstance.ts

@@ -5,15 +5,22 @@ import cloneDeep from 'lodash/cloneDeep';
 
 import type { CFWorkerFormatChecker, CustomValidatorOptionsType } from './types';
 
+/** Regular expression used to validate RJSF's `color` format. */
 export const COLOR_FORMAT_REGEX =
   /^(#?([0-9A-Fa-f]{3}){1,2}\b|aqua|black|blue|fuchsia|gray|green|lime|maroon|navy|olive|orange|purple|red|silver|teal|white|yellow|(rgb\(\s*\b([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\b\s*,\s*\b([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\b\s*,\s*\b([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\b\s*\))|(rgb\(\s*(\d?\d%|100%)+\s*,\s*(\d?\d%|100%)+\s*,\s*(\d?\d%|100%)+\s*\)))$/;
 
+/** Regular expression used to validate RJSF's `data-url` format. */
 export const DATA_URL_FORMAT_REGEX = /^data:([a-z]+\/[a-z0-9-+.]+)?;(?:name=(.*);)?base64,(.*)$/;
 
 interface FormatRegistryModule {
   format?: Record<string, CFWorkerFormatChecker>;
 }
 
+/** Converts a supported custom-format declaration into a format checker.
+ *
+ * @param spec - The custom-format function, regular expression, or regular-expression source
+ * @returns - A function that checks whether a string satisfies the format
+ */
 function asFormatChecker(spec: string | RegExp | CFWorkerFormatChecker): CFWorkerFormatChecker {
   if (typeof spec === 'function') {
     return spec;
@@ -22,6 +29,11 @@ function asFormatChecker(spec: string | RegExp | CFWorkerFormatChecker): CFWorke
   return (value: string) => regex.test(value);
 }
 
+/** Installs the built-in RJSF formats and any user-provided formats into the engine registry.
+ *
+ * @param customFormats - The custom formats to add after the built-in `color` and `data-url` formats
+ * @param [targetRegistry] - The format registry to update; defaults to the `@cfworker/json-schema` module registry
+ */
 export function installFormats(
   customFormats: CustomValidatorOptionsType['customFormats'],
   targetRegistry = (CFWorkerJsonSchema as unknown as FormatRegistryModule).format,
@@ -41,7 +53,13 @@ export function installFormats(
   }
 }
 
-/** Builds a schema-bound `@cfworker/json-schema` validator. */
+/** Builds a schema-bound `@cfworker/json-schema` validator.
+ *
+ * @param schema - The schema the validator will use
+ * @param [options={}] - The options used to configure formats, schemas, draft behavior, and engine extension
+ * @param [rootSchema] - The root schema to register for cross-schema `$ref` resolution
+ * @returns - The configured schema-bound validator
+ */
 export default function createCfworkerInstance(
   schema: Schema | boolean,
   options: CustomValidatorOptionsType = {},

packages/validator-cfworker/src/processRawValidationErrors.ts

@@ -28,20 +28,36 @@ export interface RawValidationErrorsType<Result = any> {
   validationError?: Error;
 }
 
+/** Converts a cfworker instance location into RJSF's dot-separated property path.
+ *
+ * @param instanceLocation - The instance location emitted by `@cfworker/json-schema`
+ * @returns - The corresponding RJSF property path
+ */
 function instanceLocationToProperty(instanceLocation: string): string {
   if (!instanceLocation || instanceLocation === '#') {
     return '';
   }
   return instanceLocation.replace(/^#?/, '').replace(/\//g, '.');
 }
 
+/** Extracts the missing property name from a cfworker `required` error.
+ *
+ * @param error - The cfworker validation error to inspect
+ * @returns - The missing property name when the error describes one
+ */
 function extractMissingProperty(error: CFWorkerValidationError): string | undefined {
   if (error.keyword !== 'required') {
     return undefined;
   }
   return error.error.match(/required property ["']([^"']+)["']/)?.[1];
 }
 
+/** Filters duplicate errors from `anyOf`/`oneOf` schema paths according to the `suppressDuplicateFiltering` flag.
+ *
+ * @param errorList - The list of RJSF validation errors to filter
+ * @param [suppressDuplicateFiltering='none'] - Controls which duplicate filtering is suppressed
+ * @returns - The filtered list of validation errors
+ */
 export function filterDuplicateErrors(
   errorList: RJSFValidationError[],
   suppressDuplicateFiltering: SuppressDuplicateFilteringType = 'none',
@@ -69,7 +85,14 @@ export function filterDuplicateErrors(
   }, []);
 }
 
-/** Converts `@cfworker/json-schema` output units into RJSF validation errors. */
+/** Converts `@cfworker/json-schema` output units into RJSF validation errors.
+ *
+ * @param errors - The cfworker errors to convert
+ * @param [uiSchema] - The uiSchema used to resolve field titles
+ * @param [suppressDuplicateFiltering] - Controls which duplicate filtering is suppressed
+ * @param [schema] - The schema used to resolve field titles
+ * @returns - The converted RJSF validation errors
+ */
 export function transformRJSFValidationErrors<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,
@@ -149,6 +172,18 @@ export function transformRJSFValidationErrors<
   return filterDuplicateErrors(errorList, suppressDuplicateFiltering);
 }
 
+/** Processes raw validation errors and applies optional error transforms and custom validation.
+ *
+ * @param validator - The validator used to derive default form state for custom validation
+ * @param rawErrors - The raw cfworker errors and any engine exception
+ * @param formData - The form data being validated
+ * @param schema - The schema against which the form data is validated
+ * @param [customValidate] - A function that adds application-specific validation errors
+ * @param [transformErrors] - A function that transforms errors before custom validation
+ * @param [uiSchema] - The uiSchema passed to error transformation and custom validation
+ * @param [suppressDuplicateFiltering] - Controls which duplicate filtering is suppressed
+ * @returns - The processed validation errors and error schema
+ */
 export default function processRawValidationErrors<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,

packages/validator-cfworker/src/types.ts

@@ -1,7 +1,9 @@
 import type { OutputUnit, Schema, SchemaDraft, Validator } from '@cfworker/json-schema';
 
+/** The type describing a function that checks whether a string satisfies a custom format */
 export type CFWorkerFormatChecker = (value: string) => boolean;
 
+/** The type describing the value for the `suppressDuplicateFiltering` option */
 export type SuppressDuplicateFilteringType = 'anyOf' | 'oneOf' | 'all' | 'none';
 
 /** Options for the `@cfworker/json-schema` backed validator. */