@famgia/omnify-react-sso 2.2.2 → 2.2.3

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-export { DateString, DateTimeString, Locale, LocaleMap, ValidationRule } from '@omnify-base/schemas/common';
-export { defaultLocale, fallbackLocale, getMessage, getMessages, supportedLocales, validationMessages } from '@omnify-base/schemas/i18n';
+export { DateString, DateTimeString, LocaleMap, ValidationRule } from '@omnify-base/schemas/common';
+export { fallbackLocale, getMessage, getMessages, supportedLocales, validationMessages } from '@omnify-base/schemas/i18n';
 export { BranchCache, BranchCacheCreate, BranchCacheUpdate, OrganizationCache, OrganizationCacheCreate, OrganizationCacheUpdate, PermissionCreate, PermissionUpdate, RoleCreate, RolePermission, RolePermissionCreate, RolePermissionUpdate, RoleUpdate, TeamCache, TeamCacheCreate, TeamCacheUpdate, TeamPermission, TeamPermissionCreate, TeamPermissionUpdate, UserCache, UserCacheCreate, UserCacheUpdate, branchCacheCreateSchema, branchCacheSchemas, branchCacheUpdateSchema, organizationCacheCreateSchema, organizationCacheSchemas, organizationCacheUpdateSchema, permissionCreateSchema, permissionSchemas, permissionUpdateSchema, roleCreateSchema, rolePermissionCreateSchema, rolePermissionSchemas, rolePermissionUpdateSchema, roleSchemas, roleUpdateSchema, teamCacheCreateSchema, teamCacheSchemas, teamCacheUpdateSchema, teamPermissionCreateSchema, teamPermissionSchemas, teamPermissionUpdateSchema, userCacheCreateSchema, userCacheSchemas, userCacheUpdateSchema } from './schemas/index.js';
 import * as react from 'react';
-import { b as SsoContextValue, c as SsoProviderProps, B as BranchContextValue, d as BranchProviderProps, S as SsoUser$2, a as SsoOrganization, e as SsoConfig, f as SsoCallbackProps, O as OrganizationSwitcherProps, P as ProtectedRouteProps, g as OrgBranchSelectorModalProps, h as BranchGateProps, i as BranchGateSelection } from './types-CJmA2a9r.js';
-export { l as OrgBranchSelection, k as SsoBranch, j as SsoCallbackResponse } from './types-CJmA2a9r.js';
+import { ReactNode } from 'react';
+import { b as SsoContextValue, c as SsoProviderProps, B as BranchContextValue, d as BranchProviderProps, S as SsoUser$2, a as SsoOrganization, e as SsoConfig, f as SsoCallbackProps, O as OrganizationSwitcherProps, P as ProtectedRouteProps, g as OrgBranchSelectorModalProps, h as BranchGateProps, i as BranchGateSelection } from './types-bD5deLxs.js';
+export { j as OrgBranchSelection, k as SsoBranch, l as SsoCallbackResponse } from './types-bD5deLxs.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 export { branchCacheI18n, getBranchCacheFieldLabel, getBranchCacheFieldPlaceholder, getBranchCacheLabel } from '@omnify-base/schemas/BranchCache';
 export { getOrganizationCacheFieldLabel, getOrganizationCacheFieldPlaceholder, getOrganizationCacheLabel, organizationCacheI18n } from '@omnify-base/schemas/OrganizationCache';
@@ -407,6 +408,335 @@ declare function useBranchGate(storageKey?: string): {
     clearSelection: () => void;
 };
 
