Refactor Custom Authenticator Settings Page

.changeset/big-apples-reply.md

@@ -0,0 +1,7 @@
+---
+"@wso2is/admin.connections.v1": patch
+"@wso2is/admin.actions.v1": patch
+"@wso2is/i18n": patch
+---
+
+Refactor Custom Authenticator Settings Page

.changeset/swift-colts-judge.md

@@ -0,0 +1,5 @@
+---
+"@wso2is/admin.connections.v1": patch
+---
+
+Refactor Custom Authenticator Settings Page

features/admin.actions.v1/components/pre-issue-access-token-action-config-form.tsx

@@ -158,7 +158,7 @@ const PreIssueAccessTokenActionConfigForm: FunctionComponent<PreIssueAccessToken
             authenticationType: authenticationType,
             isAuthenticationUpdateFormState: isAuthenticationUpdateFormState,
             isCreateFormState: isCreateFormState
-        }, t);
+        });
     };
 
     const handleSubmit = (

features/admin.actions.v1/components/pre-update-password-action-config-form.tsx

@@ -175,7 +175,7 @@ const PreUpdatePasswordActionConfigForm: FunctionComponent<PreUpdatePasswordActi
             authenticationType: authenticationType,
             isAuthenticationUpdateFormState: isAuthenticationUpdateFormState,
             isCreateFormState: isCreateFormState
-        }, t);
+        });
 
         if (!values?.passwordSharing) {
             customError.passwordSharing = t("actions:fields.passwordSharing.format.validations") as PasswordFormat;

features/admin.actions.v1/util/form-field-util.ts

@@ -16,16 +16,20 @@
  * under the License.
  */
 
-import { URLUtils } from "@wso2is/core/utils";
+import { I18n } from "@wso2is/i18n";
+import { FormValidation } from "@wso2is/validation";
 import { ActionsConstants } from "../constants/actions-constants";
-import { ActionConfigFormPropertyInterface, AuthenticationType } from "../models/actions";
+import {
+    ActionConfigFormPropertyInterface,
+    AuthenticationType,
+    EndpointConfigFormPropertyInterface
+} from "../models/actions";
 
 /**
  * Validates the ActionConfig form fields.
  *
  * @param values - Form values to validate.
  * @param options - Dynamic options for validation (e.g., flags and authenticationType).
- * @param t - localization translations
  * @returns A partial object containing validation errors.
  */
 export const validateActionCommonFields = (
@@ -34,71 +38,110 @@ export const validateActionCommonFields = (
         isCreateFormState: boolean;
         isAuthenticationUpdateFormState: boolean;
         authenticationType?: AuthenticationType;
-    },
-    t: (key: string, options?: any) => string
+    }
 ): Partial<ActionConfigFormPropertyInterface> => {
-    const { isCreateFormState, isAuthenticationUpdateFormState, authenticationType } = options;
     const errors: Partial<ActionConfigFormPropertyInterface> = {};
 
     if (!values?.name) {
-        errors.name = t("actions:fields.name.validations.empty");
+        errors.name = I18n.instance.t("actions:fields.name.validations.empty");
     }
 
     if (!ActionsConstants.ACTION_NAME_REGEX.test(values?.name)) {
-        errors.name = t("actions:fields.name.validations.invalid");
+        errors.name = I18n.instance.t("actions:fields.name.validations.invalid");
     }
+
+    return {
+        ...errors,
+        ...validateActionEndpointFields(values, options)
+    };
+};
+
+/**
+ * Validate endpoint fields of the ActionConfig form.
+ *
+ * @param values - Form values to validate.
+ * @param options - Dynamic options for validation (e.g., flags and authenticationType).
+ * @returns A partial object containing validation errors.
+ */
+export const validateActionEndpointFields = (
+    values: EndpointConfigFormPropertyInterface,
+    options: {
+        isCreateFormState?: boolean;
+        isAuthenticationUpdateFormState: boolean;
+        authenticationType?: AuthenticationType;
+    }
+): Partial<EndpointConfigFormPropertyInterface> => {
+    const { isCreateFormState, isAuthenticationUpdateFormState, authenticationType } = options;
+    const errors: Partial<EndpointConfigFormPropertyInterface> = {};
+
     if (!values?.endpointUri) {
-        errors.endpointUri = t("actions:fields.endpoint.validations.empty");
+        errors.endpointUri = I18n.instance.t("actions:fields.endpoint.validations.empty");
     }
-    if (URLUtils.isURLValid(values?.endpointUri)) {
-        if (!(URLUtils.isHttpsUrl(values?.endpointUri))) {
-            errors.endpointUri = t("actions:fields.endpoint.validations.notHttps");
-        }
-    } else {
-        errors.endpointUri = t("actions:fields.endpoint.validations.invalidUrl");
+
+    if (
+        !FormValidation.url(values?.endpointUri, {
+            domain: {
+                allowUnicode: true,
+                minDomainSegments: 1,
+                tlds: false
+            },
+            scheme: [ "https" ]
+        })
+    ) {
+        errors.endpointUri = I18n.instance.t("actions:fields.endpoint.validations.invalidUrl");
     }
+
     if (!values?.authenticationType) {
-        errors.authenticationType = t("actions:fields.authenticationType.validations.empty");
+        errors.authenticationType = I18n.instance.t("actions:fields.authenticationType.validations.empty");
     }
 
     switch (authenticationType) {
         case AuthenticationType.BASIC:
-            if(isCreateFormState || isAuthenticationUpdateFormState ||
-                values?.usernameAuthProperty || values?.passwordAuthProperty) {
+            if (
+                isCreateFormState || isAuthenticationUpdateFormState || values?.usernameAuthProperty ||
+                    values?.passwordAuthProperty
+            ) {
                 if (!values?.usernameAuthProperty) {
-                    errors.usernameAuthProperty = t("actions:fields.authentication." +
-                        "types.basic.properties.username.validations.empty");
+                    errors.usernameAuthProperty = I18n.instance.t(
+                        "actions:fields.authentication.types.basic.properties.username.validations.empty"
+                    );
                 }
                 if (!values?.passwordAuthProperty) {
-                    errors.passwordAuthProperty = t("actions:fields.authentication." +
-                        "types.basic.properties.password.validations.empty");
+                    errors.passwordAuthProperty = I18n.instance.t(
+                        "actions:fields.authentication.types.basic.properties.password.validations.empty"
+                    );
                 }
             }
 
             break;
         case AuthenticationType.BEARER:
             if (isCreateFormState || isAuthenticationUpdateFormState) {
                 if (!values?.accessTokenAuthProperty) {
-                    errors.accessTokenAuthProperty = t("actions:fields.authentication." +
-                        "types.bearer.properties.accessToken.validations.empty");
+                    errors.accessTokenAuthProperty = I18n.instance.t(
+                        "actions:fields.authentication.types.bearer.properties.accessToken.validations.empty"
+                    );
                 }
             }
 
             break;
         case AuthenticationType.API_KEY:
-            if (isCreateFormState || isAuthenticationUpdateFormState ||
-                values?.headerAuthProperty || values?.valueAuthProperty) {
+            if (isCreateFormState || isAuthenticationUpdateFormState || values?.headerAuthProperty ||
+                   values?.valueAuthProperty
+            ) {
                 if (!values?.headerAuthProperty) {
-                    errors.headerAuthProperty = t("actions:fields.authentication." +
-                        "types.apiKey.properties.header.validations.empty");
+                    errors.headerAuthProperty = I18n.instance.t(
+                        "actions:fields.authentication.types.apiKey.properties.header.validations.empty"
+                    );
                 }
                 if (!ActionsConstants.API_HEADER_REGEX.test(values?.headerAuthProperty)) {
-                    errors.headerAuthProperty = t("actions:fields.authentication." +
-                        "types.apiKey.properties.header.validations.invalid");
+                    errors.headerAuthProperty = I18n.instance.t(
+                        "actions:fields.authentication.types.apiKey.properties.header.validations.invalid"
+                    );
                 }
                 if (!values?.valueAuthProperty) {
-                    errors.valueAuthProperty = t("actions:fields.authentication." +
-                        "types.apiKey.properties.value.validations.empty");
+                    errors.valueAuthProperty = I18n.instance.t(
+                        "actions:fields.authentication.types.apiKey.properties.value.validations.empty"
+                    );
                 }
             }
 

features/admin.connections.v1/api/connections.ts

@@ -17,13 +17,13 @@
  */
 
 import { AsgardeoSPAClient, HttpClientInstance } from "@asgardeo/auth-react";
-import { store } from "@wso2is/admin.core.v1/store";
 import useRequest, {
     RequestConfigInterface,
     RequestErrorInterface,
     RequestResultInterface
 } from "@wso2is/admin.core.v1/hooks/use-request";
 import useResourceEndpoints from "@wso2is/admin.core.v1/hooks/use-resource-endpoints";
+import { store } from "@wso2is/admin.core.v1/store";
 import { IdentityAppsApiException } from "@wso2is/core/exceptions";
 import { HttpMethods } from "@wso2is/core/models";
 import { AxiosError, AxiosRequestConfig, AxiosResponse } from "axios";

features/admin.connections.v1/components/create/custom-authentication-create-wizard.tsx

@@ -534,6 +534,70 @@ const CustomAuthenticationCreateWizard: FunctionComponent<CustomAuthenticationCr
         }
     };
 
+    /**
+     * This method handles custom authenticator create errors.
+     *
+     * @param error - error object.
+     */
+    const handleCustomAuthenticatorCreateErrors = (error: AxiosError): void => {
+        const identityAppsError: IdentityAppsError = ConnectionUIConstants.ERROR_CREATE_LIMIT_REACHED;
+
+        if (
+            error?.response?.status === 403 &&
+                           error?.response?.data?.code === identityAppsError.getErrorCode()
+        ) {
+            setAlert({
+                code: identityAppsError.getErrorCode(),
+                description: t(identityAppsError.getErrorDescription()),
+                level: AlertLevels.ERROR,
+                message: t(identityAppsError.getErrorMessage()),
+                traceId: identityAppsError.getErrorTraceId()
+            });
+            setTimeout(() => setAlert(undefined), 4000);
+
+            return;
+        }
+
+        if (error?.response?.status === 500 && error?.response?.data?.code === "IDP-65002") {
+            setAlert({
+                description: t(
+                    "customAuthentication:notifications.addCustomAuthenticator.genericError.description"
+                ),
+                level: AlertLevels.ERROR,
+                message: t(
+                    "customAuthentication:notifications.addCustomAuthenticator.genericError.message"
+                )
+            });
+            setTimeout(() => setAlert(undefined), 8000);
+
+            return;
+        }
+
+        if (error?.response?.data?.description) {
+            setAlert({
+                description: t(
+                    "customAuthentication:notifications.addCustomAuthenticator.error.description",
+                    {
+                        description: error.response.data.description
+                    }
+                ),
+                level: AlertLevels.ERROR,
+                message: t("customAuthentication:notifications.addCustomAuthenticator.error.message")
+            });
+            setTimeout(() => setAlert(undefined), 4000);
+
+            return;
+        }
+        setAlert({
+            description: t(
+                "customAuthentication:notifications.addCustomAuthenticator.genericError.description"
+            ),
+            level: AlertLevels.ERROR,
+            message: t("customAuthentication:notifications.addCustomAuthenticator.genericError.message")
+        });
+        setTimeout(() => setAlert(undefined), 4000);
+    };
+
     /**
      * This method creates an external authenticator.
      *
@@ -547,9 +611,11 @@ const CustomAuthenticationCreateWizard: FunctionComponent<CustomAuthenticationCr
                 });
                 dispatch(
                     addAlert({
-                        description: t("authenticationProvider:notifications.addIDP.success.description"),
+                        description: t("customAuthentication:notifications.addCustomAuthenticator.success.description"),
                         level: AlertLevels.SUCCESS,
-                        message: t("authenticationProvider:notifications.addIDP.success.message")
+                        message: t(
+                            "customAuthentication:notifications.addCustomAuthenticator.success.message"
+                        )
                     })
                 );
 
@@ -564,50 +630,7 @@ const CustomAuthenticationCreateWizard: FunctionComponent<CustomAuthenticationCr
                 onIDPCreate();
             })
             .catch((error: AxiosError) => {
-                const identityAppsError: IdentityAppsError = ConnectionUIConstants.ERROR_CREATE_LIMIT_REACHED;
-
-                if (error.response.status === 403 && error?.response?.data?.code === identityAppsError.getErrorCode()) {
-                    setAlert({
-                        code: identityAppsError.getErrorCode(),
-                        description: t(identityAppsError.getErrorDescription()),
-                        level: AlertLevels.ERROR,
-                        message: t(identityAppsError.getErrorMessage()),
-                        traceId: identityAppsError.getErrorTraceId()
-                    });
-                    setTimeout(() => setAlert(undefined), 4000);
-
-                    return;
-                }
-
-                if (error?.response.status === 500 && error.response?.data.code === "IDP-65002") {
-                    setAlert({
-                        description: t("authenticationProvider:notifications.addIDP.serverError.description"),
-                        level: AlertLevels.ERROR,
-                        message: t("authenticationProvider:notifications.addIDP.serverError.message")
-                    });
-                    setTimeout(() => setAlert(undefined), 8000);
-
-                    return;
-                }
-
-                if (error.response && error.response.data && error.response.data.description) {
-                    setAlert({
-                        description: t("authenticationProvider:notifications.addIDP.error.description", {
-                            description: error.response.data.description
-                        }),
-                        level: AlertLevels.ERROR,
-                        message: t("authenticationProvider:notifications.addIDP.error.message")
-                    });
-                    setTimeout(() => setAlert(undefined), 4000);
-
-                    return;
-                }
-                setAlert({
-                    description: t("authenticationProvider:notifications.addIDP.genericError.description"),
-                    level: AlertLevels.ERROR,
-                    message: t("authenticationProvider:notifications.addIDP.genericError.message")
-                });
-                setTimeout(() => setAlert(undefined), 4000);
+                handleCustomAuthenticatorCreateErrors(error);
             })
             .finally(() => {
                 setIsSubmitting(false);
@@ -644,50 +667,7 @@ const CustomAuthenticationCreateWizard: FunctionComponent<CustomAuthenticationCr
                 handleSuccessfulAuthenticatorCreate();
             })
             .catch((error: AxiosError) => {
-                const identityAppsError: IdentityAppsError = ConnectionUIConstants.ERROR_CREATE_LIMIT_REACHED;
-
-                if (error.response.status === 403 && error?.response?.data?.code === identityAppsError.getErrorCode()) {
-                    setAlert({
-                        code: identityAppsError.getErrorCode(),
-                        description: t(identityAppsError.getErrorDescription()),
-                        level: AlertLevels.ERROR,
-                        message: t(identityAppsError.getErrorMessage()),
-                        traceId: identityAppsError.getErrorTraceId()
-                    });
-                    setTimeout(() => setAlert(undefined), 4000);
-
-                    return;
-                }
-
-                if (error?.response.status === 500 && error.response?.data.code === "IDP-65002") {
-                    setAlert({
-                        description: t("authenticationProvider:notifications.addIDP.serverError.description"),
-                        level: AlertLevels.ERROR,
-                        message: t("authenticationProvider:notifications.addIDP.serverError.message")
-                    });
-                    setTimeout(() => setAlert(undefined), 8000);
-
-                    return;
-                }
-
-                if (error.response && error.response.data && error.response.data.description) {
-                    setAlert({
-                        description: t("authenticationProvider:notifications.addIDP.error.description", {
-                            description: error.response.data.description
-                        }),
-                        level: AlertLevels.ERROR,
-                        message: t("authenticationProvider:notifications.addIDP.error.message")
-                    });
-                    setTimeout(() => setAlert(undefined), 4000);
-
-                    return;
-                }
-                setAlert({
-                    description: t("authenticationProvider:notifications.addIDP.genericError.description"),
-                    level: AlertLevels.ERROR,
-                    message: t("authenticationProvider:notifications.addIDP.genericError.message")
-                });
-                setTimeout(() => setAlert(undefined), 4000);
+                handleCustomAuthenticatorCreateErrors(error);
             })
             .finally(() => {
                 setIsSubmitting(false);