hazo_auth 1.4.2 → 1.6.0

package/src/components/layouts/shared/hooks/use_hazo_auth.ts

@@ -1,158 +0,0 @@
-// file_description: React hook for hazo_get_auth utility (client-side)
-// section: client_directive
-"use client";
-
-// section: imports
-import { useState, useEffect, useCallback } from "react";
-import type { HazoAuthResult } from "../../../../lib/auth/auth_types";
-
-// section: types
-
-/**
- * Options for use_hazo_auth hook
- */
-export type UseHazoAuthOptions = {
-  /**
-   * Array of required permissions to check
-   */
-  required_permissions?: string[];
-  /**
-   * If true, throws error when permissions are missing (default: false)
-   */
-  strict?: boolean;
-  /**
-   * Skip fetch (for conditional use)
-   */
-  skip?: boolean;
-};
-
-/**
- * Result type for use_hazo_auth hook
- */
-export type UseHazoAuthResult = HazoAuthResult & {
-  /**
-   * Loading state
-   */
-  loading: boolean;
-  /**
-   * Error state
-   */
-  error: Error | null;
-  /**
-   * Manual refetch function
-   */
-  refetch: () => Promise<void>;
-};
-
-// section: constants
-const AUTH_STATUS_CHANGE_EVENT = "hazo_auth_status_change";
-
-// section: helpers
-
-/**
- * Triggers a refresh of hazo_auth status across all components
- * Dispatches a custom event that all use_hazo_auth hooks listen to
- */
-export function trigger_hazo_auth_refresh(): void {
-  if (typeof window !== "undefined") {
-    window.dispatchEvent(
-      new CustomEvent(AUTH_STATUS_CHANGE_EVENT),
-    );
-  }
-}
-
-// section: hook
-
-/**
- * React hook for hazo_get_auth utility
- * Fetches authentication status and permissions from /api/auth/get_auth
- * @param options - Optional parameters for permission checking
- * @returns UseHazoAuthResult with auth data, loading state, and refetch function
- */
-export function use_hazo_auth(
-  options?: UseHazoAuthOptions,
-): UseHazoAuthResult {
-  const [authResult, setAuthResult] = useState<HazoAuthResult>({
-    authenticated: false,
-    user: null,
-    permissions: [],
-    permission_ok: false,
-  });
-  const [loading, setLoading] = useState<boolean>(true);
-  const [error, setError] = useState<Error | null>(null);
-
-  const fetchAuth = useCallback(async () => {
-    if (options?.skip) {
-      setLoading(false);
-      return;
-    }
-
-    setLoading(true);
-    setError(null);
-
-    try {
-      const response = await fetch("/api/hazo_auth/get_auth", {
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        credentials: "include",
-        body: JSON.stringify({
-          required_permissions: options?.required_permissions,
-          strict: options?.strict || false,
-        }),
-      });
-
-      if (!response.ok) {
-        const error_data = await response.json();
-        throw new Error(
-          error_data.user_friendly_message ||
-            error_data.error ||
-            "Failed to fetch authentication status",
-        );
-      }
-
-      const data = await response.json();
-      setAuthResult(data);
-    } catch (err) {
-      const error_message =
-        err instanceof Error ? err : new Error("Unknown error");
-      setError(error_message);
-      setAuthResult({
-        authenticated: false,
-        user: null,
-        permissions: [],
-        permission_ok: false,
-      });
-    } finally {
-      setLoading(false);
-    }
-  }, [options?.required_permissions, options?.strict, options?.skip]);
-
-  useEffect(() => {
-    // Fetch auth status on mount
-    void fetchAuth();
-
-    // Listen for auth status change events
-    const handleAuthChange = () => {
-      void fetchAuth();
-    };
-
-    window.addEventListener(AUTH_STATUS_CHANGE_EVENT, handleAuthChange);
-
-    return () => {
-      window.removeEventListener(
-        AUTH_STATUS_CHANGE_EVENT,
-        handleAuthChange,
-      );
-    };
-  }, [fetchAuth]);
-
-  return {
-    ...authResult,
-    loading,
-    error,
-    refetch: fetchAuth,
-  };
-}
-

package/src/components/layouts/shared/index.ts

