Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e41c15d
preserve the form data so when we update the additionalErrors the dat…
kchobantonov Aug 12, 2025
a6a21e3
Merge branch 'master' into preserve-edit-data
kchobantonov Aug 15, 2025
d5218b1
also update the schema and uischema when they depend on the data and …
kchobantonov Aug 23, 2025
0b979c0
properly generate schema in case when the data is not an object but s…
kchobantonov Aug 23, 2025
ebe262b
always return valid UISchemaElement, in case of empty schema this was…
kchobantonov Aug 24, 2025
51aa0bc
revert back the ability to return null from the generate but default …
kchobantonov Aug 24, 2025
b27ce7f
only for undefined use emtpy data for others the core can handle those
kchobantonov Sep 5, 2025
87bfaa6
Merge branch 'master' into preserve-edit-data
kchobantonov Sep 27, 2025
e413248
Merge branch 'master' into preserve-edit-data
kchobantonov Nov 7, 2025
7bde214
Merge branch 'master' into preserve-edit-data
kchobantonov Nov 10, 2025
6f736d2
Merge branch 'master' into preserve-edit-data
kchobantonov Nov 10, 2025
4803dec
Merge branch 'master' into preserve-edit-data
kchobantonov Dec 2, 2025
22b4016
Merge branch 'master' into preserve-edit-data
kchobantonov Dec 16, 2025
fd04fe0
Merge branch 'master' into preserve-edit-data
kchobantonov Jan 23, 2026
d9de6ab
Merge branch 'master' into preserve-edit-data
kchobantonov Feb 15, 2026
63f16bf
Merge branch 'master' into preserve-edit-data
kchobantonov Mar 1, 2026
972c194
Merge branch 'master' into preserve-edit-data
kchobantonov Mar 27, 2026
8353196
Merge branch 'master' into preserve-edit-data
kchobantonov Apr 19, 2026
aa5b3c4
add test case for schema generation for primitive types
kchobantonov Apr 19, 2026
4af7884
preserve undefined Vue form data and type primitive schema generation
kchobantonov Apr 19, 2026
66e5c00
avoid regenerating Vue schemas when parent echoes unchanged form shape
kchobantonov Apr 19, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/core/src/generators/Generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ import { generateJsonSchema } from './schema';
import { createControlElement, generateDefaultUISchema } from './uischema';

