@famgia/omnify-react-sso 2.2.3 → 2.2.5

package/dist/ant/index.d.cts

@@ -0,0 +1,685 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { f as SsoCallbackProps, e as OrganizationSwitcherProps, P as ProtectedRouteProps, d as OrgBranchSelectorModalProps, a as BranchGateProps } from '../types-BxClyvTX.cjs';
+export { b as BranchGateSelection } from '../types-BxClyvTX.cjs';
+import { ReactNode } from 'react';
+import { TableColumnType, TableProps, BreadcrumbProps } from 'antd';
+import { UseQueryResult } from '@tanstack/react-query';
+import { R as Role, j as UserPermissionsBreakdown, b as RoleAssignmentWithPermissions, P as Permission } from '../userService-DH9-vPSg.cjs';
+
+/**
+ * SSO Callback component
+ *
+ * Place this component at your callback route (e.g., /sso/callback)
+ * It handles the SSO code exchange and redirects after successful login.
+ *
+ * @example
+ * ```tsx
+ * // pages/sso/callback.tsx or app/sso/callback/page.tsx
+ * export default function CallbackPage() {
+ *   return (
+ *     <SsoCallback
+ *       redirectTo="/dashboard"
+ *       onSuccess={(user, orgs) => console.log('Logged in:', user)}
+ *       onError={(error) => console.error('Login failed:', error)}
+ *     />
+ *   );
+ * }
+ * ```
+ */
+declare function SsoCallback({ onSuccess, onError, redirectTo, loadingComponent, errorComponent, }: SsoCallbackProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Organization Switcher component using Ant Design
+ *
+ * A dropdown component for switching between organizations.
+ * Only renders if user has access to multiple organizations.
+ *
+ * @example
+ * ```tsx
+ * // Basic usage
+ * <OrganizationSwitcher />
+ *
+ * // With custom styling
+ * <OrganizationSwitcher className="my-switcher" />
+ *
+ * // With custom render
+ * <OrganizationSwitcher
+ *   renderTrigger={(org, isOpen) => (
+ *     <Button>{org?.name} {isOpen ? '▲' : '▼'}</Button>
+ *   )}
+ *   renderOption={(org, isSelected) => (
+ *     <div className={isSelected ? 'selected' : ''}>{org.name}</div>
+ *   )}
+ * />
+ * ```
+ */
+declare function OrganizationSwitcher({ className, renderTrigger, renderOption, onChange, }: OrganizationSwitcherProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * Protected Route component
+ *
+ * Wraps content that requires authentication and optionally specific roles/permissions.
+ *
+ * @example
+ * ```tsx
+ * // Basic protection
+ * <ProtectedRoute>
+ *   <Dashboard />
+ * </ProtectedRoute>
+ *
+ * // With role requirement
+ * <ProtectedRoute requiredRole="admin">
+ *   <AdminPanel />
+ * </ProtectedRoute>
+ *
+ * // With custom fallbacks
+ * <ProtectedRoute
+ *   fallback={<Spinner />}
+ *   loginFallback={<CustomLoginPage />}
+ *   onAccessDenied={(reason) => console.log(reason)}
+ * >
+ *   <ProtectedContent />
+ * </ProtectedRoute>
+ * ```
+ */
+declare function ProtectedRoute({ children, fallback, loginFallback, requiredRole, requiredPermission, onAccessDenied, }: ProtectedRouteProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Organization and Branch Selector Modal
+ *
+ * A modal component for selecting organization and branch.
+ * - If user has only one organization, it's auto-selected
+ * - If user has only one branch, it's auto-selected
+ * - Shows selection UI only when there are multiple options
+ *
+ * @example
+ * ```tsx
+ * function CreateProjectButton() {
+ *   const [modalOpen, setModalOpen] = useState(false);
+ *
+ *   const handleConfirm = (orgId: number, branchId: number) => {
+ *     // Create project with selected org and branch
+ *     createProject({ organization_id: orgId, branch_id: branchId });
+ *     setModalOpen(false);
+ *   };
+ *
+ *   return (
+ *     <>
+ *       <Button onClick={() => setModalOpen(true)}>
+ *         Create Project
+ *       </Button>
+ *       <OrgBranchSelectorModal
+ *         open={modalOpen}
+ *         onClose={() => setModalOpen(false)}
+ *         onConfirm={handleConfirm}
+ *       />
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function OrgBranchSelectorModal({ open, onClose, onConfirm, title, requireBranch, loadingComponent, }: OrgBranchSelectorModalProps): react_jsx_runtime.JSX.Element;
+
+type StoredSelection = {
+    orgId: string;
+    orgName: string;
+    branchId: string;
+    branchName: string;
+    branchCode: string;
+};
+/**
+ * BranchGate - Ensures user has selected an org/branch before accessing the app.
+ *
+ * Different from OrgBranchSelectorModal:
+ * - OrgBranchSelectorModal: Modal for one-time selection (e.g., creating a project)
+ * - BranchGate: Gate that blocks app access until selection is made, persists globally
+ *
+ * Auto-selection behavior:
+ * - If user has only 1 org and 1 branch: auto-selects and allows access
+ * - If user has multiple options: shows selection modal first
+ * - Stores selection in localStorage for persistence
+ *
+ * @example
+ * ```tsx
+ * // In your app layout
+ * function DashboardLayout({ children }) {
+ *   return (
+ *     <BranchGate
+ *       onSelectionChange={(selection) => {
+ *         // Set API headers globally
+ *         api.defaults.headers['X-Branch-Id'] = selection.branchId;
+ *         api.defaults.headers['X-Organization-Id'] = selection.orgId;
+ *       }}
+ *     >
+ *       {children}
+ *     </BranchGate>
+ *   );
+ * }
+ * ```
+ */
+declare function BranchGate({ children, onSelectionChange, storageKey, loadingComponent, title, description, }: BranchGateProps): react_jsx_runtime.JSX.Element;
+declare function useBranchGate(storageKey?: string): {
+    selection: StoredSelection | null;
+    selectedOrg: {
+        id: string;
+        slug: string;
+        name: string;
+    } | null;
+    selectedBranch: {
+        id: string;
+        name: string;
+        code: string;
+    } | null;
+    clearSelection: () => void;
+};
+
+/**
+ * Search field configuration
+ */
+interface SearchField {
+    name: string;
+    label: string;
+    type: 'input' | 'select' | 'date' | 'dateRange' | 'number';
+    placeholder?: string;
+    options?: {
+        value: string | number;
+        label: string;
+    }[];
+    hidden?: boolean;
+    width?: number | string;
+}
+/**
+ * Row action configuration
+ */
+interface RowAction<T> {
+    label: string;
+    onClick?: (record: T) => void;
+    href?: string;
+    danger?: boolean;
+    confirm?: boolean | string;
+    hidden?: (record: T) => boolean;
+}
+/**
+ * Value type for automatic formatting
+ */
+type ValueType = 'text' | 'status' | 'tag' | 'date' | 'datetime' | 'number' | 'currency' | 'boolean';
+/**
+ * Status configuration for colored dots
+ */
+interface StatusConfig {
+    [key: string]: {
+        color: string;
+        text: string;
+    };
+}
+/**
+ * Extended column type with ProTable features
+ */
+interface ProTableColumn<T> extends Omit<TableColumnType<T>, 'render' | 'dataIndex'> {
+    dataIndex?: string | string[];
+    key?: string;
+    title: string;
+    sortable?: boolean;
+    searchable?: boolean;
+    valueType?: ValueType;
+    statusConfig?: StatusConfig;
+    render?: (value: unknown, record: T, index: number) => ReactNode;
+    width?: number | string;
+    ellipsis?: boolean;
+    hidden?: boolean;
+}
+/**
+ * Pagination meta from API
+ */
+interface PaginationMeta {
+    current_page: number;
+    per_page: number;
+    total: number;
+    last_page: number;
+}
+/**
+ * API response shape
+ */
+interface ApiResponse<T> {
+    data: T[];
+    meta?: PaginationMeta;
+}
+/**
+ * Query parameters for API
+ */
+interface QueryParams {
+    page?: number;
+    per_page?: number;
+    sort?: string;
+    order?: 'asc' | 'desc';
+    [key: string]: unknown;
+}
+/**
+ * i18n texts for ProTable
+ */
+interface ProTableTexts {
+    search?: string;
+    reset?: string;
+    expand?: string;
+    collapse?: string;
+    add?: string;
+    refresh?: string;
+    columnSettings?: string;
+    actions?: string;
+    yes?: string;
+    no?: string;
+    cancel?: string;
+    totalItems?: (total: number) => string;
+    selectPlaceholder?: string;
+    inputPlaceholder?: string;
+    startDate?: string;
+    endDate?: string;
+}
+/**
+ * ProTable props
+ */
+interface ProTableProps<T extends object> {
+    title: string;
+    icon?: ReactNode;
+    subTitle?: string;
+    searchFields?: SearchField[];
+    defaultSearchValues?: Record<string, unknown>;
+    columns: ProTableColumn<T>[];
+    dataSource?: T[];
+    rowKey?: string | ((record: T) => string);
+    loading?: boolean;
+    queryKey?: unknown[];
+    queryFn?: (params: QueryParams) => Promise<ApiResponse<T>>;
+    queryResult?: UseQueryResult<ApiResponse<T>>;
+    queryEnabled?: boolean;
+    onAdd?: () => void;
+    addButtonLink?: string;
+    addLabel?: string;
+    toolbarExtra?: ReactNode;
+    showRefresh?: boolean;
+    showColumnSettings?: boolean;
+    rowActions?: (record: T) => RowAction<T>[];
+    pagination?: boolean | TableProps<T>['pagination'];
+    defaultPageSize?: number;
+    onSearch?: (values: Record<string, unknown>) => void;
+    onReset?: () => void;
+    onChange?: TableProps<T>['onChange'];
+    className?: string;
+    style?: React.CSSProperties;
+    cardStyle?: React.CSSProperties;
+    tableProps?: Omit<TableProps<T>, 'columns' | 'dataSource' | 'loading' | 'pagination' | 'onChange'>;
+    texts?: ProTableTexts;
+}
+
+/**
+ * Default i18n texts (Japanese)
+ * Can be overridden via props
+ */
+declare const DEFAULT_TEXTS: {
+    search: string;
+    reset: string;
+    expand: string;
+    collapse: string;
+    add: string;
+    refresh: string;
+    columnSettings: string;
+    actions: string;
+    yes: string;
+    no: string;
+    cancel: string;
+    totalItems: (total: number) => string;
+    selectPlaceholder: string;
+    inputPlaceholder: string;
+    startDate: string;
+    endDate: string;
+};
+/**
+ * ProTable Component
+ * A feature-rich table with search, filter, sort, and pagination
+ */
+declare function ProTable<T extends object>({ title, icon, subTitle, searchFields, defaultSearchValues, columns, dataSource: externalDataSource, rowKey, loading: externalLoading, queryKey, queryFn, queryResult: externalQueryResult, queryEnabled, onAdd, addButtonLink, addLabel, toolbarExtra, showRefresh, showColumnSettings, rowActions, pagination, defaultPageSize, onSearch, onReset, onChange, className, style, cardStyle, tableProps, texts: customTexts, }: ProTableProps<T>): react_jsx_runtime.JSX.Element;
+
+interface PageContainerProps {
+    /**
+     * Page title
+     */
+    title?: ReactNode;
+    /**
+     * Subtitle displayed below the title
+     */
+    subTitle?: ReactNode;
+    /**
+     * Icon displayed before the title
+     */
+    icon?: ReactNode;
+    /**
+     * Extra content displayed on the right side of the header
+     */
+    extra?: ReactNode;
+    /**
+     * Breadcrumb configuration
+     * Can be BreadcrumbProps or array of { title: string, href?: string }
+     */
+    breadcrumb?: BreadcrumbProps | {
+        title: ReactNode;
+        href?: string;
+    }[];
+    /**
+     * Content of the page
+     */
+    children?: ReactNode;
+    /**
+     * Whether to show the header background
+     * @default true
+     */
+    showHeader?: boolean;
+    /**
+     * Custom className for the container
+     */
+    className?: string;
+    /**
+     * Custom style for the container
+     */
+    style?: React.CSSProperties;
+}
+/**
+ * PageContainer - A standard page layout component
+ *
+ * Provides consistent page structure with:
+ * - Breadcrumb navigation
+ * - Page title with optional icon and subtitle
+ * - Extra actions area (right side)
+ * - Content area
+ *
+ * @example
+ * ```tsx
+ * <PageContainer
+ *   title="従業員管理"
+ *   subTitle="従業員情報の一覧と管理"
+ *   icon={<UserOutlined />}
+ *   breadcrumb={[
+ *     { title: 'リスト' },
+ *     { title: '従業員管理' },
+ *   ]}
+ *   extra={
+ *     <Button type="primary" icon={<PlusOutlined />}>
+ *       新規
+ *     </Button>
+ *   }
+ * >
+ *   <Card>...</Card>
+ * </PageContainer>
+ * ```
+ */
+declare function PageContainer({ title, subTitle, icon, extra, breadcrumb, children, showHeader, className, style, }: PageContainerProps): react_jsx_runtime.JSX.Element;
+
+declare function LocaleSwitcher(): react_jsx_runtime.JSX.Element;
+
+interface OrganizationLike$1 {
+    id: string | number;
+    name: string;
+    slug?: string;
+}
+interface BranchLike$1 {
+    id: string | number;
+    name: string;
+}
+interface UserRoleAssignModalProps {
+    open: boolean;
+    userName?: string;
+    roles: Role[];
+    organizations: OrganizationLike$1[];
+    branches?: BranchLike$1[];
+    currentOrgId?: string;
+    loading?: boolean;
+    onAssign: (values: {
+        role_id: string;
+        scope: 'global' | 'org-wide' | 'branch';
+        org_id?: string;
+        branch_ids?: string[];
+    }) => void | Promise<void>;
+    onCancel: () => void;
+    translations?: {
+        title?: string;
+        selectRole?: string;
+        scope?: string;
+        global?: string;
+        orgWide?: string;
+        branchSpecific?: string;
+        organization?: string;
+        selectBranches?: string;
+        assign?: string;
+        cancel?: string;
+        assignRole?: string;
+        required?: string;
+    };
+}
+declare function UserRoleAssignModal({ open, userName, roles, organizations, branches, currentOrgId, loading, onAssign, onCancel, translations: t, }: UserRoleAssignModalProps): react_jsx_runtime.JSX.Element;
+
+interface OrganizationLike {
+    id: string | number;
+    name: string;
+    slug?: string;
+}
+interface BranchLike {
+    id: string | number;
+    name: string;
+}
+interface UserPermissionsModalProps {
+    open: boolean;
+    userName?: string;
+    permissions?: UserPermissionsBreakdown | null;
+    loading?: boolean;
+    currentOrg?: OrganizationLike | null;
+    currentBranch?: BranchLike | null;
+    branches?: BranchLike[];
+    onClose: () => void;
+    onAddRole?: () => void;
+    onAddTeam?: () => void;
+    onRemoveRole?: (roleId: string, orgId?: string | null, branchId?: string | null) => void;
+    translations?: {
+        permissionBreakdown?: string;
+        userInfo?: string;
+        email?: string;
+        primaryOrganization?: string;
+        global?: string;
+        currentContext?: string;
+        roleAssignments?: string;
+        noRolesAssigned?: string;
+        add?: string;
+        permissions?: string;
+        teamMemberships?: string;
+        noTeamMemberships?: string;
+        teamLeader?: string;
+        teamsFromConsole?: string;
+        aggregatedPermissions?: string;
+        noData?: string;
+        ungrouped?: string;
+        orgWide?: string;
+        confirmRemoveRole?: string;
+    };
+}
+declare function UserPermissionsModal({ open, userName, permissions, loading, currentOrg, currentBranch, branches, onClose, onAddRole, onAddTeam, onRemoveRole, translations: t, }: UserPermissionsModalProps): react_jsx_runtime.JSX.Element;
+
+interface UserDetailCardProps {
+    user?: UserPermissionsBreakdown['user'];
+    roleAssignments: RoleAssignmentWithPermissions[];
+    teamMemberships: UserPermissionsBreakdown['team_memberships'];
+    aggregatedPermissions: string[];
+    currentOrg?: {
+        id: string | number;
+        name: string;
+    } | null;
+    currentBranch?: {
+        id: string | number;
+        name: string;
+    } | null;
+    onRefresh?: () => void;
+    onAssignRole?: () => void;
+    onRemoveRole?: (roleId: string, consoleOrgId?: string | null, consoleBranchId?: string | null) => void;
+    onRoleClick?: (roleId: string) => void;
+    removeLoading?: boolean;
+    translations?: {
+        email?: string;
+        primaryOrganization?: string;
+        currentContext?: string;
+        global?: string;
+        created?: string;
+        lastSignIn?: string;
+        roleAssignments?: string;
+        roles?: string;
+        permissions?: string;
+        teams?: string;
+        aggregatedPermissions?: string;
+        permissionPolicies?: string;
+        permissionsDescription?: string;
+        searchPermissions?: string;
+        allTypes?: string;
+        viaRole?: string;
+        viaTeam?: string;
+        attachedVia?: string;
+        filterByType?: string;
+        remove?: string;
+        addPermissions?: string;
+        assignRole?: string;
+        noRolesAssigned?: string;
+        level?: string;
+        actions?: string;
+        confirmRemoveRole?: string;
+        teamMemberships?: string;
+        noTeamMemberships?: string;
+        teamLeader?: string;
+        noPermissions?: string;
+        group?: string;
+    };
+}
+declare function UserDetailCard({ user, roleAssignments, teamMemberships, aggregatedPermissions, currentOrg, currentBranch, onRefresh, onAssignRole, onRemoveRole, onRoleClick, removeLoading, translations: t, }: UserDetailCardProps): react_jsx_runtime.JSX.Element;
+
+interface RoleCreateModalProps {
+    open: boolean;
+    organizations: OrganizationLike$1[];
+    currentOrgId?: string;
+    loading?: boolean;
+    onSubmit: (values: {
+        name: string;
+        slug: string;
+        description?: string;
+        level: number;
+        scope: 'global' | 'org';
+        org_id?: string;
+    }) => void | Promise<void>;
+    onCancel: () => void;
+    translations?: {
+        title?: string;
+        name?: string;
+        slug?: string;
+        description?: string;
+        level?: string;
+        scope?: string;
+        global?: string;
+        orgRole?: string;
+        organization?: string;
+        create?: string;
+        cancel?: string;
+        required?: string;
+    };
+}
+declare function RoleCreateModal({ open, organizations, currentOrgId, loading, onSubmit, onCancel, translations: t, }: RoleCreateModalProps): react_jsx_runtime.JSX.Element;
+
+interface RolesListCardProps {
+    roles: Role[];
+    loading?: boolean;
+    scopeFilter: 'all' | 'global' | 'org';
+    onScopeFilterChange: (value: 'all' | 'global' | 'org') => void;
+    onCreateClick: () => void;
+    onViewClick: (role: Role) => void;
+    onDeleteClick: (role: Role) => void;
+    translations?: {
+        name?: string;
+        scope?: string;
+        level?: string;
+        description?: string;
+        actions?: string;
+        detail?: string;
+        global?: string;
+        orgRole?: string;
+        all?: string;
+        confirmDeleteRole?: string;
+    };
+}
+declare function RolesListCard({ roles, loading, scopeFilter, onScopeFilterChange, onCreateClick, onViewClick, onDeleteClick, translations: t, }: RolesListCardProps): react_jsx_runtime.JSX.Element;
+
+interface PermissionsListCardProps {
+    permissions: Permission[];
+    groups: string[];
+    loading?: boolean;
+    translations?: {
+        searchPermissions?: string;
+        name?: string;
+        slug?: string;
+        group?: string;
+        noData?: string;
+    };
+    onGroupLabelRender?: (group: string) => string;
+}
+declare function PermissionsListCard({ permissions, groups, loading, translations: t, onGroupLabelRender, }: PermissionsListCardProps): react_jsx_runtime.JSX.Element;
+
+interface TeamData {
+    id: string;
+    name: string;
+    member_count: number;
+    permissions: string[];
+}
+interface TeamsListCardProps {
+    teams: TeamData[];
+    loading?: boolean;
+    translations?: {
+        name?: string;
+        memberCount?: string;
+        permissions?: string;
+        noTeams?: string;
+        teamsFromConsole?: string;
+        teamPermissions?: string;
+        noData?: string;
+    };
+}
+declare function TeamsListCard({ teams, loading, translations: t, }: TeamsListCardProps): react_jsx_runtime.JSX.Element;
+
+type ScopeType = 'global' | 'org-wide' | 'branch';
+/**
+ * Get icon for scope type
+ */
+declare function getScopeIcon(scope: ScopeType | string): ReactNode;
+/**
+ * Get color for scope type
+ */
+declare function getScopeColor(scope: ScopeType | string): string;
+interface ScopeTagProps {
+    scope: ScopeType | string;
+    label?: string;
+    showIcon?: boolean;
+}
+/**
+ * Tag component for displaying scope
+ */
+declare function ScopeTag({ scope, label, showIcon }: ScopeTagProps): react_jsx_runtime.JSX.Element;
+interface ScopeLabelProps {
+    scope: ScopeType | string;
+    label: string;
+}
+/**
+ * Label with icon for scope
+ */
+declare function ScopeLabel({ scope, label }: ScopeLabelProps): react_jsx_runtime.JSX.Element;
+
+type SetDayjsLocale = (locale: string) => void;
+type ThemeVariant = 'dashboard' | 'admin';
+interface AntdThemeProviderProps {
+    children: React.ReactNode;
+    variant?: ThemeVariant;
+    /** Optional function to set dayjs locale */
+    setDayjsLocale?: SetDayjsLocale;
+}
+declare function AntdThemeProvider({ children, variant, setDayjsLocale }: AntdThemeProviderProps): react_jsx_runtime.JSX.Element;
+
+export { AntdThemeProvider, type AntdThemeProviderProps, type ApiResponse, BranchGate, type BranchLike$1 as BranchLike, LocaleSwitcher, OrgBranchSelectorModal, type OrganizationLike$1 as OrganizationLike, OrganizationSwitcher, DEFAULT_TEXTS as PROTABLE_DEFAULT_TEXTS, PageContainer, type PageContainerProps, type PaginationMeta, PermissionsListCard, type PermissionsListCardProps, ProTable, type ProTableColumn, type ProTableProps, type ProTableTexts, ProtectedRoute, type QueryParams, RoleCreateModal, type RoleCreateModalProps, RolesListCard, type RolesListCardProps, type RowAction, ScopeLabel, type ScopeLabelProps, ScopeTag, type ScopeTagProps, type ScopeType, type SearchField, SsoCallback, type StatusConfig, type TeamData, TeamsListCard, type TeamsListCardProps, UserDetailCard, type UserDetailCardProps, UserPermissionsModal, type UserPermissionsModalProps, UserRoleAssignModal, type UserRoleAssignModalProps, type ValueType, getScopeColor, getScopeIcon, useBranchGate };