Files
userbase/app/src/ui/routes/data/forms/entity.fields.form.tsx
T
a298b65abf Release 0.16 (#196)
* initial refactor

* fixes

* test secrets extraction

* updated lock

* fix secret schema

* updated schemas, fixed tests, skipping flow tests for now

* added validator for rjsf, hook form via standard schema

* removed @sinclair/typebox

* remove unneeded vite dep

* fix jsonv literal on Field.tsx

* fix schema import path

* fix schema modals

* fix schema modals

* fix json field form, replaced auth form

* initial waku

* finalize waku example

* fix jsonv-ts version

* fix schema updates with falsy values

* fix media api to respect options' init, improve types

* checking media controller test

* checking media controller test

* checking media controller test

* clean up mediacontroller test

* added cookie option `partitioned`, as well as cors `origin` to be array, option to enable `credentials` (#214)

* added cookie option `partitioned`, as well as cors `origin` to be array, option to enable `credentials`

* fix server test

* fix data api (updated jsonv-ts)

* enhance cloudflare image optimization plugin with new options and explain endpoint (#215)

* feat: add ability to serve static by using dynamic imports (#197)

* feat: add ability to serve static by using dynamic imports

* serveStaticViaImport: make manifest optional

* serveStaticViaImport: add error log

* refactor/imports (#217)

* refactored core and core/utils imports

* refactored core and core/utils imports

* refactored media imports

* refactored auth imports

* refactored data imports

* updated package json exports, fixed mm config

* fix tests

* feat/deno (#219)

* update bun version

* fix module manager's em reference

* add basic deno example

* finalize

* docs: fumadocs migration (#185)

* feat(docs): initialize documentation structure with Fumadocs

* feat(docs): remove home route and move /docs route to /route

* feat(docs): add redirect to /start page

* feat(docs): migrate Getting Started chapters

* feat(docs): migrate Usage and Extending chapters

* feat(callout): add CalloutCaution, CalloutDanger, CalloutInfo, and CalloutPositive

* feat(layout): add Discord and GitHub links to documentation layout

* feat(docs): add integration chapters draft

* feat(docs): add modules chapters draft

* refactor(mdx-components): remove unused Icon import

* refactor(StackBlitz): enhance type safety by using unknown instead of any

* refactor(layout): update navigation mode to 'top' in layout configuration

* feat(docs): add @iconify/react package

* docs(mdx-components): add Icon component to MDX components list

* feat(docs): update Next.js integration guide

* feat(docs): update React Router integration guide

* feat(docs): update Astro integration guide

* feat(docs): update Vite integration guide

* fix(docs): update package manager initialization commands

* feat(docs): migrate Modules chapters

* chore(docs): update package.json with new devDependencies

* feat(docs): migrate Integration Runtimes chapters

* feat(docs): update Database usage chapter

* feat(docs): restructure documentation paths

* chore(docs): clean up unused imports and files in documentation

* style(layout): revert navigation mode to previous state

* fix(docs): routing for documentation structure

* feat(openapi): add API documentation generation from OpenAPI schema

* feat(docs): add icons to documentation pages

* chore(dependencies): remove unused content-collections packages

* fix(types): fix type error for attachFile in source.ts

* feat(redirects): update root redirect destination to '/start'

* feat(search): add static search functionality

* chore(dependencies): update fumadocs-core and fumadocs-ui to latest versions

* feat(search): add Powered by Orama link

* feat(generate-openapi): add error handling for missing OpenAPI schema

* feat(scripts): add OpenAPI generation to build process

* feat(config): enable dynamic redirects and rewrites in development mode

* feat(layout): add GitHub token support for improved API rate limits

* feat(redirects): add 301 redirects for cloudflare pages

* feat(docs): add Vercel redirects configuration

* feat(config): enable standalone output for development environment

* chore(layout): adjust layout settings

* refactor(package): clean up ajv dependency versions

* feat(docs): add twoslash support

* refactor(layout): update DocsLayout import and navigation configuration

* chore(layout): clean up layout.tsx by commenting out GithubInfo

* fix(Search): add locale to search initialization

* chore(package): update fumadocs and orama to latest versions

* docs: add menu items descriptions

* feat(layout): add GitHub URL to the layout component

* feat(docs): add AutoTypeTable component to MDX components

* feat(app): implement AutoTypeTable rendering for AppEvents type

* docs(layout): switch callouts back to default components

* fix(config): use __filename and __dirname for module paths

* docs: add note about node.js 22 requirement

* feat(styles): add custom color variables for light and dark themes

* docs: add S3 setup instructions for media module

* docs: fix typos and indentation in media module docs

* docs: add local media adapter example for Node.js

* docs(media): add S3/R2 URL format examples and fix typo

* docs: add cross-links to initial config and seeding sections

* indent numbered lists content, clarified media serve locations

* fix mediacontroller tests

* feat(layout): add AnimatedGridPattern component for dynamic background

* style(layout): configure fancy ToC style ('clerk')

* fix(AnimatedGridPattern): correct strokeDasharray type

* docs: actualize docs

* feat: add favicon

* style(cloudflare): format code examples

* feat(layout): add Github and Discord footer icons

* feat(footer): add SVG social media icons for GitHub and Discord

* docs: adjusted auto type table, added llm functions

* added static deployment to cloudflare workers

* docs: change cf redirects to proxy *.mdx instead of redirecting

---------

Co-authored-by: dswbx <dennis.senn@gmx.ch>
Co-authored-by: cameronapak <cameronandrewpak@gmail.com>

* build: improve build script

* add missing exports, fix EntityTypescript imports

* media: Dropzone: add programmatic upload, additional events, loading state

* schema object: disable extended defaults to allow empty config values

* Feat/new docs deploy (#224)

* test

* try fixing pm

* try fixing pm

* fix docs on imports, export events correctly

---------

Co-authored-by: Tim Seriakov <59409712+timseriakov@users.noreply.github.com>
Co-authored-by: cameronapak <cameronandrewpak@gmail.com>
2025-08-01 15:55:59 +02:00

519 lines
18 KiB
TypeScript

import { Tabs, TextInput, Textarea, Tooltip, Switch } from "@mantine/core";
import {
objectCleanEmpty,
omitKeys,
ucFirstAllSnakeToPascalWithSpaces,
s,
stringIdentifier,
} from "bknd/utils";
import {
type TAppDataEntityFields,
fieldsSchemaObject as originalFieldsSchemaObject,
} from "data/data-schema";
import { omit } from "lodash-es";
import { forwardRef, memo, useEffect, useImperativeHandle } from "react";
import { type FieldArrayWithId, type UseFormReturn, useFieldArray, useForm } from "react-hook-form";
import { TbGripVertical, TbSettings, TbTrash } from "react-icons/tb";
import { twMerge } from "tailwind-merge";
import { Button } from "ui/components/buttons/Button";
import { IconButton } from "ui/components/buttons/IconButton";
import { JsonViewer } from "ui/components/code/JsonViewer";
import { MantineSwitch } from "ui/components/form/hook-form-mantine/MantineSwitch";
import { JsonSchemaForm } from "ui/components/form/json-schema";
import { type SortableItemProps, SortableList } from "ui/components/list/SortableList";
import { Popover } from "ui/components/overlay/Popover";
import { type TFieldSpec, fieldSpecs } from "ui/modules/data/components/fields-specs";
import { dataFieldsUiSchema } from "../../settings/routes/data.settings";
import { useRoutePathState } from "ui/hooks/use-route-path-state";
import { MantineSelect } from "ui/components/form/hook-form-mantine/MantineSelect";
import type { TPrimaryFieldFormat } from "data/fields/PrimaryField";
import { standardSchemaResolver } from "@hookform/resolvers/standard-schema";
import ErrorBoundary from "ui/components/display/ErrorBoundary";
const fieldsSchemaObject = originalFieldsSchemaObject;
const fieldsSchema = s.anyOf(Object.values(fieldsSchemaObject));
const fieldSchema = s.strictObject({
name: stringIdentifier,
new: s.boolean({ const: true }).optional(),
field: fieldsSchema,
});
type TFieldSchema = s.Static<typeof fieldSchema>;
const schema = s.strictObject({
fields: s.array(fieldSchema),
});
type TFieldsFormSchema = s.Static<typeof schema>;
const fieldTypes = Object.keys(fieldsSchemaObject);
const defaultType = fieldTypes[0];
const commonProps = ["label", "description", "required", "fillable", "hidden", "virtual"];
function specificFieldSchema(type: keyof typeof fieldsSchemaObject) {
//console.log("specificFieldSchema", type);
return s.object(
omitKeys(fieldsSchemaObject[type]?.properties.config.properties, commonProps as any),
);
}
export type EntityFieldsFormProps = {
fields: TAppDataEntityFields;
onChange?: (formData: TAppDataEntityFields) => void;
sortable?: boolean;
additionalFieldTypes?: (TFieldSpec & { onClick: () => void })[];
routePattern?: string;
defaultPrimaryFormat?: TPrimaryFieldFormat;
isNew?: boolean;
};
export type EntityFieldsFormRef = {
getValues: () => TFieldsFormSchema;
getData: () => TAppDataEntityFields;
isValid: () => boolean;
getErrors: () => any;
reset: () => void;
};
export const EntityFieldsForm = forwardRef<EntityFieldsFormRef, EntityFieldsFormProps>(
function EntityFieldsForm(
{ fields: _fields, sortable, additionalFieldTypes, routePattern, isNew, ...props },
ref,
) {
const entityFields = Object.entries(_fields).map(([name, field]) => ({
name,
field,
}));
const {
control,
formState: { isValid, errors },
getValues,
watch,
register,
setValue,
setError,
reset,
} = useForm({
mode: "all",
resolver: standardSchemaResolver(schema),
defaultValues: {
fields: entityFields,
} as TFieldsFormSchema,
});
const { fields, append, remove, move } = useFieldArray({
control,
name: "fields",
});
function toCleanValues(formData: TFieldsFormSchema): TAppDataEntityFields {
return Object.fromEntries(
formData.fields.map((field) => [field.name, objectCleanEmpty(field.field)]),
);
}
useEffect(() => {
if (props?.onChange) {
watch((data: any) => {
props?.onChange?.(toCleanValues(data));
});
}
}, []);
useImperativeHandle(ref, () => ({
reset,
getValues: () => getValues(),
getData: () => {
return toCleanValues(getValues());
},
isValid: () => isValid,
getErrors: () => errors,
}));
function handleAppend(_type: keyof typeof fieldsSchemaObject) {
append({
name: "",
new: true,
field: {
type: _type,
config: fieldsSchemaObject[_type]?.properties.config.template() as any,
},
});
}
const formProps = {
watch,
register,
setValue,
getValues,
control,
setError,
};
return (
<>
<div className="flex flex-col gap-6">
<div className="flex flex-col gap-3">
<div className="flex flex-col gap-4">
{sortable ? (
<SortableList
data={fields}
key={fields.length}
onReordered={move}
extractId={(item) => item.id}
disableIndices={[0]}
renderItem={({ dnd, ...props }, index) => (
<EntityFieldMemo
key={props.id}
field={props as any}
index={index}
form={formProps}
errors={errors}
remove={remove}
dnd={dnd}
routePattern={routePattern}
primary={{
defaultFormat: props.defaultPrimaryFormat,
editable: isNew,
}}
/>
)}
/>
) : (
<div>
{fields.map((field, index) => (
<EntityField
key={field.id}
field={field as any}
index={index}
form={formProps}
errors={errors}
remove={remove}
routePattern={routePattern}
primary={{
defaultFormat: props.defaultPrimaryFormat,
editable: isNew,
}}
/>
))}
</div>
)}
<Popover
className="flex flex-col w-full"
target={({ toggle }) => (
<SelectType
additionalFieldTypes={additionalFieldTypes}
onSelected={toggle}
onSelect={(type) => {
handleAppend(type as any);
}}
/>
)}
>
<Button className="justify-center">Add Field</Button>
</Popover>
</div>
</div>
</div>
</>
);
},
);
const SelectType = ({
onSelect,
additionalFieldTypes = [],
onSelected,
}: {
onSelect: (type: string) => void;
additionalFieldTypes?: (TFieldSpec & { onClick?: () => void })[];
onSelected?: () => void;
}) => {
const types: (TFieldSpec & { onClick?: () => void })[] = fieldSpecs.filter(
(s) => s.addable !== false,
);
if (additionalFieldTypes) {
types.push(...additionalFieldTypes);
}
return (
<div className="flex flex-row gap-2 justify-center flex-wrap">
{types.map((type) => (
<Button
key={type.type}
IconLeft={type.icon}
variant="ghost"
onClick={() => {
if (type.addable !== false) {
onSelect(type.type);
} else {
type.onClick?.();
}
onSelected?.();
}}
>
{type.label}
</Button>
))}
</div>
);
};
const Debug = ({ watch, errors }) => {
return (
<div>
<div>
{Object.entries(errors).map(([key, value]) => (
<p key={key}>
{/* @ts-ignore */}
{key}: {value.message}
</p>
))}
</div>
<pre>{JSON.stringify(watch(), null, 2)}</pre>
</div>
);
};
const EntityFieldMemo = memo(EntityField, (prev, next) => {
return prev.field.id !== next.field.id;
});
function EntityField({
field,
index,
form: { watch, register, setValue, getValues, control, setError },
remove,
errors,
dnd,
routePattern,
primary,
}: {
field: FieldArrayWithId<TFieldsFormSchema, "fields", "id">;
index: number;
form: Pick<
UseFormReturn<any>,
"watch" | "register" | "setValue" | "getValues" | "control" | "setError"
>;
remove: (index: number) => void;
errors: any;
dnd?: SortableItemProps;
routePattern?: string;
primary?: {
defaultFormat?: TPrimaryFieldFormat;
editable?: boolean;
};
}) {
const prefix = `fields.${index}.field` as const;
const type = field.field.type;
const name = watch(`fields.${index}.name`);
const { active, toggle } = useRoutePathState(routePattern ?? "", name);
const fieldSpec = fieldSpecs.find((s) => s.type === type)!;
const specificData = omit(field.field.config, commonProps);
const disabled = fieldSpec.disabled || [];
const hidden = fieldSpec.hidden || [];
const dragDisabled = index === 0;
const hasErrors = !!errors?.fields?.[index];
const is_primary = type === "primary";
function handleDelete(index: number) {
return () => {
if (name.length === 0) {
remove(index);
toggle();
} else if (window.confirm(`Sure to delete "${name}"?`)) {
remove(index);
toggle();
}
};
}
//console.log("register", register(`${prefix}.config.required`));
const dndProps = dnd ? { ...dnd.provided.draggableProps, ref: dnd.provided.innerRef } : {};
return (
<div
key={field.id}
className={twMerge(
"flex flex-col border border-muted rounded bg-background mb-2",
active && "mb-6",
hasErrors && "border-red-500 ",
)}
{...dndProps}
>
<div className="flex flex-row gap-2 px-2 py-2">
{dnd ? (
<div className="flex items-center" {...dnd.provided.dragHandleProps}>
<IconButton Icon={TbGripVertical} className="mt-1" disabled={dragDisabled} />
</div>
) : null}
<div className="flex flex-row flex-grow gap-4 items-center md:mr-6">
<Tooltip label={fieldSpec.label}>
<div className="flex flex-row items-center p-2 bg-primary/5 rounded">
<fieldSpec.icon className="size-5" />
</div>
</Tooltip>
{field.new ? (
<TextInput
error={!!errors?.fields?.[index]?.name.message}
placeholder="Enter a property name..."
classNames={{
root: "w-full h-full",
wrapper: "font-mono h-full",
input: "pt-px !h-full",
}}
{...register(`fields.${index}.name`)}
disabled={!field.new}
/>
) : (
<div className="font-mono flex-grow flex flex-row gap-3">
<span>{name}</span>
{field.field.config?.label && (
<span className="opacity-50">{field.field.config?.label}</span>
)}
</div>
)}
<div className="flex-col gap-1 hidden md:flex">
{is_primary ? (
<>
<MantineSelect
data={["integer", "uuid"]}
defaultValue={primary?.defaultFormat}
disabled={!primary?.editable}
placeholder="Select format"
name={`${prefix}.config.format`}
allowDeselect={false}
control={control}
size="xs"
className="w-22"
/>
</>
) : (
<>
<span className="text-xs text-primary/50 leading-none">Required</span>
<MantineSwitch
size="sm"
name={`${prefix}.config.required`}
control={control}
/>
</>
)}
</div>
</div>
<div className="flex items-end">
<div className="flex flex-row gap-4">
<IconButton
size="lg"
Icon={TbSettings}
disabled={is_primary}
iconProps={{ strokeWidth: 1.5 }}
onClick={() => toggle()}
variant={active ? "primary" : "ghost"}
/>
</div>
</div>
</div>
{active && (
<div className="flex flex-col border-t border-t-muted px-3 py-2 bg-lightest/50">
{/*<pre>{JSON.stringify(field, null, 2)}</pre>*/}
<Tabs defaultValue="general">
<Tabs.List className="flex flex-row">
<Tabs.Tab value="general">General</Tabs.Tab>
<Tabs.Tab value="specific">{ucFirstAllSnakeToPascalWithSpaces(type)}</Tabs.Tab>
<Tabs.Tab value="visibility" disabled>
Visiblity
</Tabs.Tab>
<div className="flex flex-grow" />
<Tabs.Tab value="code" className="!self-end">
Code
</Tabs.Tab>
</Tabs.List>
<Tabs.Panel value="general">
<div className="flex flex-col gap-2 pt-3 pb-1" key={`${prefix}_${type}`}>
<div className="flex flex-row">
<MantineSwitch
label="Required"
name={`${prefix}.config.required`}
control={control}
/>
</div>
<TextInput
label="Label"
placeholder="Label"
{...register(`${prefix}.config.label`)}
/>
<Textarea
label="Description"
placeholder="Description"
{...register(`${prefix}.config.description`)}
/>
{!hidden.includes("virtual") && (
<MantineSwitch
label="Virtual"
name={`${prefix}.config.virtual`}
control={control}
disabled={disabled.includes("virtual")}
/>
)}
</div>
</Tabs.Panel>
<Tabs.Panel value="specific">
<div className="flex flex-col gap-2 pt-3 pb-1">
<ErrorBoundary fallback={`Error rendering JSON Schema for ${type}`}>
<SpecificForm
field={field}
onChange={(value) => {
setValue(`${prefix}.config`, {
...getValues([`fields.${index}.config`])[0],
...value,
});
}}
/>
</ErrorBoundary>
</div>
</Tabs.Panel>
<Tabs.Panel value="code">
{(() => {
const { id, ...json } = field;
return <JsonViewer json={json} expand={4} />;
})()}
</Tabs.Panel>
<div className="flex flex-row justify-end">
<Button
IconLeft={TbTrash}
onClick={handleDelete(index)}
size="small"
variant="subtlered"
>
Delete
</Button>
</div>
</Tabs>
</div>
)}
</div>
);
}
const SpecificForm = ({
field,
onChange,
}: {
field: FieldArrayWithId<TFieldsFormSchema, "fields", "id">;
onChange: (value: any) => void;
}) => {
const type = field.field.type;
const specificData = omit(field.field.config, commonProps);
return (
<JsonSchemaForm
key={type}
schema={specificFieldSchema(type as any)?.toJSON()}
formData={specificData}
uiSchema={dataFieldsUiSchema.config}
className="legacy hide-required-mark fieldset-alternative mute-root"
onChange={onChange}
/>
);
};