chore(next): throw error when deprecated modifyConfig option is passed to createHeadlessForm (#199)

* chore(next): throw error when deprecated modifyConfig option is passed to createHeadlessForm

* Update next/src/form.ts

Co-authored-by: Capelo <[email protected]>

* update test text

---------

Co-authored-by: Capelo <[email protected]>

Author: lukad

next/src/form.ts

@@ -242,10 +242,22 @@ function buildFields(params: { schema: JsfObjectSchema, originalSchema: JsfObjec
   return fields
 }
 
+/**
+ * Ensures that no forbidden options are given
+ * @param options - The options to validate
+ * @throws An error if any forbidden options are found
+ */
+function validateOptions(options: CreateHeadlessFormOptions) {
+  if (Object.prototype.hasOwnProperty.call(options, 'modifyConfig')) {
+    throw new Error('`modifyConfig` is a deprecated option and it\'s not supported on json-schema-form v1')
+  }
+}
+
 export function createHeadlessForm(
   schema: JsfObjectSchema,
   options: CreateHeadlessFormOptions = {},
 ): FormResult {
+  validateOptions(options)
   const initialValues = options.initialValues || {}
   const strictInputType = options.strictInputType || false
   // Make a new version of the schema with all the computed attrs applied, as well as the final version of each property (taking into account conditional rules)

next/test/form.test.ts

@@ -1,8 +1,40 @@
+import type { JsfObjectSchema } from '../src/types'
 import { describe, expect, it } from '@jest/globals'
 import { createHeadlessForm } from '../src'
 
 describe('createHeadlessForm', () => {
   it('should be a function', () => {
     expect(createHeadlessForm).toBeInstanceOf(Function)
   })
+
+  describe('options validation', () => {
+    const basicSchema: JsfObjectSchema = {
+      type: 'object',
+      properties: {
+        name: { type: 'string' },
+      },
+    }
+
+    it('should throw error when modifyConfig option is provided', () => {
+      expect(() => {
+        createHeadlessForm(basicSchema, { modifyConfig: {} } as any)
+      }).toThrow('`modifyConfig` is a deprecated option and it\'s not supported on json-schema-form v1')
+    })
+
+    it('should not throw error when modifyConfig option is not provided', () => {
+      expect(() => {
+        createHeadlessForm(basicSchema, {})
+      }).not.toThrow()
+    })
+
+    it('should not throw error when other valid options are provided', () => {
+      expect(() => {
+        createHeadlessForm(basicSchema, {
+          initialValues: { name: 'test' },
+          validationOptions: {},
+          strictInputType: true,
+        })
+      }).not.toThrow()
+    })
+  })
 })