Update types

cloudquery · Oct 7, 2024 · a371b1b · a371b1b
1 parent c0bd3dd
commit a371b1b
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 7 deletions.
diff --git a/etc/plugin-config-ui-lib.api.md b/etc/plugin-config-ui-lib.api.md
@@ -595,8 +595,8 @@ export interface PluginConfig {
 export type PluginConfigFormStep = {
     children: (IterableStepComponent | React_2.FC<any>)[];
     title: string;
-    submitGuard?: (formValues: any, callApi: ReturnType<typeof useApiCall>['callApi']) => Promise<boolean | {
-        error: string;
+    submitGuard?: (formValues: any, teamName: string, callApi: ReturnType<typeof useApiCall>['callApi']) => Promise<boolean | {
+        errorMessage: string;
     }>;
 };
 

diff --git a/src/components/form/configUIForm.tsx b/src/components/form/configUIForm.tsx
@@ -145,11 +145,12 @@ export function ConfigUIForm({ prepareSubmitValues }: ConfigUIFormProps) {
     const thisStep = getValues('_step');
 
     if (config.steps[thisStep]?.submitGuard) {
-      const result = await config.steps[thisStep]?.submitGuard(getValues(), callApi);
-      const resultError = typeof result === 'object' && 'error' in result && result.error;
-      if (result === false || resultError) {
+      const result = await config.steps[thisStep]?.submitGuard(getValues(), teamName, callApi);
+      const resultErrorMessage =
+        typeof result === 'object' && 'errorMessage' in result && result.errorMessage;
+      if (result === false || resultErrorMessage) {
         setError('root', {
-          message: resultError || 'Validation failed. Please check the form for errors.',
+          message: resultErrorMessage || 'Validation failed. Please check the form for errors.',
         });
 
         return;

diff --git a/src/types.ts b/src/types.ts
@@ -49,8 +49,9 @@ export type PluginConfigFormStep = {
   title: string;
   submitGuard?: (
     formValues: any,
+    teamName: string,
     callApi: ReturnType<typeof useApiCall>['callApi'],
-  ) => Promise<boolean | { error: string }>;
+  ) => Promise<boolean | { errorMessage: string }>;
 };
 
 /**