1663: Renames formProvider to apiProvider

Author: Ruben van Leeuwen

frontend/packages/pydantic-forms/src/core/PydanticFormContextProvider.tsx

@@ -27,7 +27,7 @@ import {
     getFormValuesFromFieldOrLabels,
 } from '@/core/helper';
 import {
-    usePydanticForm,
+    useApiProvider,
     usePydanticFormParser,
     useRefParser,
 } from '@/core/hooks';
@@ -78,7 +78,7 @@ function PydanticFormContextProvider({
     const {
         customDataProvider,
         labelProvider,
-        formProvider,
+        apiProvider,
         fieldDetailProvider,
         onFieldChangeHandler,
         customDataProviderCacheKey,
@@ -93,6 +93,7 @@ function PydanticFormContextProvider({
         cancelButton,
     } = config;
 
+    // TODO: Fix this again
     // option to enable the debug mode on the fly in the browser
     // by setting localStorage.setItem("pydanticFormsDebugMode", "true")
     // reload is required
@@ -111,18 +112,23 @@ function PydanticFormContextProvider({
     const { data: formLabels, isLoading: isLoadingFormLabels } =
         useLabelProvider(labelProvider, formKey, formIdKey);
 
-    const { data: customData, isLoading: isCustomDataLoading } =
+    const { data: customData, isLoading: isLoadingCustomData } =
         useCustomDataProvider(
             customDataProviderCacheKey ?? 100,
             customDataProvider,
         );
 
     // fetch the form definition using SWR hook
+    // 1. Called and returns with 510 code and form schema in payload
+    // 2. Called with form payload
+    //    - form_validation errors => 400
+    //    - success => 200
+    //    - second step? 510 with form definition
     const {
         data: apiResponse,
         isLoading: isLoadingSchema,
         error,
-    } = usePydanticForm(formKey, formInputData, formProvider, metaData);
+    } = useApiProvider(formKey, formInputData, apiProvider, metaData);
 
     // we cache the form scheme so when there is an error, we still have the form
     // the form is not in the error response
@@ -355,7 +361,7 @@ function PydanticFormContextProvider({
         isLoadingFormLabels ||
         isLoadingSchema ||
         isLoadingSchema ||
-        (customDataProvider ? isCustomDataLoading : false);
+        (customDataProvider ? isLoadingCustomData : false);
 
     const PydanticFormContextState = {
         // to prevent an issue where the sending state hangs

frontend/packages/pydantic-forms/src/core/helper.ts

@@ -7,7 +7,7 @@ import { ControllerRenderProps, FieldValues, useForm } from 'react-hook-form';
 
 import fieldsConfig from '@/components/config';
 import {
-    PydanticFormApiErrorResponse,
+    PydanticFormApiResponse,
     PydanticFormApiResponsePropertyResolved,
     PydanticFormData,
     PydanticFormField,
@@ -27,7 +27,7 @@ import { insertItemAtIndex } from '@/utils';
  * @returns A object better usable for displaying errors
  */
 export const getErrorDetailsFromResponse = function (
-    apiErrorResp: PydanticFormApiErrorResponse,
+    apiErrorResp: PydanticFormApiResponse,
 ) {
     return {
         detail: apiErrorResp.detail ?? '',

frontend/packages/pydantic-forms/src/core/hooks/index.ts

@@ -1,3 +1,3 @@
-export * from './usePydanticForm';
+export * from './useApiProvider';
 export * from './useRefParser';
 export * from './usePydanticFormParser';

…forms/src/core/hooks/usePydanticForm.tsx …-forms/src/core/hooks/useApiProvider.tsxfrontend/packages/pydantic-forms/src/core/hooks/usePydanticForm.tsx renamed to frontend/packages/pydantic-forms/src/core/hooks/useApiProvider.tsx frontend/packages/pydantic-forms/src/core/hooks/usePydanticForm.tsx renamed to frontend/packages/pydantic-forms/src/core/hooks/useApiProvider.tsx

@@ -17,9 +17,9 @@
 import useSWR, { SWRConfiguration } from 'swr';
 
 import type {
-    PydanticFormApiErrorResponse,
+    PydanticFormApiProvider,
+    PydanticFormApiResponse,
     PydanticFormMetaData,
-    PydanticFormProvider,
 } from '@/types';
 
 const ignoreApiErrors = async (
@@ -35,15 +35,15 @@ const ignoreApiErrors = async (
     }
 };
 
-export function usePydanticForm(
+export function useApiProvider(
     formKey: string,
     formInputData: PydanticFormMetaData, // TODO: This doesn't seem right
-    formProvider: PydanticFormProvider,
+    apiProvider: PydanticFormApiProvider,
     metaData?: PydanticFormMetaData,
     cacheKey?: number,
     swrConfig?: SWRConfiguration,
 ) {
-    return useSWR<PydanticFormApiErrorResponse>(
+    return useSWR<PydanticFormApiResponse>(
         // cache key
         [formKey, formInputData, metaData, swrConfig, cacheKey],
 
@@ -52,12 +52,12 @@ export function usePydanticForm(
             // TODO: Readd sending metadata along with request
             const requestBody = formInputData;
 
-            const formProviderRequest = formProvider({
+            const apiProviderRequest = apiProvider({
                 formKey,
                 requestBody,
             });
             const req = (await ignoreApiErrors(
-                formProviderRequest,
+                apiProviderRequest,
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
             )) as any;
 

frontend/packages/pydantic-forms/src/types.ts

@@ -298,7 +298,7 @@ export interface PydanticFormsContextConfig {
     formStructureMutator?: PydanticFormStructureMutator;
 
     // use a custom method for providing the form definition
-    formProvider: PydanticFormProvider;
+    apiProvider: PydanticFormApiProvider;
 
     // Extend field definitions
     fieldDetailProvider?: PydanticFormFieldDetailProvider;
@@ -348,7 +348,7 @@ export type PydanticFormStructureMutator = (
     formData: PydanticFormData | false,
 ) => PydanticFormData | false;
 
-export type PydanticFormProvider = ({
+export type PydanticFormApiProvider = ({
     formKey,
     requestBody,
 }: {
@@ -378,20 +378,20 @@ export type PydanticFormCustomValidationRuleFn = (
     rhf?: ReturnType<typeof useForm>,
 ) => Zod.ZodTypeAny | undefined;
 
-export interface PydanticFormApiErrorResponse {
+export interface PydanticFormApiResponse {
     detail?: string;
     status: number;
-    form: PydanticFormApiResponse;
+    form: PydanticFormSchema;
     success?: boolean;
     validation_errors: PydanticFormApiValidationError[];
 }
 
-export interface PydanticFormApiResponse extends PydanticFormApiResponseBase {
+export interface PydanticFormSchema extends PydanticFormSchemaBase {
     properties: {
         [propId: string]: PydanticFormApiResponseProperty;
     };
 }
-export interface PydanticFormApiResponseBase {
+export interface PydanticFormSchemaBase {
     title: string;
     description: string;
     additionalProperties: boolean;
@@ -422,8 +422,7 @@ export interface JsonSchemaRef {
     $ref: string;
 }
 
-export interface PydanticFormApiRefResolved
-    extends PydanticFormApiResponseBase {
+export interface PydanticFormApiRefResolved extends PydanticFormSchemaBase {
     properties: {
         [propId: string]: PydanticFormApiResponsePropertyResolved;
     };