Merge pull request #7613 from Shenali-SJ/custom-auth-refactor-termino…

…logy
wso2 · Feb 15, 2025 · ecae135 · ecae135
2 parents 4b16760 + 9279555
commit ecae135
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 15 deletions.
diff --git a/.changeset/silver-singers-bow.md b/.changeset/silver-singers-bow.md
@@ -0,0 +1,5 @@
+---
+"@wso2is/admin.connections.v1": patch
+---
+
+Refactor UX and Terminology of Custom Connector and Custom Authenticator
diff --git a/features/admin.connections.v1/components/create/authenticator-create-wizard-factory.tsx b/features/admin.connections.v1/components/create/authenticator-create-wizard-factory.tsx
@@ -337,7 +337,8 @@ export const AuthenticatorCreateWizardFactory: FC<AuthenticatorCreateWizardFacto
                     <ExpertModeAuthenticationProviderCreateWizard
                         title={
                             selectedTemplateWithUniqueName?.name === "Expert Mode"
-                                ? "Custom Connector"
+                                ? t("authenticationProvider:overrides.authenticators.customAuthenticators." +
+                                    "pluginBased.name")
                                 : selectedTemplateWithUniqueName?.name
                         }
                         subTitle={ selectedTemplateWithUniqueName?.description }

diff --git a/features/admin.connections.v1/constants/common-authenticator-constants.ts b/features/admin.connections.v1/constants/common-authenticator-constants.ts
@@ -99,5 +99,5 @@ export class CommonAuthenticatorConstants {
     public static readonly IDENTIFIER_REGEX: RegExp = /^[a-zA-Z0-9_-]{3,}$/;
     public static readonly DISPLAY_NAME_REGEX: RegExp = /^.{3,}$/;
 
-    public static readonly TEMPLATE_ID_FIELD: "templateId";
+    public static readonly TEMPLATE_ID_FIELD: string = "templateId";
 }
diff --git a/features/admin.connections.v1/meta/templates-meta/groups/custom-authenticator.json b/features/admin.connections.v1/meta/templates-meta/groups/custom-authenticator.json
@@ -6,7 +6,7 @@
     "id": "custom-authenticator",
     "docLink": "",
     "image": "assets/images/logos/custom-authenticator.svg",
-    "name": "Custom Authenticator",
+    "name": "Custom Authenticator (Service-based)",
     "services": [],
     "disabled": false,
     "type": "DEFAULT",

diff --git a/features/admin.connections.v1/pages/connection-edit.tsx b/features/admin.connections.v1/pages/connection-edit.tsx
@@ -386,11 +386,11 @@ const ConnectionEditPage: FunctionComponent<ConnectionEditPagePropsInterface> =
                 if (error.response && error.response.data && error.response.data.description) {
                     dispatch(
                         addAlert({
-                            description: t("authenticationProvider:" + "notifications.getIDP.error.description", {
+                            description: t("authenticationProvider:notifications.getIDP.error.description", {
                                 description: error.response.data.description
                             }),
                             level: AlertLevels.ERROR,
-                            message: t("authenticationProvider:" + "notifications.getIDP.error.message")
+                            message: t("authenticationProvider:notifications.getIDP.error.message")
                         })
                     );
 
@@ -399,9 +399,9 @@ const ConnectionEditPage: FunctionComponent<ConnectionEditPagePropsInterface> =
 
                 dispatch(
                     addAlert({
-                        description: t("authenticationProvider:" + "notifications.getIDP.genericError.description"),
+                        description: t("authenticationProvider:notifications.getIDP.genericError.description"),
                         level: AlertLevels.ERROR,
-                        message: t("authenticationProvider:" + "notifications.getIDP.genericError.message")
+                        message: t("authenticationProvider:notifications.getIDP.genericError.message")
                     })
                 );
             })
@@ -434,12 +434,12 @@ const ConnectionEditPage: FunctionComponent<ConnectionEditPagePropsInterface> =
                         dispatch(
                             addAlert({
                                 description: t(
-                                    "authenticationProvider:" + "notifications.getConnectionDetails.error.description",
+                                    "authenticationProvider:notifications.getConnectionDetails.error.description",
                                     { description: error.response.data.description }
                                 ),
                                 level: AlertLevels.ERROR,
                                 message: t(
-                                    "authenticationProvider:" + "notifications.getConnectionDetails.error.message"
+                                    "authenticationProvider:notifications.getConnectionDetails.error.message"
                                 )
                             })
                         );
@@ -455,7 +455,7 @@ const ConnectionEditPage: FunctionComponent<ConnectionEditPagePropsInterface> =
                             ),
                             level: AlertLevels.ERROR,
                             message: t(
-                                "authenticationProvider:" + "notifications.getConnectionDetails.genericError.message"
+                                "authenticationProvider:notifications.getConnectionDetails.genericError.message"
                             )
                         })
                     );
