openxiangda 1.0.84 → 1.0.86

package/packages/sdk/dist/openxiangdaProvider-CaXMpsnK.d.ts

@@ -0,0 +1,328 @@
+import React__default, { CSSProperties } from 'react';
+
+type AuthMethodType = "password" | "dingtalk" | "sso" | "guest" | "phone_code" | string;
+interface AuthMethod {
+    type: AuthMethodType;
+    enabled?: boolean;
+    label?: string;
+    protocol?: string;
+    [key: string]: unknown;
+}
+interface LoginMethodsResult {
+    appType: string;
+    configCode?: string;
+    methods: AuthMethod[];
+    registration?: {
+        mode?: string;
+        [key: string]: unknown;
+    };
+    security?: {
+        hideFailureReason?: boolean;
+        [key: string]: unknown;
+    };
+    defaultRedirectUrl?: string;
+}
+interface AuthUser {
+    id: string;
+    username?: string;
+    name?: string;
+    phone?: string | null;
+    email?: string | null;
+    avatar?: string | null;
+    jobNumber?: string | null;
+    departments?: Array<Record<string, unknown>>;
+    affiliatedDepartmentId?: string | null;
+    affiliatedDepartment?: Record<string, unknown> | null;
+    [key: string]: unknown;
+}
+interface AuthTokenData {
+    accessToken: string;
+    refreshToken: string;
+    token?: string;
+    accessTokenExpiresAt?: number;
+    refreshTokenExpiresAt?: number;
+    user?: AuthUser;
+    guestUser?: AuthUser;
+    [key: string]: unknown;
+}
+interface PhoneCodeSendResult {
+    challengeId: string;
+    expiresAt?: string | Date;
+    ttlSeconds?: number;
+    message?: string;
+}
+interface SsoLoginUrlResult {
+    loginUrl: string;
+    protocol?: string;
+}
+interface AuthClientOptions {
+    appType: string;
+    servicePrefix?: string;
+    fetchImpl?: typeof fetch;
+}
+interface PasswordLoginInput {
+    username: string;
+    password: string;
+    clientFingerprint?: string;
+    challengeId?: string;
+    challengeAnswer?: string;
+}
+interface DingTalkLoginInput {
+    code: string;
+    corpId?: string;
+}
+interface GuestLoginInput {
+    guestIdentifier?: string;
+    domain?: string;
+    ipAddress?: string;
+    userAgent?: string;
+    formUuid?: string;
+}
+interface PhoneCodeInput {
+    phone: string;
+    purpose?: "login" | "register" | string;
+}
+interface PhoneCodeLoginInput {
+    phone: string;
+    code: string;
+    challengeId?: string;
+}
+interface PhoneCodeRegisterInput extends PhoneCodeLoginInput {
+    name?: string;
+    email?: string;
+}
+interface SsoLoginUrlInput {
+    protocol?: string;
+    redirectUri?: string;
+}
+interface RefreshInput {
+    refreshToken?: string;
+}
+interface ResolveLoginUrlInput {
+    callbackUrl?: string;
+    callbackParamName?: string;
+    loginUrl?: string;
+}
+interface AppAuthClient {
+    appType: string;
+    servicePrefix: string;
+    getMethods: () => Promise<LoginMethodsResult>;
+    passwordLogin: (input: PasswordLoginInput) => Promise<AuthTokenData>;
+    dingtalkLogin: (input: DingTalkLoginInput) => Promise<AuthTokenData>;
+    guestLogin: (input?: GuestLoginInput) => Promise<AuthTokenData>;
+    sendPhoneCode: (input: PhoneCodeInput) => Promise<PhoneCodeSendResult>;
+    phoneCodeLogin: (input: PhoneCodeLoginInput) => Promise<AuthTokenData>;
+    registerWithPhoneCode: (input: PhoneCodeRegisterInput) => Promise<AuthTokenData>;
+    getSsoLoginUrl: (input?: SsoLoginUrlInput) => Promise<SsoLoginUrlResult>;
+    refresh: (input?: RefreshInput) => Promise<AuthTokenData>;
+    logout: () => Promise<void>;
+    resolveLoginUrl: (input?: ResolveLoginUrlInput) => string;
+}
+declare class AuthClientError extends Error {
+    status?: number;
+    code?: number | string;
+    payload?: unknown;
+    constructor(message: string, options?: {
+        status?: number;
+        code?: number | string;
+        payload?: unknown;
+    });
+}
+declare const createAuthClient: ({ appType, servicePrefix, fetchImpl, }: AuthClientOptions) => AppAuthClient;
+
+interface UseAuthOptions extends Partial<AuthClientOptions> {
+}
+interface UseLoginMethodsState {
+    data: LoginMethodsResult | null;
+    methods: AuthMethod[];
+    loading: boolean;
+    error: Error | null;
+    reload: () => Promise<void>;
+}
+interface LoginPageProps extends UseAuthOptions {
+    title?: React__default.ReactNode;
+    subtitle?: React__default.ReactNode;
+    className?: string;
+    style?: CSSProperties;
+    defaultMethod?: "password" | "phone_code";
+    redirectUrl?: string;
+    redirectOnSuccess?: boolean;
+    onSuccess?: (data: AuthTokenData) => void | Promise<void>;
+}
+declare const useAuth: (options?: UseAuthOptions) => {
+    client: AppAuthClient;
+    getMethods: () => Promise<LoginMethodsResult>;
+    passwordLogin: (input: PasswordLoginInput) => Promise<AuthTokenData>;
+    dingtalkLogin: (input: DingTalkLoginInput) => Promise<AuthTokenData>;
+    guestLogin: (input?: GuestLoginInput) => Promise<AuthTokenData>;
+    sendPhoneCode: (input: PhoneCodeInput) => Promise<PhoneCodeSendResult>;
+    phoneCodeLogin: (input: PhoneCodeLoginInput) => Promise<AuthTokenData>;
+    registerWithPhoneCode: (input: PhoneCodeRegisterInput) => Promise<AuthTokenData>;
+    getSsoLoginUrl: (input?: SsoLoginUrlInput) => Promise<SsoLoginUrlResult>;
+    refresh: (input?: RefreshInput) => Promise<AuthTokenData>;
+    logout: () => Promise<void>;
+    resolveLoginUrl: (input?: ResolveLoginUrlInput) => string;
+};
+declare const useLoginMethods: (options?: UseAuthOptions) => UseLoginMethodsState;
+declare const LoginPage: React__default.FC<LoginPageProps>;
+
+type RuntimeErrorType = "unauthenticated" | "forbidden" | "network" | "unknown";
+type RuntimeRequestError = Error & {
+    type?: RuntimeErrorType;
+    status?: number;
+    code?: number | string;
+    payload?: unknown;
+};
+interface RuntimeErrorSnapshot {
+    type: RuntimeErrorType;
+    status?: number;
+    code?: number | string;
+    message: string;
+    payload?: unknown;
+}
+declare class RuntimeHttpError extends Error {
+    type: RuntimeErrorType;
+    status?: number;
+    code?: number | string;
+    payload?: unknown;
+    constructor(snapshot: RuntimeErrorSnapshot);
+}
+interface RuntimeMenuItem {
+    id: string;
+    name: string;
+    resourceCode?: string | null;
+    routeCode?: string | null;
+    path?: string | null;
+    type?: string;
+    formUuid?: string | null;
+    pageId?: string | null;
+    parentId?: string | null;
+    sortOrder?: number;
+    isHidden?: boolean;
+    icon?: string | null;
+    children?: RuntimeMenuItem[];
+    [key: string]: unknown;
+}
+interface RuntimePagePermissions {
+    appType: string;
+    hasFullAccess: boolean;
+    roleCodes: string[];
+    roleSource?: string;
+    menuFormUuids: string[];
+    menuCodes: string[];
+    routeCodes: string[];
+    pathPatterns: string[];
+}
+interface RuntimeBootstrap {
+    appType: string;
+    app?: Record<string, unknown> | null;
+    user?: Record<string, unknown> | null;
+    runtime?: {
+        mode?: "legacy" | "react-spa" | string;
+        settings?: Record<string, unknown>;
+        activeReleaseId?: string | null;
+        activeBuildId?: string | null;
+        indexUrl?: string | null;
+        assetBaseUrl?: string | null;
+    };
+    permissions?: RuntimePagePermissions;
+    menus?: RuntimeMenuItem[];
+    servicePrefix?: string;
+}
+interface RouteAccessResult {
+    appType: string;
+    canAccess: boolean;
+    routeCode?: string;
+    menuCode?: string;
+    path?: string;
+    status?: number;
+    code?: number | string;
+    message?: string;
+    errorType?: RuntimeErrorType;
+    payload?: unknown;
+    permissions?: RuntimePagePermissions;
+}
+interface RuntimeRequestState<T> {
+    data: T | null;
+    loading: boolean;
+    error: RuntimeRequestError | null;
+}
+interface OpenXiangdaProviderProps {
+    appType?: string;
+    servicePrefix?: string;
+    fetchImpl?: typeof fetch;
+    children: React__default.ReactNode;
+}
+interface OpenXiangdaRuntimeStore extends RuntimeRequestState<RuntimeBootstrap> {
+    appType: string;
+    servicePrefix: string;
+    fetchImpl: typeof fetch;
+    reload: () => Promise<void>;
+}
+declare const OpenXiangdaProvider: React__default.FC<OpenXiangdaProviderProps>;
+declare const useOpenXiangda: () => OpenXiangdaRuntimeStore;
+declare const useRuntimeBootstrap: () => OpenXiangdaRuntimeStore;
+declare const useAppMenus: () => {
+    data: RuntimeMenuItem[];
+    appType: string;
+    servicePrefix: string;
+    fetchImpl: typeof fetch;
+    reload: () => Promise<void>;
+    loading: boolean;
+    error: RuntimeRequestError | null;
+};
+declare const usePermission: () => {
+    data: RuntimePagePermissions | null;
+    appType: string;
+    servicePrefix: string;
+    fetchImpl: typeof fetch;
+    reload: () => Promise<void>;
+    loading: boolean;
+    error: RuntimeRequestError | null;
+};
+interface UseCanAccessRouteInput {
+    routeCode?: string;
+    menuCode?: string;
+    path?: string;
+}
+declare const useCanAccessRoute: (input: UseCanAccessRouteInput) => {
+    canAccess: boolean;
+    data: RouteAccessResult | null;
+    loading: boolean;
+    error: RuntimeRequestError | null;
+};
+interface PermissionBoundaryProps extends UseCanAccessRouteInput {
+    children: React__default.ReactNode;
+    fallback?: React__default.ReactNode | PermissionBoundaryFallback;
+    loadingFallback?: React__default.ReactNode | PermissionBoundaryFallback;
+}
+interface PermissionBoundaryFallbackState {
+    access: ReturnType<typeof useCanAccessRoute>;
+    runtime: ReturnType<typeof useOpenXiangda>;
+    error: RuntimeRequestError | null;
+    errorType: RuntimeErrorType;
+    status?: number;
+    code?: number | string;
+    message: string;
+}
+type PermissionBoundaryFallback = (state: PermissionBoundaryFallbackState) => React__default.ReactNode;
+declare const PermissionBoundary: React__default.FC<PermissionBoundaryProps>;
+interface RuntimeResolveLoginOptions {
+    redirectUri?: string;
+    loginUrl?: string;
+    domain?: string;
+}
+interface RuntimeRedirectLoginOptions extends RuntimeResolveLoginOptions {
+    replace?: boolean;
+}
+interface RuntimeLogoutOptions extends RuntimeRedirectLoginOptions {
+    continueOnError?: boolean;
+}
+declare const useRuntimeAuth: () => {
+    logout: () => Promise<any>;
+    logoutAndRedirect: (options?: RuntimeLogoutOptions) => Promise<string>;
+    redirectToLogin: (options?: RuntimeRedirectLoginOptions) => Promise<string>;
+    resolveLoginUrl: (options?: RuntimeResolveLoginOptions) => Promise<string>;
+};
+
+export { type AppAuthClient as A, type RuntimeRedirectLoginOptions as B, type RuntimeRequestError as C, type DingTalkLoginInput as D, type RuntimeRequestState as E, type RuntimeResolveLoginOptions as F, type GuestLoginInput as G, type SsoLoginUrlResult as H, type UseCanAccessRouteInput as I, type UseLoginMethodsState as J, createAuthClient as K, type LoginMethodsResult as L, useAppMenus as M, useAuth as N, OpenXiangdaProvider as O, type PasswordLoginInput as P, useCanAccessRoute as Q, type RefreshInput as R, type SsoLoginUrlInput as S, useLoginMethods as T, type UseAuthOptions as U, useOpenXiangda as V, usePermission as W, useRuntimeAuth as X, useRuntimeBootstrap as Y, AuthClientError as a, type AuthClientOptions as b, type AuthMethod as c, type AuthMethodType as d, type AuthTokenData as e, type AuthUser as f, LoginPage as g, type LoginPageProps as h, type OpenXiangdaProviderProps as i, PermissionBoundary as j, type PermissionBoundaryFallback as k, type PermissionBoundaryFallbackState as l, type PermissionBoundaryProps as m, type PhoneCodeInput as n, type PhoneCodeLoginInput as o, type PhoneCodeRegisterInput as p, type PhoneCodeSendResult as q, type ResolveLoginUrlInput as r, type RouteAccessResult as s, type RuntimeBootstrap as t, type RuntimeErrorSnapshot as u, type RuntimeErrorType as v, RuntimeHttpError as w, type RuntimeLogoutOptions as x, type RuntimeMenuItem as y, type RuntimePagePermissions as z };