export const Generate: {
// TODO fix @typescript-eslint/ban-types
// eslint-disable-next-line @typescript-eslint/ban-types
jsonSchema(instance: Object, options?: any): JsonSchema;
jsonSchema(instance: unknown, options?: any): JsonSchema;
uiSchema(
jsonSchema: JsonSchema,
layoutType?: string,
Expand Down
12 changes: 4 additions & 8 deletions packages/core/src/generators/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,7 @@ class Gen {
private findOption: (props: Properties) => (optionName: string) => any
) {}

// TODO fix @typescript-eslint/ban-types
// eslint-disable-next-line @typescript-eslint/ban-types
schemaObject = (data: Object): JsonSchema4 => {
schemaObject = (data: Record<string, any>): JsonSchema4 => {
const props: Properties = this.properties(data);
const schema: JsonSchema4 = {
type: 'object',
Expand Down Expand Up @@ -140,14 +138,12 @@ class Gen {

/**
* Generate a JSON schema based on the given data and any additional options.
* @param {Object} instance the data to create a JSON schema for
* @param {unknown} instance the data to create a JSON schema for
* @param {any} options any additional options that may alter the generated JSON schema
* @returns {JsonSchema} the generated schema
*/
export const generateJsonSchema = (
// TODO fix @typescript-eslint/ban-types
// eslint-disable-next-line @typescript-eslint/ban-types
instance: Object,
instance: unknown,
options: any = {}
): JsonSchema4 => {
const findOption =
Expand Down Expand Up @@ -177,5 +173,5 @@ export const generateJsonSchema = (

const gen = new Gen(findOption);

return gen.schemaObject(instance);
return gen.property(instance);
Comment thread
kchobantonov marked this conversation as resolved.
};
31 changes: 31 additions & 0 deletions packages/core/test/generators/schema.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,37 @@ import test from 'ava';

import { generateJsonSchema } from '../../src/generators/schema';

test('default schema generation root primitive types', (t) => {
t.deepEqual(generateJsonSchema('hello'), {
type: 'string',
});
t.deepEqual(generateJsonSchema(42), {
type: 'integer',
});
t.deepEqual(generateJsonSchema(3.14), {
type: 'number',
});
t.deepEqual(generateJsonSchema(true), {
type: 'boolean',
});
t.deepEqual(generateJsonSchema(null), {
type: 'null',
});
});

test('default schema generation root array types', (t) => {
t.deepEqual(generateJsonSchema([]), {
type: 'array',
items: {},
});
t.deepEqual(generateJsonSchema([1, 2]), {
type: 'array',
items: {
type: 'integer',
},
});
});

test('default schema generation basic types', (t) => {
const instance: any = {
boolean: false,
Expand Down
1 change: 0 additions & 1 deletion packages/vue-vuetify/dev/views/ExampleView.vue
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ const onChange = (event: JsonFormsChangeEvent): void => {
monaco.Uri.parse(toDataUri(props.example.name)),
event.data !== undefined ? JSON.stringify(event.data, null, 2) : '',
);
state.data = event.data;
Comment thread
kchobantonov marked this conversation as resolved.
}
errors.value = event.errors;
};
Expand Down
61 changes: 34 additions & 27 deletions packages/vue/src/components/JsonForms.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

<script lang="ts">
import { PropType, reactive, defineComponent } from 'vue';
import isEqual from 'lodash/isEqual';
import {
coreReducer,
Actions,
Expand All @@ -26,21 +27,26 @@ import {
defaultMiddleware,
Middleware,
JsonFormsSubStates,
Layout,
} from '@jsonforms/core';
import { JsonFormsChangeEvent, MaybeReadonly } from '../types';
import DispatchRenderer from './DispatchRenderer.vue';

import type Ajv from 'ajv';
import type { ErrorObject } from 'ajv';

// TODO fix @typescript-eslint/ban-types
// eslint-disable-next-line @typescript-eslint/ban-types
const isObject = (elem: any): elem is Object => {
return elem && typeof elem === 'object';
};

const EMPTY: ErrorObject[] = reactive([]);

const createDefaultLayout = (): Layout => ({
type: 'VerticalLayout',
elements: [],
});
const getSchemaGeneratorInput = (data: any) =>
data === undefined ? {} : data;
const generateUISchema = (schema: JsonSchema) =>
Generate.uiSchema(schema, undefined, undefined, schema) ??
createDefaultLayout();
Comment thread
kchobantonov marked this conversation as resolved.

export default defineComponent({
name: 'JsonForms',
components: {
Expand Down Expand Up @@ -124,12 +130,9 @@ export default defineComponent({
emits: ['change'],
data() {
const dataToUse = this.data;
const generatorData = isObject(dataToUse) ? dataToUse : {};
const schemaToUse: JsonSchema =
this.schema ?? Generate.jsonSchema(generatorData);
const uischemaToUse =
this.uischema ??
Generate.uiSchema(schemaToUse, undefined, undefined, schemaToUse);
this.schema ?? Generate.jsonSchema(getSchemaGeneratorInput(dataToUse));
const uischemaToUse = this.uischema ?? generateUISchema(schemaToUse);
const initCore = (): JsonFormsCore => {
const initialCore = {
data: dataToUse,
Expand Down Expand Up @@ -189,29 +192,30 @@ export default defineComponent({
},
watch: {
schema(newSchema) {
const generatorData = isObject(this.data) ? this.data : {};
this.schemaToUse = newSchema ?? Generate.jsonSchema(generatorData);
this.schemaToUse =
newSchema ?? Generate.jsonSchema(getSchemaGeneratorInput(this.dataToUse));
if (!this.uischema) {
this.uischemaToUse = Generate.uiSchema(
this.schemaToUse,
undefined,
undefined,
this.schemaToUse
);
this.uischemaToUse = generateUISchema(this.schemaToUse);
}
},
uischema(newUischema) {
this.uischemaToUse =
newUischema ??
Generate.uiSchema(
this.schemaToUse,
undefined,
undefined,
this.schemaToUse
);
this.uischemaToUse = newUischema ?? generateUISchema(this.schemaToUse);
},
data(newData) {
const isSameAsCurrentData = newData === this.dataToUse;
this.dataToUse = newData;

if (!this.schema && !isSameAsCurrentData) {
const nextSchema = Generate.jsonSchema(
getSchemaGeneratorInput(this.dataToUse)
);
if (!isEqual(nextSchema, this.schemaToUse)) {
this.schemaToUse = nextSchema;
if (!this.uischema) {
this.uischemaToUse = generateUISchema(this.schemaToUse);
}
}
}
},
renderers(newRenderers) {
this.jsonforms.renderers = newRenderers;
Expand Down Expand Up @@ -251,6 +255,9 @@ export default defineComponent({
);
},
eventToEmit(newEvent) {
// update the data so if we change the additionalErrors this won't reset the form data
this.dataToUse = newEvent.data;

this.$emit('change', newEvent);
},
i18n: {
Expand Down
133 changes: 132 additions & 1 deletion packages/vue/tests/unit/JsonForms.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { JsonFormsUISchemaRegistryEntry, Generate } from '@jsonforms/core';
import {
Actions,
JsonFormsUISchemaRegistryEntry,
Generate,
} from '@jsonforms/core';
import { shallowMount } from '@vue/test-utils';
import { nextTick } from 'vue';
import { JsonForms } from '../../src';
import { bindings } from '../testHelper';

Expand Down Expand Up @@ -30,6 +35,20 @@ describe('JsonForms.vue', () => {
);
});

it('generates schema for primitive root data', () => {
const data = 5.5;
const renderers: JsonFormsUISchemaRegistryEntry[] = [];
const wrapper = shallowMount(
JsonForms,
bindings({
props: { data, renderers },
})
);
expect((wrapper.vm as any).jsonforms.core.schema).toEqual(
Generate.jsonSchema(data)
);
});

it('generates ui schema when not given via prop', () => {
const data = { number: 5.5 };
const schema = {
Expand All @@ -47,4 +66,116 @@ describe('JsonForms.vue', () => {
Generate.uiSchema(schema)
);
});

it('preserves undefined root data when the data prop is cleared', async () => {
const data = { number: 5.5 };
const renderers: JsonFormsUISchemaRegistryEntry[] = [];
const wrapper = shallowMount(
JsonForms,
bindings({
props: { data, renderers },
})
);

await wrapper.setProps({ data: undefined });

expect((wrapper.vm as any).jsonforms.core.data).toBeUndefined();

const changeEvents = wrapper.emitted('change');
const latestChangeEvent: any = changeEvents?.[changeEvents.length - 1]?.[0];
expect(latestChangeEvent?.data).toBeUndefined();
});

it('preserves edited data when additionalErrors change', async () => {
const data = { number: 5.5 };
const renderers: JsonFormsUISchemaRegistryEntry[] = [];
const wrapper = shallowMount(
JsonForms,
bindings({
props: { data, renderers },
})
);

(wrapper.vm as any).dispatch(Actions.update('number', () => 6));
await nextTick();

await wrapper.setProps({
additionalErrors: [
{
instancePath: '/number',
schemaPath: '#/properties/number/minimum',
keyword: 'minimum',
params: { comparison: '>=', limit: 7 },
},
],
});

expect((wrapper.vm as any).jsonforms.core.data).toEqual({ number: 6 });
});

it('does not regenerate schema and uischema when the parent passes back the current form data', async () => {
const data = { number: 5.5 };
const renderers: JsonFormsUISchemaRegistryEntry[] = [];
const wrapper = shallowMount(
JsonForms,
bindings({
props: { data, renderers },
})
);

const initialSchema = (wrapper.vm as any).schemaToUse;
const initialUiSchema = (wrapper.vm as any).uischemaToUse;

(wrapper.vm as any).dispatch(Actions.update('number', () => 6));
await nextTick();

await wrapper.setProps({
data: (wrapper.vm as any).jsonforms.core.data,
});

expect((wrapper.vm as any).schemaToUse).toBe(initialSchema);
expect((wrapper.vm as any).uischemaToUse).toBe(initialUiSchema);
});

it('regenerates schema and uischema for external data changes', async () => {
const data = { number: 5.5 };
const nextData = { number: 5.5, text: 'hello' };
const renderers: JsonFormsUISchemaRegistryEntry[] = [];
const wrapper = shallowMount(
JsonForms,
bindings({
props: { data, renderers },
})
);

const initialSchema = (wrapper.vm as any).schemaToUse;
const initialUiSchema = (wrapper.vm as any).uischemaToUse;

await wrapper.setProps({ data: nextData });

expect((wrapper.vm as any).schemaToUse).not.toBe(initialSchema);
expect((wrapper.vm as any).uischemaToUse).not.toBe(initialUiSchema);
expect((wrapper.vm as any).jsonforms.core.schema).toEqual(
Generate.jsonSchema(nextData)
);
});

it('does not regenerate schema and uischema when external data keeps the same schema', async () => {
const data = 'hello';
const renderers: JsonFormsUISchemaRegistryEntry[] = [];
const wrapper = shallowMount(
JsonForms,
bindings({
props: { data, renderers },
})
);

const initialSchema = (wrapper.vm as any).schemaToUse;
const initialUiSchema = (wrapper.vm as any).uischemaToUse;

await wrapper.setProps({ data: 'world' });

expect((wrapper.vm as any).schemaToUse).toBe(initialSchema);
expect((wrapper.vm as any).uischemaToUse).toBe(initialUiSchema);
});
});