storybooks second release

stories/login/pages/LoginIdpLinkEmail.stories.tsx

@@ -2,6 +2,20 @@ import React from "react";
 import type { Meta, StoryObj } from "@storybook/react";
 import { createKcPageStory } from "../KcPageStory";
 
+// Mock kcContext to avoid TS2304 error and to simulate the real environment
+const mockKcContext = {
+    url: {
+        loginAction: "/login-action"
+    },
+    idpAlias: "mockIdpAlias",
+    brokerContext: {
+        username: "mockUser"
+    },
+    realm: {
+        displayName: "MockRealm"
+    }
+};
+
 const { KcPageStory } = createKcPageStory({ pageId: "login-idp-link-email.ftl" });
 
 const meta = {
@@ -13,13 +27,27 @@ export default meta;
 
 type Story = StoryObj<typeof meta>;
 
+/**
+ * Default:
+ * - Purpose: Tests the default behavior with mock data.
+ * - Scenario: The component renders with a mocked identity provider alias (`mockIdpAlias`), a default broker username (`mockUser`), and a default realm name (`MockRealm`).
+ * - Key Aspect: Ensures the default behavior of the component with typical kcContext values.
+ */
 export const Default: Story = {
-    render: () => <KcPageStory />
+    render: () => <KcPageStory kcContext={mockKcContext} />
 };
+
+/**
+ * WithIdpAlias:
+ * - Purpose: Tests behavior when the idpAlias is set to "Google".
+ * - Scenario: Simulates the component being used with a Google identity provider, showing the username "john.doe" and realm "MyRealm".
+ * - Key Aspect: Ensures the correct identity provider alias ("Google") and broker context (user info) are displayed in the email linking instructions.
+ */
 export const WithIdpAlias: Story = {
     render: () => (
         <KcPageStory
             kcContext={{
+                ...mockKcContext,
                 idpAlias: "Google",
                 brokerContext: {
                     username: "john.doe"
@@ -31,32 +59,47 @@ export const WithIdpAlias: Story = {
         />
     )
 };
-export const WithoutIdpAlias: Story = {
+
+/**
+ * WithCustomRealmDisplayName:
+ * - Purpose: Tests behavior when the realm display name is customized.
+ * - Scenario: Simulates the component with a Facebook identity provider, a broker username "jane.doe", and a custom realm name "CustomRealm".
+ * - Key Aspect: Ensures that custom realm display names are rendered correctly alongside the idpAlias and broker context.
+ */
+export const WithCustomRealmDisplayName: Story = {
     render: () => (
         <KcPageStory
             kcContext={{
-                idpAlias: undefined,
+                ...mockKcContext,
+                idpAlias: "Facebook",
                 brokerContext: {
-                    username: "john.doe"
+                    username: "jane.doe"
                 },
                 realm: {
-                    displayName: "MyRealm"
+                    displayName: "CUSTOM REALM DISPLAY NAME"
                 }
             }}
         />
     )
 };
 
-export const WithCustomRealmDisplayName: Story = {
+/**
+ * WithFormSubmissionError:
+ * - Purpose: Tests how the component handles form submission errors.
+ * - Scenario: Simulates a form submission error by setting the login action URL to `/error` and displays an error message.
+ * - Key Aspect: Verifies that the component can display error messages during form submission failure, ensuring proper error handling.
+ */
+export const WithFormSubmissionError: Story = {
     render: () => (
         <KcPageStory
             kcContext={{
-                idpAlias: "Facebook",
-                brokerContext: {
-                    username: "jane.doe"
+                ...mockKcContext,
+                url: {
+                    loginAction: "/error"
                 },
-                realm: {
-                    displayName: "CustomRealm"
+                message: {
+                    type: "error",
+                    summary: "An error occurred during form submission."
                 }
             }}
         />