+/**
+ * Base service configuration
+ */
+interface ServiceConfig {
+    apiUrl: string;
+}
+
+/**
+ * User Service - Admin User CRUD operations
+ *
+ * Provides user management functionality for admin users.
+ * Uses the /api/admin/sso/users endpoints.
+ */
+
+interface User {
+    id: string;
+    name: string;
+    email: string;
+    console_user_id?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+interface UserListParams {
+    page?: number;
+    per_page?: number;
+    "filter[search]"?: string;
+    "filter[org_id]"?: string;
+    sort?: string;
+}
+interface UserListResponse {
+    data: User[];
+    links?: {
+        first?: string;
+        last?: string;
+        prev?: string | null;
+        next?: string | null;
+    };
+    meta: {
+        current_page: number;
+        from: number | null;
+        last_page: number;
+        per_page: number;
+        to: number | null;
+        total: number;
+    };
+}
+interface UpdateUserInput {
+    name?: string;
+    email?: string;
+}
+interface RoleAssignmentWithPermissions {
+    role: {
+        id: string;
+        name: string;
+        slug: string;
+        level: number;
+    };
+    scope: "global" | "org-wide" | "branch";
+    console_org_id: string | null;
+    console_branch_id: string | null;
+    org_name?: string | null;
+    branch_name?: string | null;
+    permissions: string[];
+}
+interface TeamMembershipWithPermissions {
+    team: {
+        id: string | number;
+        name: string;
+        path: string | null;
+    };
+    is_leader: boolean;
+    permissions: string[];
+}
+interface UserPermissionsBreakdown {
+    user: {
+        id: string;
+        name: string;
+        email: string;
+        console_org_id?: string | null;
+        organization?: {
+            id: string;
+            console_org_id: string;
+            name: string;
+            code: string;
+        } | null;
+    };
+    context: {
+        org_id: string | null;
+        branch_id: string | null;
+    };
+    role_assignments: RoleAssignmentWithPermissions[];
+    team_memberships: TeamMembershipWithPermissions[];
+    aggregated_permissions: string[];
+}
+interface UserService {
+    list(params?: UserListParams, orgSlug?: string): Promise<UserListResponse>;
+    get(id: string, orgSlug?: string): Promise<User>;
+    update(id: string, input: UpdateUserInput, orgSlug?: string): Promise<User>;
+    delete(id: string, orgSlug?: string): Promise<void>;
+    search(email: string, orgSlug?: string): Promise<User[]>;
+    getPermissions(userId: string, orgId?: string, branchId?: string, orgSlug?: string): Promise<UserPermissionsBreakdown>;
+}
+declare function createUserService(config: ServiceConfig): UserService;
+
+interface UserTableProps {
+    users: User[];
+    loading?: boolean;
+    pagination?: UserListResponse["meta"];
+    sortField?: string;
+    sortOrder?: "asc" | "desc";
+    onPageChange?: (page: number, pageSize: number) => void;
+    onSortChange?: (field: string | undefined, order: "asc" | "desc" | undefined) => void;
+    onSearch?: (value: string) => void;
+    onEdit?: (user: User) => void;
+    onDelete?: (user: User) => void;
+    deleteLoading?: boolean;
+    showSearch?: boolean;
+    showActions?: boolean;
+}
+declare function UserTable({ users, loading, pagination, sortField, sortOrder, onPageChange, onSortChange, onSearch, onEdit, onDelete, deleteLoading, showSearch, showActions, }: UserTableProps): react_jsx_runtime.JSX.Element;
+
+interface UserFormProps {
+    initialValues?: Partial<User>;
+    onSubmit: (values: UpdateUserInput) => void;
+    onCancel?: () => void;
+    loading?: boolean;
+    submitText?: string;
+}
+declare function UserForm({ initialValues, onSubmit, onCancel, loading, submitText, }: UserFormProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Default translations for SSO components
+ *
+ * Apps can override these by adding to their i18n resources under the "sso" namespace.
+ */
+declare const ssoNamespace = "sso";
+declare const defaultTranslations: {
+    en: {
+        actions: string;
+        save: string;
+        cancel: string;
+        delete: string;
+        edit: string;
+        search: string;
+        loading: string;
+        yes: string;
+        no: string;
+        confirmDelete: string;
+        users: string;
+        user: string;
+        name: string;
+        email: string;
+        ssoUser: string;
+        localUser: string;
+        userList: string;
+        userDetails: string;
+        editUser: string;
+        deleteUser: string;
+        searchUsers: string;
+        noUsersFound: string;
+        userDeleted: string;
+        userUpdated: string;
+        roles: string;
+        role: string;
+        roleName: string;
+        roleDescription: string;
+        permissions: string;
+        assignRole: string;
+        removeRole: string;
+        permission: string;
+        permissionName: string;
+        permissionDescription: string;
+        required: string;
+        maxLength: string;
+        invalidEmail: string;
+        total: string;
+        page: string;
+    };
+    ja: {
+        actions: string;
+        save: string;
+        cancel: string;
+        delete: string;
+        edit: string;
+        search: string;
+        loading: string;
+        yes: string;
+        no: string;
+        confirmDelete: string;
+        users: string;
+        user: string;
+        name: string;
+        email: string;
+        ssoUser: string;
+        localUser: string;
+        userList: string;
+        userDetails: string;
+        editUser: string;
+        deleteUser: string;
+        searchUsers: string;
+        noUsersFound: string;
+        userDeleted: string;
+        userUpdated: string;
+        roles: string;
+        role: string;
+        roleName: string;
+        roleDescription: string;
+        permissions: string;
+        assignRole: string;
+        removeRole: string;
+        permission: string;
+        permissionName: string;
+        permissionDescription: string;
+        required: string;
+        maxLength: string;
+        invalidEmail: string;
+        total: string;
+        page: string;
+    };
+    vi: {
+        actions: string;
+        save: string;
+        cancel: string;
+        delete: string;
+        edit: string;
+        search: string;
+        loading: string;
+        yes: string;
+        no: string;
+        confirmDelete: string;
+        users: string;
+        user: string;
+        name: string;
+        email: string;
+        ssoUser: string;
+        localUser: string;
+        userList: string;
+        userDetails: string;
+        editUser: string;
+        deleteUser: string;
+        searchUsers: string;
+        noUsersFound: string;
+        userDeleted: string;
+        userUpdated: string;
+        roles: string;
+        role: string;
+        roleName: string;
+        roleDescription: string;
+        permissions: string;
+        assignRole: string;
+        removeRole: string;
+        permission: string;
+        permissionName: string;
+        permissionDescription: string;
+        required: string;
+        maxLength: string;
+        invalidEmail: string;
+        total: string;
+        page: string;
+    };
+};
+
+/**
+ * Hook for SSO translations using react-i18next
+ *
+ * Falls back to English if translation not found.
+ * Apps should initialize i18next and add SSO translations to their resources.
+ */
+
+type TranslationKey = keyof typeof defaultTranslations.en;
+/**
+ * Hook for SSO component translations
+ *
+ * Falls back to English if react-i18next is not available or translation not found.
+ *
+ * @example
+ * const { t } = useSsoTranslation();
+ * <span>{t("users")}</span>
+ * <span>{t("required", { field: t("email") })}</span>
+ */
+declare function useSsoTranslation(): {
+    t: (key: TranslationKey, options?: Record<string, unknown>) => string;
+};
+
+type TranslationMessages = Record<string, any>;
+interface I18nProviderProps {
+    children: ReactNode;
+    /** App-specific translations for each locale */
+    translations?: {
+        en?: TranslationMessages;
+        ja?: TranslationMessages;
+        vi?: TranslationMessages;
+    };
+    /** Default locale (defaults to "ja") */
+    fallbackLocale?: string;
+}
+declare function I18nProvider({ children, translations, fallbackLocale }: I18nProviderProps): react_jsx_runtime.JSX.Element;
+
+type TranslationValues = Record<string, string | number>;
+/**
+ * Hook that mimics next-intl's useTranslations API
+ *
+ * @example
+ * // Without namespace (uses default "translation" namespace)
+ * const t = useTranslations();
+ * t("common.save") // "Save"
+ *
+ * // With namespace prefix
+ * const t = useTranslations("auth");
+ * t("login") // accesses "auth.login"
+ */
+declare function useTranslations(namespace?: string): (key: string, values?: TranslationValues) => string;
+
+/**
+ * i18n configuration constants
+ */
+declare const locales: readonly ["ja", "en", "vi"];
+type Locale = (typeof locales)[number];
+declare const defaultLocale: Locale;
+declare const localeNames: Record<Locale, string>;
+declare const changeLanguage: (locale: Locale) => void;
+declare const getCurrentLocale: () => Locale;
+
+/**
+ * Hook to get the current locale
+ * This provides the same API as next-intl's useLocale()
+ */
+declare function useLocale(): Locale;
+
 /**
  * Branch header utilities for API clients
  *
@@ -479,13 +809,6 @@ declare function createBranchHeaderSetter(axiosInstance: AxiosLike): (selection:
  */
 declare function setBranchHeaders(axiosInstance: AxiosLike, selection: BranchGateSelection | null): void;
 
-/**
- * Base service configuration
- */
-interface ServiceConfig {
-    apiUrl: string;
-}
-
 /**
  * Auth Service - SSO Authentication
  *
@@ -591,17 +914,24 @@ type TokenService = ReturnType<typeof createTokenService>;
  */
 
 interface Role$1 {
-    id: number;
+    id: string;
     name: string;
     slug: string;
     description: string | null;
     level: number;
+    console_org_id?: string | null;
     permissions_count?: number;
+    organization?: {
+        id: string;
+        console_org_id: string;
+        name: string;
+        code: string;
+    } | null;
     created_at: string;
     updated_at: string;
 }
 interface Permission$1 {
-    id: number;
+    id: string;
     name: string;
     slug: string;
     group: string | null;
@@ -618,6 +948,12 @@ interface CreateRoleInput$1 {
     name: string;
     level: number;
     description?: string;
+    scope?: 'global' | 'org';
+    console_org_id?: string | null;
+}
+interface RoleListParams {
+    'filter[scope]'?: 'global' | 'org' | 'all';
+    'filter[org_id]'?: string;
 }
 interface UpdateRoleInput$1 {
     name?: string;
@@ -651,7 +987,7 @@ declare function createRoleService(config: ServiceConfig): {
      * List all roles (admin)
      * GET /api/admin/sso/roles
      */
-    adminList: (orgSlug: string) => Promise<{
+    adminList: (orgSlug: string, params?: RoleListParams) => Promise<{
         data: Role$1[];
     }>;
     /**
@@ -1036,17 +1372,18 @@ interface Organization {
     role: string;
 }
 interface Role {
-    id: number;
+    id: string;
     name: string;
     slug: string;
     description: string | null;
     level: number;
+    console_org_id?: string | null;
     permissions_count?: number;
     created_at: string;
     updated_at: string;
 }
 interface Permission {
-    id: number;
+    id: string;
     name: string;
     slug: string;
     group: string | null;
@@ -1407,6 +1744,23 @@ declare const ssoQueryKeys: {
         readonly list: (userId: string) => readonly ["sso", "user-roles", string];
         readonly byBranch: (userId: string, orgId: string, branchId: string | null) => readonly ["sso", "user-roles", string, string, string | null];
     };
+    readonly users: {
+        readonly all: () => readonly ["sso", "users"];
+        readonly list: (params?: {
+            page?: number;
+            per_page?: number;
+            search?: string;
+            sort?: string;
+            order?: string;
+        }) => readonly ["sso", "users", "list", {
+            page?: number;
+            per_page?: number;
+            search?: string;
+            sort?: string;
+            order?: string;
+        } | undefined];
+        readonly detail: (id: number | string) => readonly ["sso", "users", "detail", string | number];
+    };
     readonly branches: {
         readonly all: () => readonly ["sso", "branches"];
         readonly list: (orgSlug?: string) => readonly ["sso", "branches", "list", string | undefined];
@@ -1415,6 +1769,23 @@ declare const ssoQueryKeys: {
         readonly primary: (orgSlug?: string) => readonly ["sso", "branches", "primary", string | undefined];
     };
     readonly admin: {
+        readonly users: {
+            readonly all: (orgSlug: string) => readonly ["sso", "admin", string, "users"];
+            readonly list: (orgSlug: string, params?: {
+                page?: number;
+                per_page?: number;
+                search?: string;
+                sort?: string;
+                order?: string;
+            }) => readonly ["sso", "admin", string, "users", "list", {
+                page?: number;
+                per_page?: number;
+                search?: string;
+                sort?: string;
+                order?: string;
+            } | undefined];
+            readonly detail: (orgSlug: string, id: number | string) => readonly ["sso", "admin", string, "users", "detail", string | number];
+        };
         readonly roles: {
             readonly all: (orgSlug: string) => readonly ["sso", "admin", string, "roles"];
             readonly list: (orgSlug: string) => readonly ["sso", "admin", string, "roles", "list"];
@@ -1449,4 +1820,4 @@ declare const ssoQueryKeys: {
     };
 };
 
-export { type ApiToken$1 as ApiToken, type AssignRoleInput, type AssignRoleResponse, type AuthCallbackInput, type AuthCallbackResponse, type AuthService, type SsoUser$1 as AuthUser, type AuthUserResponse, BRANCH_HEADERS, type Branch, BranchContext, BranchContextValue, BranchGate, BranchGateProps, BranchGateSelection, BranchProvider, BranchProviderProps, type BranchService, type BranchesResponse, type CleanupOrphanedInput$1 as CleanupOrphanedInput, type CreatePermissionInput$1 as CreatePermissionInput, type CreateRoleInput$1 as CreateRoleInput, OrgBranchSelectorModal, OrgBranchSelectorModalProps, type Organization$1 as Organization, OrganizationSwitcher, OrganizationSwitcherProps, type OrphanedTeam$1 as OrphanedTeam, type Permission$1 as Permission, type PermissionListParams, type PermissionMatrix$1 as PermissionMatrix, type PermissionService, ProtectedRoute, ProtectedRouteProps, type RemoveRoleResponse, type Role$1 as Role, type RoleAssignment, type RoleScope, type RoleService, type RoleWithPermissions$1 as RoleWithPermissions, type ServiceConfig, type Permission$1 as ServicePermission, type Role$1 as ServiceRole, SsoCallback, SsoCallbackProps, SsoConfig, SsoContext, SsoContextValue, SsoOrganization, SsoProvider, SsoProviderProps, type SsoService, type SsoServiceConfig, type SsoUser$1 as SsoServiceUser, SsoUser$2 as SsoUser, type SyncPermissionsInput$1 as SyncPermissionsInput, type SyncPermissionsResponse, type SyncRolesInput, type SyncRolesResponse, type SyncTeamPermissionsInput, type TeamPermissionDetail$1 as TeamPermissionDetail, type TeamService, type TeamWithPermissions$1 as TeamWithPermissions, type TokenService, type UpdatePermissionInput$1 as UpdatePermissionInput, type UpdateRoleInput$1 as UpdateRoleInput, type UseAuthReturn, type UseBranchReturn, type UseOrganizationReturn, type UseSsoReturn, type UserRoleService, createAuthService, createBranchHeaderSetter, createBranchService, createPermissionService, createRoleService, createSsoService, createTeamService, createTokenService, createUserRoleService, getEffectivePermissions, getScopeLabel, setBranchHeaders, ssoQueryKeys, useAuth, useBranch, useBranchGate, useOrganization, useSso };
+export { type ApiToken$1 as ApiToken, type AssignRoleInput, type AssignRoleResponse, type AuthCallbackInput, type AuthCallbackResponse, type AuthService, type SsoUser$1 as AuthUser, type AuthUserResponse, BRANCH_HEADERS, type Branch, BranchContext, BranchContextValue, BranchGate, BranchGateProps, BranchGateSelection, BranchProvider, BranchProviderProps, type BranchService, type BranchesResponse, type CleanupOrphanedInput$1 as CleanupOrphanedInput, type CreatePermissionInput$1 as CreatePermissionInput, type CreateRoleInput$1 as CreateRoleInput, I18nProvider, type I18nProviderProps, type Locale, OrgBranchSelectorModal, OrgBranchSelectorModalProps, type Organization$1 as Organization, OrganizationSwitcher, OrganizationSwitcherProps, type OrphanedTeam$1 as OrphanedTeam, type Permission$1 as Permission, type PermissionListParams, type PermissionMatrix$1 as PermissionMatrix, type PermissionService, ProtectedRoute, ProtectedRouteProps, type RemoveRoleResponse, type Role$1 as Role, type RoleAssignment, type RoleAssignmentWithPermissions, type RoleScope, type RoleService, type RoleWithPermissions$1 as RoleWithPermissions, type ServiceConfig, type Permission$1 as ServicePermission, type Role$1 as ServiceRole, SsoCallback, SsoCallbackProps, SsoConfig, SsoContext, SsoContextValue, SsoOrganization, SsoProvider, SsoProviderProps, type SsoService, type SsoServiceConfig, type SsoUser$1 as SsoServiceUser, SsoUser$2 as SsoUser, type SyncPermissionsInput$1 as SyncPermissionsInput, type SyncPermissionsResponse, type SyncRolesInput, type SyncRolesResponse, type SyncTeamPermissionsInput, type TeamMembershipWithPermissions, type TeamPermissionDetail$1 as TeamPermissionDetail, type TeamService, type TeamWithPermissions$1 as TeamWithPermissions, type TokenService, type UpdatePermissionInput$1 as UpdatePermissionInput, type UpdateRoleInput$1 as UpdateRoleInput, type UpdateUserInput, type UseAuthReturn, type UseBranchReturn, type UseOrganizationReturn, type UseSsoReturn, type User, UserForm, type UserFormProps, type UserListParams, type UserListResponse, type UserPermissionsBreakdown, type UserRoleService, type UserService, UserTable, type UserTableProps, changeLanguage, createAuthService, createBranchHeaderSetter, createBranchService, createPermissionService, createRoleService, createSsoService, createTeamService, createTokenService, createUserRoleService, createUserService, defaultLocale, defaultTranslations, getCurrentLocale, getEffectivePermissions, getScopeLabel, localeNames, locales, setBranchHeaders, ssoNamespace, ssoQueryKeys, useAuth, useBranch, useBranchGate, useLocale, useOrganization, useSso, useSsoTranslation, useTranslations };