@@ -1,34 +0,0 @@
-// file_description: barrel export for shared layout components, hooks, and utilities
-// section: component_exports
-export { AlreadyLoggedInGuard } from "./components/already_logged_in_guard";
-export { AuthPageShell } from "./components/auth_page_shell";
-export { FieldErrorMessage } from "./components/field_error_message";
-export { FormActionButtons } from "./components/form_action_buttons";
-export { FormFieldWrapper } from "./components/form_field_wrapper";
-export { FormHeader } from "./components/form_header";
-export { LogoutButton } from "./components/logout_button";
-export { PasswordField } from "./components/password_field";
-export { ProfilePicMenuWrapper } from "./components/profile_pic_menu_wrapper";
-export { ProfilePicMenu } from "./components/profile_pic_menu";
-export { SidebarLayoutWrapper } from "./components/sidebar_layout_wrapper";
-export { StandaloneLayoutWrapper } from "./components/standalone_layout_wrapper";
-export { TwoColumnAuthLayout } from "./components/two_column_auth_layout";
-export { UnauthorizedGuard } from "./components/unauthorized_guard";
-export { VisualPanel } from "./components/visual_panel";
-
-// section: hook_exports
-export { use_auth_status } from "./hooks/use_auth_status";
-export { use_hazo_auth, trigger_hazo_auth_refresh } from "./hooks/use_hazo_auth";
-export type { UseHazoAuthOptions, UseHazoAuthResult } from "./hooks/use_hazo_auth";
-
-// section: config_exports
-export * from "./config/layout_customization";
-
-// section: data_exports
-export { createLayoutDataClient } from "./data/layout_data_client";
-export type { LayoutDataClient } from "./data/layout_data_client";
-
-// section: utility_exports
-export { get_client_ip } from "./utils/ip_address";
-export * from "./utils/validation";
-

package/src/components/layouts/shared/utils/ip_address.ts

@@ -1,37 +0,0 @@
-// file_description: utility functions for collecting client IP address
-// section: client_ip_collection
-/**
- * Attempts to get the client IP address
- * In browser context, this will try to fetch from an API endpoint
- * Falls back to "unknown" if unable to determine
- */
-export async function get_client_ip(): Promise<string> {
-  // Check if fetch is available (not available in test environment)
-  if (typeof fetch === "undefined") {
-    return "unknown";
-  }
-
-  try {
-    // Try to get IP from a public IP detection service
-    const response = await fetch("https://api.ipify.org?format=json", {
-      method: "GET",
-      headers: {
-        "Accept": "application/json",
-      },
-    });
-
-    if (response.ok) {
-      const data = await response.json();
-      return data.ip || "unknown";
-    }
-  } catch (error) {
-    // Silently fail and return unknown
-    // Only log in non-test environments
-    if (process.env.NODE_ENV !== "test") {
-      console.debug("Failed to fetch IP address:", error);
-    }
-  }
-
-  return "unknown";
-}
-

package/src/components/layouts/shared/utils/validation.ts

@@ -1,66 +0,0 @@
-// file_description: provide shared validation utilities for email and password fields across layout components
-// section: imports
-import type { PasswordRequirementOptions } from "../config/layout_customization";
-
-// section: constants
-const EMAIL_PATTERN = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-
-// section: email_validation
-/**
- * Validates an email address format
- * @param email - The email address to validate
- * @returns Error message string if invalid, undefined if valid
- */
-export function validateEmail(email: string): string | undefined {
-  const trimmedEmail = email.trim();
-  if (trimmedEmail.length > 0 && !EMAIL_PATTERN.test(trimmedEmail)) {
-    return "enter a valid email address";
-  }
-  return undefined;
-}
-
-// section: password_validation
-/**
- * Validates a password against specified requirements
- * @param password - The password to validate
- * @param requirements - Password requirement options
- * @returns Array of error message strings if invalid, undefined if valid
- */
-export function validatePassword(
-  password: string,
-  requirements: PasswordRequirementOptions,
-): string[] | undefined {
-  if (password.trim().length === 0) {
-    return undefined;
-  }
-
-  const messages: string[] = [];
-
-  if (password.length < requirements.minimum_length) {
-    messages.push(
-      `Password must be at least ${requirements.minimum_length} characters.`,
-    );
-  }
-
-  if (requirements.require_uppercase && !/[A-Z]/.test(password)) {
-    messages.push("Password must include at least one uppercase letter.");
-  }
-
-  if (requirements.require_lowercase && !/[a-z]/.test(password)) {
-    messages.push("Password must include at least one lowercase letter.");
-  }
-
-  if (requirements.require_number && !/\d/.test(password)) {
-    messages.push("Password must include at least one number.");
-  }
-
-  if (
-    requirements.require_special &&
-    !/[!@#$%^&*(),.?":{}|<>\-_+=\[\];'/\\]/.test(password)
-  ) {
-    messages.push("Password must include at least one special character.");
-  }
-
-  return messages.length > 0 ? messages : undefined;
-}
-