@@ -538,15 +538,15 @@ const ConnectionEditPage: FunctionComponent<ConnectionEditPagePropsInterface> =
             return (
                 <LabelWithPopup
                     popupHeader={ t("authenticationProvider:popups.appStatus.enabled.header") }
-                    popupSubHeader={ t("authenticationProvider:popups.appStatus." + "enabled.content") }
+                    popupSubHeader={ t("authenticationProvider:popups.appStatus.enabled.content") }
                     labelColor="green"
                 />
             );
         } else {
             return (
                 <LabelWithPopup
-                    popupHeader={ t("authenticationProvider:popups.appStatus." + "disabled.header") }
-                    popupSubHeader={ t("authenticationProvider:popups.appStatus." + "disabled.content") }
+                    popupHeader={ t("authenticationProvider:popups.appStatus.disabled.header") }
+                    popupSubHeader={ t("authenticationProvider:popups.appStatus.disabled.content") }
                     labelColor="grey"
                 />
             );
@@ -650,7 +650,8 @@ const ConnectionEditPage: FunctionComponent<ConnectionEditPagePropsInterface> =
                     { identityProviderTemplate?.name && (
                         <Label size="small">
                             { identityProviderTemplate.name === "Expert Mode"
-                                ? "Custom Connector"
+                                ? t("authenticationProvider:overrides.authenticators.customAuthenticators." +
+                                    "pluginBased.name")
                                 : identityProviderTemplate?.name }
                         </Label>
                     ) }

diff --git a/features/admin.connections.v1/utils/connection-utils.ts b/features/admin.connections.v1/utils/connection-utils.ts
@@ -320,7 +320,7 @@ export const resolveConnectionName = (name: string): string => {
     if (name === "Enterprise") {
         return "Standard-Based IdP";
     } else if (name === "Expert Mode") {
-        return "Custom Connector";
+        return I18n.instance.t("authenticationProvider:overrides.authenticators.customAuthenticators.pluginBased.name");
     } else {
         return name;
     }

diff --git a/modules/i18n/src/models/namespaces/authentication-provider-ns.ts b/modules/i18n/src/models/namespaces/authentication-provider-ns.ts
@@ -2052,4 +2052,13 @@ export interface AuthenticationProviderNS {
             previous: string;
         };
     };
+    overrides: {
+        authenticators: {
+            customAuthenticators: {
+                pluginBased: {
+                    name: string;
+                }
+            }
+        }
+    }
 }
diff --git a/modules/i18n/src/translations/en-US/portals/authentication-provider.ts b/modules/i18n/src/translations/en-US/portals/authentication-provider.ts
@@ -2133,5 +2133,14 @@ export const authenticationProvider:AuthenticationProviderNS = {
             next: "Next",
             previous: "Previous"
         }
+    },
+    overrides: {
+        authenticators: {
+            customAuthenticators: {
+                pluginBased: {
+                    name: "Custom Authenticator (Plugin-based)"
+                }
+            }
+        }
     }
 };