@acrool/react-fetcher 0.0.2-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Acrool
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# Acrool React Fetcher
+
+<a href="https://acrool-react-fetcher.pages.dev/" title="Acrool React Fetcher - This is a block function for React development loading block">
+    <img src="https://raw.githubusercontent.com/acrool/acrool-react-fetcher/main/example/public/og.webp" alt="Acrool React Fetcher Logo"/>
+</a>
+
+<p align="center">
+    This is a toast message function for React development notifications
+</p>
+
+<div align="center">
+
+[![NPM](https://img.shields.io/npm/v/@acrool/react-fetcher.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/react-fetcher)
+[![npm](https://img.shields.io/bundlejs/size/@acrool/react-fetcher?style=for-the-badge)](https://github.com/acrool/@acrool/react-fetcher/blob/main/LICENSE)
+[![npm](https://img.shields.io/npm/l/@acrool/react-fetcher?style=for-the-badge)](https://github.com/acrool/react-fetcher/blob/main/LICENSE)
+
+[![npm downloads](https://img.shields.io/npm/dm/@acrool/react-fetcher.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/react-fetcher)
+[![npm](https://img.shields.io/npm/dt/@acrool/react-fetcher.svg?style=for-the-badge)](https://www.npmjs.com/package/@acrool/react-fetcher)
+
+</div>
+
+
+`^1.1.0 support react >=18.0.0 <20.0.0`
+
+
+
+## Features
+
+- Supports queue block list
+- Plug and unplug using `@acrool/react-portal` and `framer-motion`
+
+## Install
+
+```bash
+yarn add @acrool/react-fetcher
+```
+
+
+## Usage
+
+add in your index.tsx
+```tst
+import "@acrool/react-fetcher/dist/index.css";
+```
+
+add in your App.tsx
+
+```tsx
+import {BlockPortal} from "@acrool/react-fetcher";
+
+const App = () => {
+    return (
+        <div>
+            <BaseUsed/>
+            <BlockPortal
+                isVisibleQueueKey={false}
+                loader={<Loader/>}
+                defaultMessage="Loading..."
+            />
+        </div>
+    );
+};
+```
+
+then in your page
+
+```tsx
+import {block} from '@acrool/react-fetcher';
+import {useEffect} from "react";
+
+const Example = () => {
+
+    useEffect(() => {
+        block.show();
+        
+        setTimeout(() => {
+            block.hide();
+        }, 3000)
+    }, []);
+
+    return (
+        <div>
+            sample page
+        </div>
+    );
+};
+```
+
+- block.show
+- block.hide
+
+
+There is also a example that you can play with it:
+
+[![Play react-editext-example](https://raw.githubusercontent.com/acrool/acrool-react-fetcher/main/play-in-example-button.svg)](https://acrool-react-fetcher.pages.dev)
+
+
+## License
+
+MIT © [Acrool](https://github.com/acrool) & [Imagine](https://github.com/imagine10255)

package/dist/AuthStateProvider/AuthStateProvider.d.ts

@@ -0,0 +1,20 @@
+import { ReactNode } from 'react';
+import { TAuthTokensUpdater, TForceLogout, TGetTokens, TOnForceLogout, TOnGetTokens, TOnRefreshToken, TOnSetTokens, TRefreshToken } from './types';
+interface AuthState {
+    lastUpdateTimestamp: number;
+    getTokens: TGetTokens;
+    updateTokens: TAuthTokensUpdater;
+    refreshTokens: TRefreshToken;
+    forceLogout: TForceLogout;
+    isAuth: boolean;
+}
+export declare const useAuthState: () => AuthState;
+interface AuthStateProviderProps {
+    children: ReactNode;
+    onSetTokens: TOnSetTokens;
+    onGetTokens: TOnGetTokens;
+    onRefreshTokens: TOnRefreshToken;
+    onForceLogout: TOnForceLogout;
+}
+declare const AuthStateProvider: ({ children, onGetTokens, onSetTokens, onRefreshTokens, onForceLogout }: AuthStateProviderProps) => import("react/jsx-runtime").JSX.Element;
+export default AuthStateProvider;

package/dist/AuthStateProvider/index.d.ts

@@ -0,0 +1,2 @@
+export { default as AuthStateProvider, useAuthState } from './AuthStateProvider';
+export type { IAuthTokens } from './types';

package/dist/AuthStateProvider/types.d.ts

@@ -0,0 +1,12 @@
+export interface IAuthTokens {
+    accessToken?: string;
+    refreshToken?: string;
+}
+export type TAuthTokensUpdater = (tokensOrUpdater: IAuthTokens | null | ((curr: IAuthTokens | null) => IAuthTokens | null)) => void;
+export type TOnRefreshToken = (refreshToken: string) => Promise<IAuthTokens | undefined>;
+export type TRefreshToken = () => Promise<void>;
+export type TOnForceLogout = () => void;
+export type TForceLogout = () => void;
+export type TOnSetTokens = TAuthTokensUpdater;
+export type TOnGetTokens = () => IAuthTokens | null;
+export type TGetTokens = () => IAuthTokens | null;

package/dist/FetcherProvider/AxiosCancelException.d.ts

@@ -0,0 +1,17 @@
+interface IResponse {
+    message: string;
+    code?: string | undefined;
+    args?: unknown;
+    path?: string;
+}
+export default class AxiosCancelException extends Error {
+    private readonly response;
+    readonly code: any;
+    readonly devInfo: any;
+    readonly args: any;
+    readonly path: any;
+    constructor(response: IResponse);
+    initName(): void;
+    getInfo(): IResponse;
+}
+export {};

package/dist/FetcherProvider/FetcherProvider.d.ts

@@ -0,0 +1,21 @@
+import { AxiosInstance, InternalAxiosRequestConfig } from 'axios';
+import { default as React } from 'react';
+import { IResponseFirstError } from './types';
+export declare const AxiosClientContext: React.Context<AxiosInstance>;
+export declare const useAxiosClient: () => AxiosInstance;
+interface IProps {
+    children: React.ReactNode;
+    i18nDict?: Record<string, Record<number, string>>;
+    checkIsRefreshTokenRequest?: (config: InternalAxiosRequestConfig) => boolean;
+    getLocale: () => string;
+    onError?: (error: IResponseFirstError) => void;
+}
+/**
+ * Axios Client 提供者
+ * @param children
+ * @param authTokensManager
+ * @param getLocale
+ * @param onError
+ */
+declare const FetcherProvider: ({ children, getLocale, onError, i18nDict, checkIsRefreshTokenRequest, }: IProps) => import("react/jsx-runtime").JSX.Element;
+export default FetcherProvider;

package/dist/FetcherProvider/config.d.ts

@@ -0,0 +1,2 @@
+export declare const axiosInstance: import('axios').AxiosInstance;
+export declare const defaultI18nDict: Record<string, Record<string, string>>;

package/dist/FetcherProvider/index.d.ts

@@ -0,0 +1,2 @@
+export { default as FetcherProvider } from './FetcherProvider';
+export type { IResponseFirstError } from './types';

package/dist/FetcherProvider/types.d.ts

@@ -0,0 +1,10 @@
+import { AxiosError, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
+export type TInterceptorRequest = (value: InternalAxiosRequestConfig<any>) => InternalAxiosRequestConfig<any> | Promise<InternalAxiosRequestConfig<any>>;
+export type TInterceptorResponseSuccess = (value: AxiosResponse<any>) => AxiosResponse<any> | Promise<AxiosResponse<any>>;
+export type TInterceptorResponseError = (error: AxiosError<any>) => AxiosResponse<any> | Promise<AxiosResponse<any>>;
+export interface IResponseFirstError {
+    message: string;
+    code: string;
+    path?: string;
+    args?: any;
+}

package/dist/FetcherProvider/utils.d.ts

@@ -0,0 +1,7 @@
+import { AxiosResponse } from 'axios';
+import { IResponseFirstError } from './types';
+/**
+ * 返回 Axios 格式錯誤
+ * @param response
+ */
+export declare const getResponseFirstError: (response?: AxiosResponse) => IResponseFirstError;