[Feature] Dynamic additional information rendering in frontend (#282)

This implements a version of #274, relying on Pydantics built in JSON schema and JSON rendering.
Requires additional UI tagging in the ai model repo but will remove HTML tags.

Example scenario with filled information: 5882df9c-dae1-4d80-a40e-db4724271456/scenario/3a4d395a-6a6d-4154-8ce3-ced667fceec0

Reviewed-on: enviPath/enviPy#282
Co-authored-by: Tobias O <tobias.olenyi@envipath.com>
Co-committed-by: Tobias O <tobias.olenyi@envipath.com>
This commit is contained in:
2026-01-31 00:44:03 +13:00
committed by jebus
parent 9f63a9d4de
commit d80dfb5ee3
42 changed files with 3732 additions and 609 deletions

View File

@ -4,17 +4,152 @@
id="new_scenario_modal"
class="modal"
x-data="{
...modalForm(),
isSubmitting: false,
error: null,
scenarioType: 'empty',
schemas: {},
groupSchemas: {},
loadingSchemas: false,
formData: {
name: '',
description: '',
dateYear: '',
dateMonth: '',
dateDay: '',
scenarioType: 'empty',
additionalInformation: {}
},
// Track form data from each schema renderer
schemaFormData: {},
validateYear(el) {
if (el.value && el.value.length < 4) {
el.value = new Date().getFullYear();
}
},
async init() {
try {
this.loadingSchemas = true;
// Ensure API client is available
if (!window.AdditionalInformationApi) {
throw new Error('Additional Information API client not loaded. Please refresh the page.');
}
// Use single API call to load schemas organized by groups
const { schemas, groupSchemas } =
await window.AdditionalInformationApi.loadSchemasWithGroups(['soil', 'sludge', 'sediment']);
this.schemas = schemas;
this.groupSchemas = groupSchemas;
} catch (err) {
this.error = err.message;
console.error('Error loading schemas:', err);
} finally {
this.loadingSchemas = false;
}
},
reset() {
this.isSubmitting = false;
this.error = null;
this.scenarioType = 'empty';
this.formData = {
name: '',
description: '',
dateYear: '',
dateMonth: '',
dateDay: '',
scenarioType: 'empty',
additionalInformation: {}
};
this.schemaFormData = {};
},
setSchemaFormData(schemaName, data) {
this.schemaFormData[schemaName] = data;
},
async submit() {
if (!this.formData.name || this.formData.name.trim() === '') {
this.error = 'Please enter a scenario name';
return;
}
this.isSubmitting = true;
this.error = null;
try {
// Build scenario date
let scenarioDate = this.formData.dateYear || '';
if (this.formData.dateMonth && this.formData.dateMonth.trim() !== '') {
scenarioDate += `-${parseInt(this.formData.dateMonth).toString().padStart(2, '0')}`;
if (this.formData.dateDay && this.formData.dateDay.trim() !== '') {
scenarioDate += `-${parseInt(this.formData.dateDay).toString().padStart(2, '0')}`;
}
}
if (!scenarioDate || scenarioDate.trim() === '') {
scenarioDate = 'No date';
}
// Collect additional information from schema forms
const additionalInformation = [];
const currentGroupSchemas = this.groupSchemas[this.scenarioType] || {};
for (const schemaName in this.schemaFormData) {
const data = this.schemaFormData[schemaName];
// Only include if schema belongs to current group and has data
if (currentGroupSchemas[schemaName] && data && Object.keys(data).length > 0) {
// Check if data has any non-null/non-empty values
const hasData = Object.values(data).some(val => {
if (val === null || val === undefined || val === '') return false;
if (typeof val === 'object' && val !== null) {
// For interval objects, check if start or end has value
if (val.start !== null && val.start !== undefined && val.start !== '') return true;
if (val.end !== null && val.end !== undefined && val.end !== '') return true;
return false;
}
return true;
});
if (hasData) {
additionalInformation.push({
type: schemaName,
data: data
});
}
}
}
// Build payload
const payload = {
name: this.formData.name.trim(),
description: this.formData.description ? this.formData.description.trim() : '',
scenario_date: scenarioDate,
scenario_type: this.scenarioType === 'empty' ? 'Not specified' : this.scenarioType,
additional_information: additionalInformation
};
const packageUuid = '{{ meta.current_package.uuid }}';
// Use API client for scenario creation
const result = await window.AdditionalInformationApi.createScenario(packageUuid, payload);
// Close modal and redirect to new scenario
document.getElementById('new_scenario_modal').close();
window.location.href = result.url || `{{ meta.current_package.url }}/scenario/${result.uuid}`;
} catch (err) {
this.error = err.message;
} finally {
this.isSubmitting = false;
}
}
}"
@close="reset()"
@schema-form-data-changed.window="setSchemaFormData($event.detail.schemaName, $event.detail.data)"
>
<div class="modal-box max-w-3xl">
<div class="modal-box max-w-3xl max-h-[90vh] overflow-y-auto">
<!-- Header -->
<h3 class="text-lg font-bold">New Scenario</h3>
@ -30,135 +165,212 @@
<!-- Body -->
<div class="py-4">
<form
id="new-scenario-modal-form"
accept-charset="UTF-8"
action="{{ meta.current_package.url }}/scenario"
method="post"
>
{% csrf_token %}
<div class="alert alert-info mb-4">
<span>
Please enter name, description, and date of scenario. Date should be
associated to the data, not the current date. For example, this could
reflect the publishing date of a study. You can leave all fields but
the name empty and fill them in later.
<a
target="_blank"
href="https://wiki.envipath.org/index.php/scenario"
class="link"
>wiki &gt;&gt;</a
>
</span>
</div>
<div class="alert alert-info mb-4">
<span>
Please enter name, description, and date of scenario. Date should be
associated to the data, not the current date. For example, this
could reflect the publishing date of a study. You can leave all
fields but the name empty and fill them in later.
<a
target="_blank"
href="https://wiki.envipath.org/index.php/scenario"
class="link"
>wiki &gt;&gt;</a
>
</span>
<!-- Error state -->
<template x-if="error">
<div class="alert alert-error mb-4">
<span x-text="error"></span>
</div>
</template>
<div class="form-control mb-3">
<label class="label" for="scenario-name">
<span class="label-text">Name</span>
</label>
<input
id="scenario-name"
name="scenario-name"
class="input input-bordered w-full"
placeholder="Name"
required
/>
<!-- Loading state -->
<template x-if="loadingSchemas">
<div class="flex items-center justify-center p-4">
<span class="loading loading-spinner loading-md"></span>
</div>
</template>
<div class="form-control mb-3">
<label class="label" for="scenario-description">
<span class="label-text">Description</span>
</label>
<input
id="scenario-description"
name="scenario-description"
class="input input-bordered w-full"
placeholder="Description"
/>
</div>
<div class="form-control mb-3">
<label class="label">
<span class="label-text">Date</span>
</label>
<div class="flex gap-2">
<!-- Form fields -->
<template x-if="!loadingSchemas">
<div>
<div class="form-control mb-3">
<label class="label" for="scenario-name">
<span class="label-text">Name</span>
</label>
<input
type="number"
id="dateYear"
name="scenario-date-year"
class="input input-bordered w-24"
placeholder="YYYY"
max="{% now 'Y' %}"
@blur="validateYear($el)"
/>
<input
type="number"
id="dateMonth"
name="scenario-date-month"
min="1"
max="12"
class="input input-bordered w-20"
placeholder="MM"
/>
<input
type="number"
id="dateDay"
name="scenario-date-day"
min="1"
max="31"
class="input input-bordered w-20"
placeholder="DD"
id="scenario-name"
type="text"
class="input input-bordered w-full"
placeholder="Name"
x-model="formData.name"
required
/>
</div>
</div>
<div class="form-control mb-3">
<label class="label">
<span class="label-text">Scenario Type</span>
</label>
<div role="tablist" class="tabs tabs-border">
<button
type="button"
role="tab"
class="tab"
:class="{ 'tab-active': scenarioType === 'empty' }"
@click="scenarioType = 'empty'"
>
Empty Scenario
</button>
{% for k, v in scenario_types.items %}
<div class="form-control mb-3">
<label class="label" for="scenario-description">
<span class="label-text">Description</span>
</label>
<input
id="scenario-description"
type="text"
class="input input-bordered w-full"
placeholder="Description"
x-model="formData.description"
/>
</div>
<div class="form-control mb-3">
<label class="label">
<span class="label-text">Date</span>
</label>
<div class="flex gap-2">
<input
type="number"
class="input input-bordered w-24"
placeholder="YYYY"
max="{% now 'Y' %}"
x-model="formData.dateYear"
@blur="validateYear($el)"
/>
<input
type="number"
min="1"
max="12"
class="input input-bordered w-20"
placeholder="MM"
x-model="formData.dateMonth"
/>
<input
type="number"
min="1"
max="31"
class="input input-bordered w-20"
placeholder="DD"
x-model="formData.dateDay"
/>
</div>
</div>
<div class="form-control mb-3">
<label class="label">
<span class="label-text">Scenario Type</span>
</label>
<div role="tablist" class="tabs tabs-border">
<button
type="button"
role="tab"
class="tab"
:class="{ 'tab-active': scenarioType === '{{ v.name }}' }"
@click="scenarioType = '{{ v.name }}'"
:class="{ 'tab-active': scenarioType === 'empty' }"
@click="scenarioType = 'empty'"
>
{{ k }}
Empty Scenario
</button>
{% endfor %}
<button
type="button"
role="tab"
class="tab"
:class="{ 'tab-active': scenarioType === 'soil' }"
@click="scenarioType = 'soil'"
>
Soil Data
</button>
<button
type="button"
role="tab"
class="tab"
:class="{ 'tab-active': scenarioType === 'sludge' }"
@click="scenarioType = 'sludge'"
>
Sludge Data
</button>
<button
type="button"
role="tab"
class="tab"
:class="{ 'tab-active': scenarioType === 'sediment' }"
@click="scenarioType = 'sediment'"
>
Water-Sediment System Data
</button>
</div>
</div>
<input
type="hidden"
id="scenario-type"
name="scenario-type"
x-model="scenarioType"
/>
</div>
{% for type in scenario_types.values %}
<div
id="{{ type.name }}-specific-inputs"
x-show="scenarioType === '{{ type.name }}'"
x-cloak
>
{% for widget in type.widgets %}
{{ widget|safe }}
{% endfor %}
</div>
{% endfor %}
</form>
<!-- Schema forms for each scenario type -->
<template x-if="scenarioType === 'soil'">
<div class="space-y-4 mt-4">
<template
x-for="(rjsf, schemaName) in groupSchemas.soil"
:key="schemaName"
>
<div
x-data="schemaRenderer({
rjsf: rjsf,
mode: 'edit'
})"
x-init="await init();
const currentSchemaName = schemaName;
$watch('data', (value) => {
$dispatch('schema-form-data-changed', { schemaName: currentSchemaName, data: value });
}, { deep: true })"
>
{% include "components/schema_form.html" %}
</div>
</template>
</div>
</template>
<template x-if="scenarioType === 'sludge'">
<div class="space-y-4 mt-4">
<template
x-for="(rjsf, schemaName) in groupSchemas.sludge"
:key="schemaName"
>
<div
x-data="schemaRenderer({
rjsf: rjsf,
mode: 'edit'
})"
x-init="await init();
const currentSchemaName = schemaName;
$watch('data', (value) => {
$dispatch('schema-form-data-changed', { schemaName: currentSchemaName, data: value });
}, { deep: true })"
>
{% include "components/schema_form.html" %}
</div>
</template>
</div>
</template>
<template x-if="scenarioType === 'sediment'">
<div class="space-y-4 mt-4">
<template
x-for="(rjsf, schemaName) in groupSchemas.sediment"
:key="schemaName"
>
<div
x-data="schemaRenderer({
rjsf: rjsf,
mode: 'edit'
})"
x-init="await init();
const currentSchemaName = schemaName;
$watch('data', (value) => {
$dispatch('schema-form-data-changed', { schemaName: currentSchemaName, data: value });
}, { deep: true })"
>
{% include "components/schema_form.html" %}
</div>
</template>
</div>
</template>
</div>
</template>
</div>
<!-- Footer -->
@ -174,8 +386,8 @@
<button
type="button"
class="btn btn-primary"
@click="submit('new-scenario-modal-form')"
:disabled="isSubmitting"
@click="submit()"
:disabled="isSubmitting || loadingSchemas"
>
<span x-show="!isSubmitting">Submit</span>
<span

