react-toolkits 2.8.3 → 2.9.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # react-toolkits
 
+## 2.9.1
+
+### Patch Changes
+
+- 49ea5ca: refactor: remove NOT_REGISTERED
+
+## 2.9.0
+
+### Minor Changes
+
+- 5cd1738: refactor: ContextProvider
+
 ## 2.8.3
 
 ### Patch Changes

package/lib/index.d.ts

@@ -1,6 +1,6 @@
-import * as react from 'react';
-import { ReactNode, FC, PropsWithChildren, Key, ReactElement, Ref } from 'react';
 import * as zustand from 'zustand';
+import * as react from 'react';
+import { FC, PropsWithChildren, Key, ReactNode, ReactElement, Ref } from 'react';
 import { ParagraphProps } from 'antd/es/typography/Paragraph';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { FormInstance, ButtonProps, ModalProps, FormProps } from 'antd';
@@ -13,6 +13,26 @@ import { AnyObject } from 'antd/es/_util/type';
 import * as swr from 'swr';
 import { MutatorCallback, MutatorOptions } from 'swr';
 
+declare class RequestError extends Error {
+    status: number;
+    code?: number;
+    constructor(opts: {
+        message?: string;
+        status: number;
+        code?: number;
+    });
+}
+interface RequestOptions extends Omit<RequestInit, 'body'> {
+    body?: Record<string | number, any> | FormData | null;
+    params?: Record<string | number, any> | URLSearchParams | null;
+    responseType?: 'json' | 'blob' | 'text';
+    isGlobal?: boolean;
+}
+type RequestResponse<T> = Pick<Response, 'headers' | 'status' | 'statusText' | 'url'> & {
+    data: T;
+};
+declare function request<T = any, R = RequestResponse<T>>(url: string, opts?: RequestOptions): Promise<R>;
+
 type Locale = {
     global: {
         noEntitlement: string;
@@ -40,7 +60,7 @@ type Locale = {
         title: string;
         thirdParty: string;
         signInWithIDass: string;
-        notRegistered: string;
+        unregistered: string;
         welcome: string;
     };
     NotFound: {
@@ -102,15 +122,22 @@ type Locale = {
     };
 };
 
-interface ContextState {
+interface ContextProps {
+    locale: Locale;
     usePermissionApiV2: boolean;
-    locale?: Locale;
-    localeDropdownMenu?: ReactNode;
+    interceptor?: {
+        response?: (response: Response, opts: RequestOptions) => Promise<any>;
+    };
 }
-
-declare const contextStore: zustand.StoreApi<ContextState>;
-declare function useToolkitsContext(): ContextState;
-declare const ContextProvider: FC<PropsWithChildren<Partial<ContextState>>>;
+interface ContextState extends ContextProps {
+    setContext: (props: Partial<ContextProps>) => void;
+}
+declare const createContextStore: (initProps?: Partial<ContextProps>) => zustand.StoreApi<ContextState>;
+type ContextStore = ReturnType<typeof createContextStore>;
+declare let contextStore: ContextStore;
+declare function useToolkitsContext<T>(selector: (state: ContextState) => T): T;
+type ContextProviderProps = PropsWithChildren<Partial<ContextProps>>;
+declare const ContextProvider: FC<ContextProviderProps>;
 
 interface DynamicTagsProps {
     initialTags?: string[];
@@ -252,26 +279,6 @@ interface PermissionGuardProps {
 }
 declare const PermissionGuard: FC<PropsWithChildren<PermissionGuardProps>>;
 
-declare class RequestError extends Error {
-    status: number;
-    code?: number;
-    constructor(opts: {
-        message?: string;
-        status: number;
-        code?: number;
-    });
-}
-interface RequestOptions extends Omit<RequestInit, 'body'> {
-    body?: Record<string | number, any> | FormData | null;
-    params?: Record<string | number, any> | URLSearchParams | null;
-    responseType?: 'json' | 'blob' | 'text';
-    isGlobal?: boolean;
-}
-type RequestResponse<T> = Pick<Response, 'headers' | 'status' | 'statusText' | 'url'> & {
-    data: T;
-};
-declare function request<T = any>(url: string, opts?: RequestOptions): Promise<RequestResponse<T>>;
-
 interface ListResponse<T = any> {
     list: T[];
     total: number;
@@ -337,8 +344,6 @@ interface UserWidgetProps {
 }
 declare const UserWidget: FC<UserWidgetProps>;
 
-declare const NOT_REGISTERED = "notRegistered";
-
 interface ModalState {
     open: Map<number, boolean>;
     getOpen: (uuid: number) => boolean;
@@ -416,9 +421,9 @@ declare const useTokenStore: zustand.UseBoundStore<Omit<zustand.StoreApi<TokenSt
         }>>;
     };
 }>;
-declare function useTokenValidation(skip?: boolean): swr.SWRResponse<RequestResponse<any>, any, {
-    onError: (error: any) => void;
-}>;
+declare function useTokenValidation(options?: {
+    skip: false;
+}): swr.SWRResponse<RequestResponse<any>, any, any>;
 
 interface NotFoundProps {
     redirectUrl?: string;
@@ -432,9 +437,11 @@ declare const PermissionRoutes: () => react_jsx_runtime.JSX.Element;
 interface SignInProps {
     title?: ReactNode;
     successRedirectUrl: string;
+    extra?: ReactNode;
+    unregistered?: boolean;
 }
 declare const SignIn: FC<SignInProps>;
 
 declare const mixedStorage: StateStorage;
 
-export { ContextProvider, type ContextState, DynamicTags, type DynamicTagsProps, ExpandableParagraph, FilterFormWrapper, type FilterFormWrapperProps, type Game, Highlight, type HighlightTextsProps, InfiniteList, type InfiniteListProps, Layout, NOT_REGISTERED, NavMenu, type NavMenuItem, NotFound, OperationLogList, PermissionButton, type PermissionButtonProps, PermissionGuard, type PermissionGuardProps, PermissionRoutes, QueryList, QueryListAction, type QueryListProps, type QueryListRef, RequestError, type RequestOptions, type RequestResponse, SignIn, type TokenState, type UseFormModalProps, UserWidget, contextStore, mixedStorage, request, useFormModal, useGameStore, useModal, useModalStore, usePermission, usePermissions, useQueryListStore, useTokenStore, useTokenValidation, useToolkitsContext };
+export { ContextProvider, type ContextState, DynamicTags, type DynamicTagsProps, ExpandableParagraph, FilterFormWrapper, type FilterFormWrapperProps, type Game, Highlight, type HighlightTextsProps, InfiniteList, type InfiniteListProps, Layout, NavMenu, type NavMenuItem, NotFound, OperationLogList, PermissionButton, type PermissionButtonProps, PermissionGuard, type PermissionGuardProps, PermissionRoutes, QueryList, QueryListAction, type QueryListProps, type QueryListRef, RequestError, type RequestOptions, type RequestResponse, SignIn, type TokenState, type UseFormModalProps, UserWidget, contextStore, mixedStorage, request, useFormModal, useGameStore, useModal, useModalStore, usePermission, usePermissions, useQueryListStore, useTokenStore, useTokenValidation, useToolkitsContext };