1 Commits

Author SHA1 Message Date
e6ce62a166 openapi-spec-reader (#10)
### Summary of Changes:
1.  **Spec-Driven Enums**:
    - Updated `openapi_loader.ts` to collect all standalone enum schemas (e.g., `FetchRequestStatus`) into the `AppConfig.enums` map.
    - Implemented `mergeProperties` and `oneOf`/`anyOf` resolution in `openapi_loader.ts` to ensure complex schemas like `FetchRequest` (using `allOf`) and `source` (using `oneOf`) are correctly parsed.
2.  **Customizable Labeling**:
    - Added `enumOption` (template-based) and `enumLabels` (mapping-based) to the config and field types.
    - Implemented `resolveTemplate` in `utils/options.ts` to handle placeholders like `'{name} {number}'` or plain field names.
3.  **UI Integration**:
    - **`FormField.tsx`**: Updated relation and enum selects to use `getFieldOptions()` for correct key/value pairs and labels. Added value normalization to extract keys from API objects.
    - **`EnhancedTable.tsx`**: Updated `valueOptions` to use key/value pairs for `singleSelect` and updated `FieldRenderer` to show the human-readable label for enums.
    - **`FilterBar.tsx`**: Updated `extractOptions` to use spec-driven labels for enum filters.
    - **`ResourceView.tsx`**: Centralized filter matching logic into a `getDisplayString` helper, ensuring filter comparisons use the same templates as the UI labels.
4. **App Fixes**:
    - `FetchRequests.tsx` and `FetchRequestDetail.tsx` now derive status and format options from the OpenAPI spec via `useConfig()` instead of using hardcoded arrays.

Reviewed-on: #10
Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
2026-06-04 17:23:44 +00:00
10 changed files with 104 additions and 63 deletions

View File

@@ -31,7 +31,7 @@ import VisibilityIcon from '@mui/icons-material/Visibility';
import MoreVertIcon from '@mui/icons-material/MoreVert'; import MoreVertIcon from '@mui/icons-material/MoreVert';
import { useNavigate } from 'react-router-dom'; import { useNavigate } from 'react-router-dom';
import { ResourceConfig } from '../types/config'; import { ResourceConfig } from '../types/config';
import { getFieldOptions, toGridValueOptions } from '../utils/options'; import { getFieldOptions, toGridValueOptions, resolveTemplate } from '../utils/options';
interface EnhancedTableProps { interface EnhancedTableProps {
config: ResourceConfig; config: ResourceConfig;
@@ -96,7 +96,7 @@ export default function EnhancedTable({
}; };
} }
if (muiType === 'singleSelect' && field.options) { if (muiType === 'singleSelect') {
col.valueOptions = toGridValueOptions(getFieldOptions(field)); col.valueOptions = toGridValueOptions(getFieldOptions(field));
} }
@@ -274,8 +274,9 @@ function MobileCardRow({ row, config, onDelete, onNavigate, navigate }: any) {
); );
} }
function getFormattedDisplayValue(item: any, displayField?: string | string[]) { function getFormattedDisplayValue(item: any, displayField?: string | string[], enumValue?: string) {
if (!item) return ""; if (!item) return "";
if (enumValue) return resolveTemplate(enumValue, item);
if (!displayField) return item.name || item.title || item.label || item.id || JSON.stringify(item); if (!displayField) return item.name || item.title || item.label || item.id || JSON.stringify(item);
if (Array.isArray(displayField)) { if (Array.isArray(displayField)) {
@@ -297,7 +298,7 @@ function FieldRenderer({ params, field, fieldKey, config, onNavigate, navigate,
// 1. Single Relation // 1. Single Relation
if (field.relation && value && !Array.isArray(value)) { if (field.relation && value && !Array.isArray(value)) {
const relationId = typeof value === 'object' ? (value.id || value._id || value.pk) : value; const relationId = typeof value === 'object' ? (value.id || value._id || value.pk) : value;
const displayValue = getFormattedDisplayValue(value, field.displayField); const displayValue = getFormattedDisplayValue(value, field.displayField, field.enumOption?.value);
return ( return (
<Chip <Chip
@@ -316,7 +317,8 @@ function FieldRenderer({ params, field, fieldKey, config, onNavigate, navigate,
// 2. Multi-Select (Array of relations or simple strings) // 2. Multi-Select (Array of relations or simple strings)
if (field.type === 'array' && Array.isArray(value)) { if (field.type === 'array' && Array.isArray(value)) {
const tooltipTitle = value.map((item) => getFormattedDisplayValue(item, field.displayField)).join(', '); const enumValue = field.enumOption?.value;
const tooltipTitle = value.map((item) => getFormattedDisplayValue(item, field.displayField, enumValue)).join(', ');
return ( return (
<Tooltip title={tooltipTitle} arrow placement="top"> <Tooltip title={tooltipTitle} arrow placement="top">
@@ -324,7 +326,7 @@ function FieldRenderer({ params, field, fieldKey, config, onNavigate, navigate,
{value.map((item, idx) => ( {value.map((item, idx) => (
<Chip <Chip
key={idx} key={idx}
label={getFormattedDisplayValue(item, field.displayField)} label={getFormattedDisplayValue(item, field.displayField, enumValue)}
size="small" size="small"
variant="filled" variant="filled"
sx={{ maxWidth: 120 }} sx={{ maxWidth: 120 }}
@@ -344,7 +346,7 @@ function FieldRenderer({ params, field, fieldKey, config, onNavigate, navigate,
// 3. Simple Objects // 3. Simple Objects
if (field.type === 'object' && value) { if (field.type === 'object' && value) {
return getFormattedDisplayValue(value, field.displayField) || (isMobile ? 'Object' : JSON.stringify(value)); return getFormattedDisplayValue(value, field.displayField, field.enumOption?.value) || (isMobile ? 'Object' : JSON.stringify(value));
} }
if (field.type === 'number' && typeof value === 'number') { if (field.type === 'number' && typeof value === 'number') {
@@ -379,7 +381,7 @@ function FieldRenderer({ params, field, fieldKey, config, onNavigate, navigate,
if (field.type === 'datetime' || field.type === 'date') return value ? new Date(value).toLocaleString() : ''; if (field.type === 'datetime' || field.type === 'date') return value ? new Date(value).toLocaleString() : '';
if (field.type === 'enum' && field.options) { if (field.type === 'enum') {
const opt = getFieldOptions(field).find(o => o.key === value); const opt = getFieldOptions(field).find(o => o.key === value);
return opt?.value ?? value; return opt?.value ?? value;
} }

View File

@@ -11,7 +11,7 @@ import {
import DoneIcon from "@mui/icons-material/Done"; import DoneIcon from "@mui/icons-material/Done";
import FilterListIcon from "@mui/icons-material/FilterList"; import FilterListIcon from "@mui/icons-material/FilterList";
import { ResourceField, ResourceMode } from "../types/config"; import { ResourceField, ResourceMode } from "../types/config";
import { getFieldOptions } from "../utils/options"; import { getFieldOptions, resolveTemplate } from "../utils/options";
function FilterAutocomplete({ function FilterAutocomplete({
options, options,
@@ -111,8 +111,8 @@ function extractOptions(
): string[] { ): string[] {
const values = new Set<string>(); const values = new Set<string>();
if (field.type === 'enum' && field.options) { if (field.type === 'enum') {
return getFieldOptions(field).map(o => o.key); return getFieldOptions(field).map(o => o.value);
} }
if (!data) return []; if (!data) return [];
@@ -121,18 +121,18 @@ function extractOptions(
if (typeof item === "string") return item; if (typeof item === "string") return item;
if (typeof item !== "object") return String(item); if (typeof item !== "object") return String(item);
if (field.enumOption?.value) return resolveTemplate(field.enumOption.value, item);
const df = field.displayField; const df = field.displayField;
if (!df) { debugger; return null; } if (!df) return null;
if (Array.isArray(df)) { if (Array.isArray(df)) {
const parts = df.map((k) => item[k]).filter((v) => v != null); const parts = df.map((k) => item[k]).filter((v) => v != null);
if (parts.length > 0) return parts.join(" "); if (parts.length > 0) return parts.join(" ");
} else { }
const v = item[df]; const v = item[df];
if (v != null) return String(v); if (v != null) return String(v);
}
debugger;
return null; return null;
}; };

View File

@@ -3,6 +3,7 @@ import { Box, Paper, CircularProgress } from '@mui/material';
import { ResourceConfig } from '../types/config'; import { ResourceConfig } from '../types/config';
import type { ResourceField } from '../types/config'; import type { ResourceField } from '../types/config';
import { useResource } from '../hooks/useResource'; import { useResource } from '../hooks/useResource';
import { resolveTemplate } from '../utils/options';
import GenericForm from './GenericForm'; import GenericForm from './GenericForm';
import EnhancedTable from './EnhancedTable'; import EnhancedTable from './EnhancedTable';
import FilterBar from './FilterBar'; import FilterBar from './FilterBar';
@@ -15,11 +16,16 @@ interface ResourceViewProps {
import { GridPaginationModel } from '@mui/x-data-grid'; import { GridPaginationModel } from '@mui/x-data-grid';
function getFilterDisplayFields(field: ResourceField): string[] { function getDisplayString(item: any, field: ResourceField): string {
if (!field.displayField) return []; if (item == null || typeof item !== 'object') return String(item ?? '');
return (Array.isArray(field.displayField) ? field.displayField : [field.displayField]).filter( if (field.enumOption?.value) return resolveTemplate(field.enumOption.value, item);
(df): df is string => !!df const df = field.displayField;
); if (!df) return item.name ?? item.title ?? item.label ?? item.id ?? JSON.stringify(item);
if (Array.isArray(df)) {
const parts = df.map((k: string) => item[k]).filter((v: any) => v != null);
return parts.length > 0 ? parts.join(' ') : '';
}
return String(item[df] ?? '');
} }
function applyClientFilters( function applyClientFilters(
@@ -59,18 +65,12 @@ function applyClientFilters(
if (Array.isArray(filterValue)) { if (Array.isArray(filterValue)) {
if (field.type === "array" && Array.isArray(itemValue)) { if (field.type === "array" && Array.isArray(itemValue)) {
return itemValue.some((el: any) => { return itemValue.some((el: any) =>
if (el != null && typeof el === "object") { filterValue.includes(getDisplayString(el, field))
const dispFields = getFilterDisplayFields(field); );
return dispFields.some((df) => filterValue.includes(String(el[df])));
}
return filterValue.includes(String(el));
});
} }
if (itemValue && typeof itemValue === "object") { if (itemValue && typeof itemValue === "object") {
const dispFields = getFilterDisplayFields(field); return filterValue.includes(getDisplayString(itemValue, field));
const itemDisplay = dispFields.map((df) => itemValue[df]).filter((v) => v != null).join(" ");
return filterValue.includes(itemDisplay);
} }
return filterValue.includes(String(itemValue)); return filterValue.includes(String(itemValue));
} }
@@ -82,18 +82,13 @@ function applyClientFilters(
} }
if (field.type === "array" && Array.isArray(itemValue)) { if (field.type === "array" && Array.isArray(itemValue)) {
return itemValue.some((el: any) => { return itemValue.some((el: any) =>
if (el != null && typeof el === "object") { getDisplayString(el, field) === String(filterValue)
const dispFields = getFilterDisplayFields(field); );
return dispFields.some((df) => String(el[df]) === String(filterValue));
}
return String(el) === String(filterValue);
});
} }
if (itemValue && typeof itemValue === "object") { if (itemValue && typeof itemValue === "object") {
const dispFields = getFilterDisplayFields(field); return getDisplayString(itemValue, field) === String(filterValue);
return dispFields.some((df) => String(itemValue[df]) === String(filterValue));
} }
return String(itemValue) === String(filterValue); return String(itemValue) === String(filterValue);

View File

@@ -149,7 +149,7 @@ export default function FormField({
} }
// 5. Enum Handling // 5. Enum Handling
if (field.type === 'enum' && field.options) { if (field.type === 'enum') {
const options = getFieldOptions(field); const options = getFieldOptions(field);
return ( return (
<FormControl fullWidth> <FormControl fullWidth>

View File

@@ -17,7 +17,7 @@ export interface SelectOption {
export interface EnumOption { export interface EnumOption {
key: string; key: string;
value: string | string[]; value: string;
} }
export interface ResourceField { export interface ResourceField {
@@ -57,6 +57,7 @@ export interface AppConfig {
baseUrl: string; baseUrl: string;
authBaseUrl: string; authBaseUrl: string;
resources: ResourceConfig[]; resources: ResourceConfig[];
enums: Record<string, string[]>;
profile?: { profile?: {
resource: string; resource: string;
extraFields?: Record<string, any>; extraFields?: Record<string, any>;

View File

@@ -1,6 +1,6 @@
export interface EnumOption { export interface EnumOption {
key: string; key: string;
value: string | string[]; value: string;
} }
export interface FieldOverride { export interface FieldOverride {

View File

@@ -36,6 +36,26 @@ function mapOpenApiType(prop: any): FieldType {
/** /**
* Recursively converts OpenAPI schemas to ResourceField map * Recursively converts OpenAPI schemas to ResourceField map
*/ */
function mergeProperties(schema: any): { properties: Record<string, any>; required: string[] } {
let properties: Record<string, any> = {};
let required: string[] = [];
if (schema.allOf) {
for (const sub of schema.allOf) {
const merged = mergeProperties(sub);
properties = { ...properties, ...merged.properties };
required = [...required, ...merged.required];
}
}
if (schema.properties) {
properties = { ...properties, ...schema.properties };
}
if (schema.required) {
required = [...required, ...schema.required];
}
return { properties, required };
}
function parseSchemaFields( function parseSchemaFields(
schema: any, schema: any,
resourceName: string, resourceName: string,
@@ -43,12 +63,19 @@ function parseSchemaFields(
configuration: Record<string, any> = {} configuration: Record<string, any> = {}
): Record<string, ResourceField> { ): Record<string, ResourceField> {
const fields: Record<string, ResourceField> = {}; const fields: Record<string, ResourceField> = {};
const properties = schema.properties || {}; const { properties, required } = mergeProperties(schema);
const required = schema.required || [];
const overrides = configuration[resourceName]?.fields || {}; const overrides = configuration[resourceName]?.fields || {};
for (const [key, prop] of Object.entries(properties) as [string, any]) { for (const [key, prop] of Object.entries(properties) as [string, any]) {
const type = mapOpenApiType(prop); // Resolve oneOf/anyOf by merging all branch properties
let resolvedProp = prop;
if (prop.oneOf || prop.anyOf) {
const branches = prop.oneOf || prop.anyOf;
const merged = mergeProperties({ allOf: branches });
resolvedProp = { ...prop, type: 'object', properties: merged.properties, required: merged.required };
}
const type = mapOpenApiType(resolvedProp);
const override = overrides[key]; const override = overrides[key];
// Explicitly skip 'id' as it's the primary key and handled elsewhere // Explicitly skip 'id' as it's the primary key and handled elsewhere
@@ -57,12 +84,12 @@ function parseSchemaFields(
fields[key] = { fields[key] = {
type, type,
label: label:
prop.title || resolvedProp.title ||
key.charAt(0).toUpperCase() + key.slice(1).replace(/_/g, " "), key.charAt(0).toUpperCase() + key.slice(1).replace(/_/g, " "),
required: required.includes(key), required: required.includes(key),
options: prop.enum, options: resolvedProp.enum,
readOnly: readOnly:
prop.readOnly || resolvedProp.readOnly ||
key === "created_at" || key === "created_at" ||
key === "updated_at", key === "updated_at",
...override, ...override,
@@ -71,9 +98,9 @@ function parseSchemaFields(
// STRICT RELATION DETECTION // STRICT RELATION DETECTION
// A field is a relation ONLY if its schema object (or items schema) // A field is a relation ONLY if its schema object (or items schema)
// exactly matches a schema that is defined as a resource. // exactly matches a schema that is defined as a resource.
let targetSchema = prop; let targetSchema = resolvedProp;
if (type === "array" && prop.items) { if (type === "array" && resolvedProp.items) {
targetSchema = prop.items; targetSchema = resolvedProp.items;
} }
// Check if this schema object is registered as a resource // Check if this schema object is registered as a resource
@@ -98,8 +125,8 @@ function parseSchemaFields(
} }
// Recursively parse nested objects (only if not a relation) // Recursively parse nested objects (only if not a relation)
if (fields[key].type === "object" && prop.properties && !relation) { if (fields[key].type === "object" && resolvedProp.properties && !relation) {
fields[key].schema = parseSchemaFields(prop, resourceName, schemaToResourceMap, configuration); fields[key].schema = parseSchemaFields(resolvedProp, resourceName, schemaToResourceMap, configuration);
} }
} }
@@ -187,6 +214,16 @@ export async function loadConfigFromOpenApi(baseUrl: string, configuration: Reco
}); });
} }
// Collect standalone enum schemas (e.g. FetchRequestStatus, AccountType, etc.)
const enums: Record<string, string[]> = {};
if (api.components?.schemas) {
for (const [name, schema] of Object.entries(api.components.schemas) as [string, any]) {
if (schema.enum) {
enums[name] = schema.enum;
}
}
}
// @ts-ignore // @ts-ignore
const serverBaseUrl = import.meta.env.VITE_API_BASE_URL || (api.servers?.[0]?.url ?? "") const serverBaseUrl = import.meta.env.VITE_API_BASE_URL || (api.servers?.[0]?.url ?? "")
// @ts-ignore // @ts-ignore
@@ -195,6 +232,7 @@ export async function loadConfigFromOpenApi(baseUrl: string, configuration: Reco
baseUrl: serverBaseUrl, baseUrl: serverBaseUrl,
authBaseUrl: authBaseUrl, authBaseUrl: authBaseUrl,
resources, resources,
enums,
profile: profileConfiguration, profile: profileConfiguration,
}; };
} }

View File

@@ -1,8 +1,15 @@
import { ResourceField, SelectOption } from "../types/config"; import { ResourceField, SelectOption } from "../types/config";
export function resolveTemplate(template: string, item: any): string {
if (/\{(\w+)\}/.test(template)) {
return template.replace(/\{(\w+)\}/g, (_, field: string) => String(item[field] ?? ''));
}
return String(item[template] ?? '');
}
export function getFieldOptions(field: ResourceField, relationData?: any[]): SelectOption[] { export function getFieldOptions(field: ResourceField, relationData?: any[]): SelectOption[] {
if (field.type === 'enum' && field.options) { if (field.type === 'enum') {
return field.options.map(opt => ({ return (field.options ?? []).map(opt => ({
key: opt, key: opt,
value: field.enumLabels?.[opt] ?? opt, value: field.enumLabels?.[opt] ?? opt,
})); }));
@@ -14,9 +21,7 @@ export function getFieldOptions(field: ResourceField, relationData?: any[]): Sel
return data.map(item => ({ return data.map(item => ({
key: String(item[enumOption.key] ?? ''), key: String(item[enumOption.key] ?? ''),
value: Array.isArray(enumOption.value) value: resolveTemplate(enumOption.value, item),
? enumOption.value.map(k => item[k]).filter(v => v != null).join(' ')
: String(item[enumOption.value] ?? ''),
})); }));
} }

View File

@@ -129,7 +129,7 @@ export default function FetchRequests() {
const config = useConfig(); const config = useConfig();
const fetchRes = config?.resources.find((r: any) => r.name === "fetch-requests"); const fetchRes = config?.resources.find((r: any) => r.name === "fetch-requests");
const formatOptions: string[] = (fetchRes?.fields?.source?.schema?.format?.options as string[]) ?? ["axis", "icici"]; const formatOptions: string[] = fetchRes?.fields?.source?.schema?.format?.options as string[] ?? [];
const createMutation = useCreateFetchRequest(); const createMutation = useCreateFetchRequest();
const updateMutation = useUpdateFetchRequest(); const updateMutation = useUpdateFetchRequest();
@@ -345,7 +345,7 @@ export default function FetchRequests() {
input={<OutlinedInput label="Status" />} input={<OutlinedInput label="Status" />}
renderValue={(selected) => (selected as string[]).join(", ")} renderValue={(selected) => (selected as string[]).join(", ")}
> >
{["pending", "processing", "paused", "raw_expenses_done", "enriched_done", "completed", "failed"].map((s) => ( {(config?.enums?.FetchRequestStatus ?? []).map((s: string) => (
<MenuItem key={s} value={s}>{s.replace(/_/g, " ")}</MenuItem> <MenuItem key={s} value={s}>{s.replace(/_/g, " ")}</MenuItem>
))} ))}
</Select> </Select>

View File

@@ -53,13 +53,13 @@ export const configuration: Record<string, ResourceOverride> = {
accounts: { accounts: {
enumOption: { enumOption: {
key: 'id', key: 'id',
value: ['name', 'number'] value: '{name} - XXXX{number}'
} }
}, },
tags: { tags: {
enumOption: { enumOption: {
key: 'id', key: 'id',
value: ['icon', 'name'] value: '{icon} {name}'
} }
}, },
}; };