View File

@ -6,27 +6,110 @@
x-data="{
isSubmitting: false,
selectedType: '',
schemas: {},
loadingSchemas: false,
error: null,
formData: null, // Store reference to form data
formRenderKey: 0, // Counter to force form re-render
existingTypes: [], // Track existing additional information types
// Get sorted unique schema names for dropdown, excluding already-added types
get sortedSchemaNames() {
const names = Object.keys(this.schemas);
// Remove duplicates, exclude existing types, and sort alphabetically by display title
const unique = [...new Set(names)];
const available = unique.filter(name => !this.existingTypes.includes(name));
return available.sort((a, b) => {
const titleA = (this.schemas[a]?.schema?.['x-title'] || a).toLowerCase();
const titleB = (this.schemas[b]?.schema?.['x-title'] || b).toLowerCase();
return titleA.localeCompare(titleB);
});
},
async init() {
// Watch for selectedType changes
this.$watch('selectedType', (value) => {
// Reset formData when type changes and increment key to force re-render
this.formData = null;
this.formRenderKey++;
});
// Load schemas and existing items
try {
this.loadingSchemas = true;
const scenarioUuid = '{{ scenario.uuid }}';
const [schemasRes, itemsRes] = await Promise.all([
fetch('/api/v1/information/schema/'),
fetch(`/api/v1/scenario/${scenarioUuid}/information/`)
]);
if (!schemasRes.ok) throw new Error('Failed to load schemas');
if (!itemsRes.ok) throw new Error('Failed to load existing items');
this.schemas = await schemasRes.json();
const items = await itemsRes.json();
// Get unique existing types (normalize to lowercase)
this.existingTypes = [...new Set(items.map(item => item.type.toLowerCase()))];
} catch (err) {
this.error = err.message;
} finally {
this.loadingSchemas = false;
}
},
reset() {
this.isSubmitting = false;
this.selectedType = '';
this.error = null;
this.formData = null;
},
submit() {
setFormData(data) {
this.formData = data;
},
async submit() {
if (!this.selectedType) return;
const form = document.getElementById('add_' + this.selectedType + '_add-additional-information-modal-form');
if (form && form.checkValidity()) {
this.isSubmitting = true;
form.submit();
} else if (form) {
form.reportValidity();
const payload = window.AdditionalInformationApi.sanitizePayload(this.formData);
// Validate that form has data
if (!payload || Object.keys(payload).length === 0) {
this.error = 'Please fill in at least one field';
return;
}
this.isSubmitting = true;
this.error = null;
try {
const scenarioUuid = '{{ scenario.uuid }}';
await window.AdditionalInformationApi.createItem(
scenarioUuid,
this.selectedType,
payload
);
// Close modal and reload page to show new item
document.getElementById('add_additional_information_modal').close();
window.location.reload();
} catch (err) {
if (err.isValidationError && err.fieldErrors) {
window.dispatchEvent(new CustomEvent('set-field-errors', {
detail: err.fieldErrors
}));
}
this.error = err.message;
} finally {
this.isSubmitting = false;
}
}
}"
@close="reset()"
@form-data-ready="formData = $event.detail"
>
<div class="modal-box">
<div class="modal-box max-w-2xl">
<!-- Header -->
<h3 class="text-lg font-bold">Add Additional Information</h3>
@ -42,46 +125,59 @@
<!-- Body -->
<div class="py-4">
<div class="form-control">
<label class="label" for="select-additional-information-type">
<span class="label-text">Select the type to add</span>
</label>
<select
id="select-additional-information-type"
class="select select-bordered w-full"
x-model="selectedType"
>
<option value="" selected disabled>Select the type to add</option>
{% for add_inf in available_additional_information %}
<option value="{{ add_inf.name }}">
{{ add_inf.display_name }}
</option>
{% endfor %}
</select>
</div>
{% for add_inf in available_additional_information %}
<div
class="mt-4"
x-show="selectedType === '{{ add_inf.name }}'"
x-cloak
>
<form
id="add_{{ add_inf.name }}_add-additional-information-modal-form"
accept-charset="UTF-8"
action=""
method="post"
>
{% csrf_token %}
{{ add_inf.widget|safe }}
<input
type="hidden"
name="hidden"
value="add-additional-information"
/>
</form>
<!-- Loading state -->
<template x-if="loadingSchemas">
<div class="flex items-center justify-center p-4">
<span class="loading loading-spinner loading-md"></span>
</div>
{% endfor %}
</template>
<!-- Error state -->
<template x-if="error">
<div class="alert alert-error mb-4">
<span x-text="error"></span>
</div>
</template>
<!-- Schema selection -->
<template x-if="!loadingSchemas">
<div>
<div class="form-control mb-4">
<label class="label" for="select-additional-information-type">
<span class="label-text">Select the type to add</span>
</label>
<select
id="select-additional-information-type"
class="select select-bordered w-full"
x-model="selectedType"
>
<option value="" selected disabled>Select the type to add</option>
<template x-for="name in sortedSchemaNames" :key="name">
<option
:value="name"
x-text="(schemas[name].schema && schemas[name].schema['x-title']) || name"
></option>
</template>
</select>
</div>
<!-- Form renderer for selected type -->
<!-- Use unique key per type to force re-render -->
<template x-for="renderKey in [formRenderKey]" :key="renderKey">
<div x-show="selectedType && schemas[selectedType]">
<div
x-data="schemaRenderer({
rjsf: schemas[selectedType],
mode: 'edit'
})"
x-init="await init(); $dispatch('form-data-ready', data)"
>
{% include "components/schema_form.html" %}
</div>
</div>
</template>
</div>
</template>
</div>
<!-- Footer -->
@ -98,7 +194,7 @@
type="button"
class="btn btn-primary"
@click="submit()"
:disabled="isSubmitting || !selectedType"
:disabled="isSubmitting || !selectedType || loadingSchemas"
>
<span x-show="!isSubmitting">Add</span>
<span

