@zango-core/appbuilder 1.0.0-rc.1

package/dist/types/types/common.d.ts

@@ -0,0 +1,343 @@
+/**
+ * Common type definitions for the application
+ * Reduces the need for `any` types
+ */
+/**
+ * Generic API response wrapper (auth-specific variant with optional response)
+ */
+export interface AuthApiEnvelope<T = unknown> {
+    success: boolean;
+    response?: T;
+    message?: string;
+    errors?: Record<string, string[]>;
+}
+/**
+ * Paginated response
+ */
+export interface PaginatedResponse<T> {
+    count: number;
+    next: string | null;
+    previous: string | null;
+    results: T[];
+}
+/**
+ * ID-only reference
+ */
+export interface Ref {
+    id: string | number;
+}
+/**
+ * Timestamp fields
+ */
+export interface Timestamps {
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Common metadata
+ */
+export interface Metadata {
+    [key: string]: string | number | boolean | null;
+}
+/**
+ * Form field error
+ */
+export interface FieldError {
+    field: string;
+    message: string;
+}
+/**
+ * Validation result
+ */
+export interface ValidationResult {
+    valid: boolean;
+    errors: FieldError[];
+}
+/**
+ * API client configuration (for direct API clients)
+ */
+export interface ApiClientConfig {
+    baseUrl: string;
+    apiVersion?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+/**
+ * Request options
+ */
+export interface RequestOptions {
+    headers?: Record<string, string>;
+    params?: Record<string, string | number | boolean>;
+    timeout?: number;
+}
+/**
+ * API error response
+ */
+export interface ApiErrorResponse {
+    message: string;
+    code?: string;
+    details?: Record<string, unknown>;
+    status: number;
+}
+/**
+ * Generic API handler response
+ */
+export type ApiHandlerResponse<T> = AuthApiEnvelope<T> & {
+    responseStatus?: number;
+    errorType?: string;
+};
+/**
+ * Nested API response shape returned by authService methods.
+ * The auth API wraps data in several envelope formats depending on the
+ * HTTP status and whether the response came through axios or fetch.
+ */
+export interface AuthApiResponse {
+    status?: number;
+    data?: AuthResponseData;
+    response?: {
+        status?: number;
+        data?: AuthResponseData;
+        meta?: {
+            is_authenticated?: boolean;
+        };
+    };
+    meta?: {
+        is_authenticated?: boolean;
+    };
+    next_step?: AuthNextStep;
+    redirect_url?: string;
+    token?: string;
+    user?: AuthUser;
+    loginUser?: AuthUser;
+    roles?: UserRole[];
+    requires2FA?: boolean;
+    twoFactorMethods?: string[];
+    requiresPasswordReset?: boolean;
+    passwordResetReason?: string;
+    requiresOTP?: boolean;
+    authenticated?: boolean;
+    [key: string]: unknown;
+}
+interface AuthResponseData {
+    next_step?: AuthNextStep;
+    redirect_url?: string;
+    token?: string;
+    user?: AuthUser;
+    meta?: {
+        is_authenticated?: boolean;
+    };
+    status?: number;
+    [key: string]: unknown;
+}
+interface AuthNextStep {
+    id: string;
+    is_pending: boolean;
+    title?: string;
+    description?: string;
+    metadata?: AuthStepMetadata;
+}
+interface AuthStepMetadata {
+    roles?: UserRole[] | Record<string, string>;
+    method?: string;
+    type?: string;
+    methods?: string[];
+    reason?: string;
+    password_policy?: PasswordPolicyConfig;
+    [key: string]: unknown;
+}
+interface PasswordPolicyConfig {
+    min_length?: number;
+    max_length?: number;
+    require_uppercase?: boolean;
+    require_lowercase?: boolean;
+    require_numbers?: boolean;
+    require_special_chars?: boolean;
+}
+interface AuthUser {
+    id?: string;
+    email?: string;
+    name?: string;
+    username?: string;
+    phone?: string;
+    display?: string;
+    [key: string]: unknown;
+}
+/**
+ * Authentication result from login/OTP
+ */
+export interface AuthResult extends AuthApiResponse {
+    redirect_url?: string;
+    requires_two_factor?: boolean;
+    session_token?: string;
+}
+/**
+ * Pending auth result stored during multi-step auth flows (SAML, OAuth, etc.)
+ */
+export interface PendingAuthResult extends AuthApiResponse {
+    timestamp?: number;
+}
+/**
+ * Two-factor auth setup
+ */
+export interface TwoFactorSetup {
+    qr_code_url?: string;
+    backup_codes?: string[];
+    secret?: string;
+}
+/**
+ * Two-factor verification
+ */
+export interface TwoFactorVerify {
+    code: string;
+    backup_code?: boolean;
+}
+/**
+ * Password reset request
+ */
+export interface PasswordResetRequest {
+    email: string;
+}
+/**
+ * Password reset confirmation
+ */
+export interface PasswordResetConfirm {
+    uid: string;
+    token: string;
+    new_password: string;
+    confirm_password?: string;
+}
+/**
+ * Password change
+ */
+export interface PasswordChange {
+    old_password: string;
+    new_password: string;
+    confirm_password?: string;
+}
+/**
+ * OAuth/SAML callback params
+ */
+export interface OAuthCallbackParams {
+    code?: string;
+    state?: string;
+    error?: string;
+    error_description?: string;
+}
+/**
+ * SAML callback params
+ */
+export interface SamlCallbackParams {
+    SAMLResponse?: string;
+    RelayState?: string;
+}
+/**
+ * Session information
+ */
+export interface SessionInfo {
+    id: string;
+    user_agent: string;
+    ip_address: string;
+    created_at: string;
+    last_activity: string;
+    is_current: boolean;
+}
+/**
+ * User profile data
+ */
+export interface UserProfile {
+    id: string;
+    email: string;
+    first_name?: string;
+    last_name?: string;
+    full_name?: string;
+    username?: string;
+    phone_number?: string;
+    avatar_url?: string;
+    date_joined?: string;
+    is_active?: boolean;
+}
+/**
+ * Profile form data
+ */
+export interface ProfileFormData {
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone_number?: string;
+}
+/**
+ * User role
+ */
+export interface UserRole {
+    id: string;
+    name: string;
+    description?: string;
+    permissions?: string[];
+}
+/**
+ * Background style for CSS
+ */
+export interface BackgroundStyle {
+    backgroundColor?: string;
+    backgroundImage?: string;
+    backgroundSize?: string;
+    backgroundPosition?: string;
+    backgroundRepeat?: string;
+}
+/**
+ * Simple auth display options (legacy — prefer AuthConfig from index.ts)
+ */
+export interface AuthDisplayOptions {
+    showLogo?: boolean;
+    showRememberMe?: boolean;
+    allowPasswordReset?: boolean;
+    allowRegistration?: boolean;
+}
+/**
+ * Detailed theme configuration with design tokens
+ */
+export interface DetailedThemeConfig {
+    colors?: {
+        primary?: string;
+        secondary?: string;
+        success?: string;
+        warning?: string;
+        error?: string;
+        gray?: string;
+        background?: string;
+        text?: string;
+    };
+    fonts?: {
+        body?: string;
+        heading?: string;
+    };
+    borderRadius?: {
+        small?: number;
+        medium?: number;
+        large?: number;
+    };
+}
+/**
+ * OAuth/OIDC/SAML provider configuration
+ */
+export interface AuthProvider {
+    id: string;
+    provider: string;
+    label?: string;
+    name?: string;
+    display_name?: string;
+    icon_url?: string;
+    providerType?: string;
+    [key: string]: unknown;
+}
+/**
+ * Cached logo data
+ */
+export interface LogoCacheData {
+    url: string;
+    base64Data: string | null;
+    version: string | null;
+    timestamp: number;
+    appName: string;
+}
+export {};

package/dist/types/types/index.d.ts

@@ -0,0 +1,278 @@
+import { UserRole, AuthProvider } from './common';
+import { PasswordPolicy } from './auth';
+export * from './auth';
+export * from './common';
+export interface ApiConfig {
+    baseUrl?: string;
+    endpoints?: Record<string, string>;
+    timeout?: number;
+    headers?: Record<string, string>;
+}
+export interface RouteConfig {
+    path: string;
+    page_type: string;
+    entity?: string;
+    component?: string;
+    extra_params?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export type MenuItemType = 'item' | 'section';
+export interface MenuItemConfig {
+    id: string;
+    type?: MenuItemType;
+    label: string;
+    name?: string;
+    path?: string;
+    url?: string;
+    uri?: string;
+    icon?: string;
+    route_id?: string;
+    children?: MenuItemConfig[];
+    [key: string]: unknown;
+}
+export interface AppConfig {
+    routes: RouteConfig[];
+    menu: MenuItemConfig[];
+    apiConfig: ApiConfig;
+    theme?: ThemeConfig;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+export interface ThemeConfig {
+    primaryColor?: string;
+    secondaryColor?: string;
+    [key: string]: unknown;
+}
+export interface ApiRequestConfig {
+    baseUrl: string;
+    apiUrl: string;
+    fullUrl: string;
+    headers: Record<string, string>;
+    entity?: string;
+    [key: string]: unknown;
+}
+export interface User {
+    id: string | number;
+    username?: string;
+    email?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+export interface AuthState {
+    isAuthenticated: boolean;
+    user: User | null;
+    token?: string;
+    [key: string]: unknown;
+}
+export interface LayoutProps {
+    children: React.ReactNode;
+    className?: string;
+}
+export interface ApiResponse<T = unknown> {
+    success: boolean;
+    response: T;
+    responseStatus: number;
+    message?: string;
+}
+export interface SessionSecurityConfig {
+    enabled: boolean;
+    ping_url: string;
+    warn_after: number;
+    expire_after: number;
+}
+export interface FormField {
+    name: string;
+    label?: string;
+    type?: string;
+    required?: boolean;
+    [key: string]: unknown;
+}
+export interface CrudConfig {
+    api_endpoint: string;
+    fields?: FormField[];
+    actions?: string[];
+    [key: string]: unknown;
+}
+export interface AuthConfig {
+    debug?: boolean;
+    theme?: {
+        background?: {
+            color?: string;
+            image?: string;
+            gradient?: string;
+        };
+        primaryColor?: string;
+        secondaryColor?: string;
+        fontFamily?: string;
+        borderRadius?: string;
+        textColor?: string;
+        secondaryTextColor?: string;
+        mutedTextColor?: string;
+        linkColor?: string;
+        linkHoverColor?: string;
+        alignTitle?: 'left' | 'center' | 'right';
+    };
+    card?: {
+        backgroundColor?: string;
+        borderRadius?: string;
+        boxShadow?: string;
+        maxWidth?: string;
+        padding?: string;
+        border?: string;
+    };
+    logo?: {
+        url?: string;
+        width?: string;
+        height?: string;
+        alt?: string;
+        position?: 'center' | 'left' | 'right';
+        className?: string;
+        style?: React.CSSProperties;
+    };
+    login?: {
+        title?: string | React.ComponentType;
+        subtitle?: string | React.ComponentType;
+        customElementsBelowDescription?: React.ComponentType[];
+        customHeader?: React.ComponentType;
+        customFooter?: React.ComponentType;
+        formLabels?: {
+            email?: string;
+            mobile?: string;
+            password?: string;
+        };
+        formPlaceholders?: {
+            email?: string;
+            mobile?: string;
+            password?: string;
+        };
+        submitButtonText?: string;
+        rememberMeText?: string;
+        forgotPasswordText?: string;
+        otpButtonText?: string;
+        tabLabels?: {
+            email?: string;
+            mobile?: string;
+        };
+        redirectAfterLogin?: string;
+        showRememberMe?: boolean;
+        enableTabSwitching?: boolean;
+        defaultTab?: 'email' | 'mobile';
+    };
+    roleSelection?: {
+        title?: string | React.ComponentType;
+        subtitle?: string | React.ComponentType;
+        instructionText?: string;
+        continueButtonText?: string;
+        recommendedBadgeText?: string;
+        emptyStateMessage?: string;
+        cardLayout?: 'grid' | 'list';
+        gridColumns?: 2 | 3;
+        maxHeight?: string;
+        customRoleCard?: React.ComponentType<{
+            role: UserRole | Record<string, unknown>;
+            selected: boolean;
+            onSelect: () => void;
+        }>;
+        customEmptyState?: React.ComponentType;
+        roleCardStyling?: {
+            backgroundColor?: string;
+            selectedColor?: string;
+            hoverColor?: string;
+            borderRadius?: string;
+        };
+    };
+    twoFactor?: {
+        title?: string | React.ComponentType;
+        subtitle?: string | React.ComponentType;
+        instructionText?: string;
+        sendInstructionText?: string;
+        sendButtonText?: string;
+        codeInputLabel?: string;
+        submitButtonText?: string;
+        resendButtonText?: string;
+        backButtonText?: string;
+        resendCountdown?: number;
+        codeLength?: number;
+        methodLabels?: {
+            email?: string;
+            sms?: string;
+            mobile?: string;
+        };
+        customCodeInput?: React.ComponentType<Record<string, unknown>>;
+        customMethodSelector?: React.ComponentType<Record<string, unknown>>;
+    };
+    resetPassword?: {
+        forgotPassword?: {
+            title?: string | React.ComponentType;
+            subtitle?: string | React.ComponentType;
+            instructionText?: string;
+            emailLabel?: string;
+            emailPlaceholder?: string;
+            submitButtonText?: string;
+            backToLoginText?: string;
+            successMessage?: string;
+            errorMessage?: string;
+        };
+        resetForm?: {
+            title?: string | React.ComponentType;
+            subtitle?: string | React.ComponentType;
+            passwordLabel?: string;
+            confirmPasswordLabel?: string;
+            passwordPlaceholder?: string;
+            confirmPasswordPlaceholder?: string;
+            submitButtonText?: string;
+            successMessage?: string;
+            showPasswordRequirements?: boolean;
+            passwordRequirementsText?: string;
+            customPasswordRequirements?: React.ComponentType<{
+                policy: PasswordPolicy | Record<string, unknown>;
+            }>;
+        };
+    };
+    providers?: {
+        buttonStyle?: 'outline' | 'filled' | 'minimal';
+        showProviderIcons?: boolean;
+        customProviderButtons?: Record<string, React.ComponentType<{
+            provider: AuthProvider;
+        }>>;
+        separatorText?: string;
+    };
+    customComponents?: {
+        LoginPage?: React.ComponentType<Record<string, unknown>>;
+        LoginCard?: React.ComponentType<Record<string, unknown>>;
+        RoleSelection?: React.ComponentType<Record<string, unknown>>;
+        TwoFactorAuth?: React.ComponentType<Record<string, unknown>>;
+        ForgotPasswordPage?: React.ComponentType<Record<string, unknown>>;
+        ResetPasswordPage?: React.ComponentType<Record<string, unknown>>;
+        OAuthCallbackPage?: React.ComponentType<Record<string, unknown>>;
+        DynamicLoginForm?: React.ComponentType<Record<string, unknown>>;
+        OTPForm?: React.ComponentType<Record<string, unknown>>;
+        ProviderButton?: React.ComponentType<Record<string, unknown>>;
+    };
+    roleSelectionEndpoint?: string;
+    password_policy?: Record<string, unknown>;
+    messages?: {
+        validation?: {
+            required?: string;
+            /** Required-field message for the password input. `required` is worded for
+             *  the identifier field, so the password field needs its own. */
+            passwordRequired?: string;
+            invalidEmail?: string;
+            invalidMobile?: string;
+            passwordTooShort?: string;
+            passwordsDoNotMatch?: string;
+        };
+        errors?: {
+            loginFailed?: string;
+            networkError?: string;
+            invalidOTP?: string;
+            expiredToken?: string;
+        };
+        success?: {
+            loginSuccess?: string;
+            otpSent?: string;
+            passwordReset?: string;
+            roleSelected?: string;
+        };
+    };
+}