1663: Renames data provider to custom data provider

Author: Ruben van Leeuwen

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

@@ -76,12 +76,12 @@ function PydanticFormContextProvider({
     config,
 }: PydanticFormInitialContextProps) {
     const {
-        customDataProvider: dataProvider,
+        customDataProvider,
         labelProvider,
         formProvider,
         fieldDetailProvider,
         onFieldChangeHandler,
-        dataProviderCacheKey,
+        customDataProviderCacheKey,
         resetButtonAlternative,
         footerCtaPrimaryVariant = 'purple',
         customValidationRules,
@@ -112,7 +112,10 @@ function PydanticFormContextProvider({
         useLabelProvider(labelProvider, formKey, formIdKey);
 
     const { data: customData, isLoading: isCustomDataLoading } =
-        useCustomDataProvider(dataProviderCacheKey ?? 100, dataProvider);
+        useCustomDataProvider(
+            customDataProviderCacheKey ?? 100,
+            customDataProvider,
+        );
 
     // fetch the form definition using SWR hook
     const {
@@ -345,7 +348,8 @@ function PydanticFormContextProvider({
     const isLoading =
         isLoadingFormLabels ||
         isLoadingSchema ||
-        (dataProvider ? isCustomDataLoading : false);
+        isLoadingSchema ||
+        (customDataProvider ? isCustomDataLoading : false);
 
     const PydanticFormContextState = {
         // to prevent an issue where the sending state hangs
@@ -361,7 +365,7 @@ function PydanticFormContextProvider({
         sendLabel,
         debugMode,
         isFullFilled,
-        dataProvider,
+        customDataProvider,
         errorDetails,
         formLayout,
         successNotice,

frontend/packages/pydantic-forms/src/core/hooks/useCustomDataProvider.tsx

@@ -1,23 +1,22 @@
 import useSWR from 'swr';
-import { FetcherResponse } from 'swr/dist/_internal';
 
-import { PydanticFormApiErrorResponse, PydanticFormLabels } from '@/types';
+import { PydanticFormCustomDataProvider, PydanticFormLabels } from '@/types';
 
 const useCustomDataProvider = (
     cacheKey: number,
-    promiseFn?: () => FetcherResponse<PydanticFormLabels>,
+    customDataProvider?: PydanticFormCustomDataProvider,
 ) => {
-    return useSWR<PydanticFormApiErrorResponse | object>(
+    return useSWR<PydanticFormLabels>(
         // cache key
         [`pydanticFormsDataProvider-${cacheKey}`],
 
         // return val
         () => {
-            if (!promiseFn) {
+            if (!customDataProvider) {
                 return {};
             }
 
-            return promiseFn();
+            return customDataProvider();
         },
 
         // swr config

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

@@ -282,7 +282,7 @@ export interface PydanticFormZodValidationPresets {
 
 export interface PydanticFormsContextConfig {
     // use custom method to provide data for the form. This overwrites data fetched from labels endpoint
-    customDataProvider?: PydanticFormDataProvider;
+    customDataProvider?: PydanticFormCustomDataProvider;
 
     // use custom method for providing labels and data
     labelProvider?: PydanticFormLabelProvider;
@@ -300,7 +300,7 @@ export interface PydanticFormsContextConfig {
     fieldDetailProvider?: PydanticFormFieldDetailProvider;
 
     // be able to refresh the provided data
-    dataProviderCacheKey?: number;
+    customDataProviderCacheKey?: number;
 
     // whenever a fieldvalue changes, do something
     onFieldChangeHandler?: onPydanticFormFieldChangeHandlerFn;
@@ -322,8 +322,7 @@ export interface PydanticFormsContextConfig {
 
     footerCtaPrimaryVariant?: string;
 }
-
-export type PydanticFormDataProvider = () => Promise<PydanticFormLabels>;
+export type PydanticFormCustomDataProvider = () => Promise<PydanticFormLabels>;
 
 export interface PydanticFormLabels {
     [key: string]: string[] | number[] | string | number | null;