View File

@ -3,10 +3,99 @@
<dialog
id="update_scenario_additional_information_modal"
class="modal"
x-data="modalForm()"
x-data="{
isSubmitting: false,
items: [],
schemas: {},
loading: false,
error: null,
originalItems: [], // Store original data to detect changes
modifiedUuids: new Set(), // Track which items were modified
async init() {
try {
this.loading = true;
const scenarioUuid = '{{ scenario.uuid }}';
const { items, schemas } =
await window.AdditionalInformationApi.loadSchemasAndItems(scenarioUuid);
this.items = items;
this.schemas = schemas;
// Store deep copy of original items for comparison
this.originalItems = JSON.parse(JSON.stringify(items));
} catch (err) {
this.error = err.message;
} finally {
this.loading = false;
}
},
reset() {
this.isSubmitting = false;
this.error = null;
this.modifiedUuids.clear();
},
updateItemData(uuid, data) {
// Update the item's data in the items array
const item = this.items.find(i => i.uuid === uuid);
if (item) {
item.data = data;
// Mark this item as modified
this.modifiedUuids.add(uuid);
}
},
async submit() {
if (this.items.length === 0) {
this.error = 'No data to update';
return;
}
// Filter to only items that were actually modified
const modifiedItems = this.items.filter(item => this.modifiedUuids.has(item.uuid));
if (modifiedItems.length === 0) {
this.error = 'No changes to save';
return;
}
this.isSubmitting = true;
this.error = null;
try {
const scenarioUuid = '{{ scenario.uuid }}';
// Use the unified API client for sequential, safe updates - only modified items
await window.AdditionalInformationApi.updateItems(scenarioUuid, modifiedItems);
// Close modal and reload page
document.getElementById('update_scenario_additional_information_modal').close();
window.location.reload();
} catch (err) {
// Handle validation errors with field-level details
if (err.isValidationError && err.fieldErrors) {
this.error = err.message;
// Dispatch event to set field errors in the specific form
if (err.itemUuid) {
window.dispatchEvent(new CustomEvent('set-field-errors-for-item', {
detail: {
uuid: err.itemUuid,
fieldErrors: err.fieldErrors
}
}));
}
} else {
this.error = err.message;
}
} finally {
this.isSubmitting = false;
}
}
}"
@close="reset()"
@update-item-data.window="updateItemData($event.detail.uuid, $event.detail.data)"
>
<div class="modal-box">
<div class="modal-box max-h-[90vh] max-w-4xl overflow-y-auto">
<!-- Header -->
<h3 class="text-lg font-bold">Update Additional Information</h3>
@ -22,18 +111,39 @@
<!-- Body -->
<div class="py-4">
<form
id="edit-scenario-additional-information-modal-form"
accept-charset="UTF-8"
action=""
method="post"
>
{% csrf_token %}
{% for widget in update_widgets %}
{{ widget|safe }}
{% endfor %}
<input type="hidden" name="hidden" value="set-additional-information" />
</form>
<!-- Loading state -->
{% include "components/modals/loading_state.html" with loading_var="loading" %}
<!-- Error state -->
{% include "components/modals/error_state.html" with error_var="error" %}
<!-- Items list -->
<template x-if="!loading">
<div class="space-y-4">
<template x-if="items.length === 0">
<p class="text-base-content/60">
No additional information to update.
</p>
</template>
<template x-for="(item, index) in items" :key="item.uuid">
<div class="card bg-base-200 shadow-sm">
<div class="card-body p-4">
<div
x-data="schemaRenderer({
rjsf: schemas[item.type.toLowerCase()],
data: item.data,
mode: 'edit'
})"
x-init="await init(); $watch('data', (value) => { $dispatch('update-item-data', { uuid: item.uuid, data: value }) }, { deep: true })"
>
{% include "components/schema_form.html" %}
</div>
</div>
</div>
</template>
</div>
</template>
</div>
<!-- Footer -->
@ -49,10 +159,17 @@
<button
type="button"
class="btn btn-primary"
@click="submit('edit-scenario-additional-information-modal-form')"
:disabled="isSubmitting"
@click="submit()"
:disabled="isSubmitting || loading || items.length === 0 || modifiedUuids.size === 0"
>
<span x-show="!isSubmitting">Update</span>
<span x-show="!isSubmitting">
<template x-if="modifiedUuids.size > 0">
<span x-text="`Update (${modifiedUuids.size})`"></span>
</template>
<template x-if="modifiedUuids.size === 0">
<span>No Changes</span>
</template>
</span>
<span
x-show="isSubmitting"
class="loading loading-spinner loading-sm"