@vef-framework/core 1.0.5

package/README.md

@@ -0,0 +1,25 @@
+# The Core of VEF Framework
+
+VEF framework designed by Venus is built on top of React, and it provides a set of components that are essential for building a modern web application. These components are designed to be highly customizable and reusable, allowing developers to build complex and dynamic user interfaces with ease.
+
+## Installation
+
+To install the VEF framework core, you can use pnpm or any other package manager you like:
+
+```bash
+pnpm add @vef-framework/core
+```
+
+## Usage
+
+To use the VEF framework core in your project, you can import them from the package, for example:
+
+```ts
+import { xxx } from "@vef-framework/core";
+
+const result = xxx();
+```
+
+## Documentation
+
+For more details on how to use the VEF framework core, please refer to the [official documentation](https://vef.ilxqx.com/docs).

package/dist/api/api-client.d.ts

@@ -0,0 +1,175 @@
+import type { AnyValue, Api, ApiResponse, BiMapperOptional1, ChildrenProps, Except, Mapper, MaybeUndefined, MutationApi, MutationResult, ObjectType, ObjectValue, QueryApi, QueryResult, VefError } from "@vef-framework/shared";
+import { type UseQueryOptions } from "@tanstack/react-query";
+import { type FC } from "react";
+import { type QueryClientOptions } from "./query-client";
+import { type RequestClientOptions, type RequestOptions } from "./request-client";
+/**
+ * The request methods.
+ */
+export interface RequestMethods<R = unknown> {
+    get: <P extends ObjectType = ObjectValue>(url: string, options?: Except<RequestOptions<P>, "onProgress" | "signal">) => Promise<ApiResponse<R>>;
+    post: <D extends ObjectType = ObjectValue, P extends ObjectType = ObjectValue>(url: string, data?: D, options?: Except<RequestOptions<P>, "onProgress" | "signal">) => Promise<ApiResponse<R>>;
+    put: <D extends ObjectType = ObjectValue, P extends ObjectType = ObjectValue>(url: string, data?: D, options?: Except<RequestOptions<P>, "onProgress" | "signal">) => Promise<ApiResponse<R>>;
+    delete: <P extends ObjectType = ObjectValue>(url: string, options?: Except<RequestOptions<P>, "onProgress" | "signal">) => Promise<ApiResponse<R>>;
+}
+/**
+ * The API client options.
+ */
+export type ApiClientOptions = {} & RequestClientOptions & QueryClientOptions;
+/**
+ * The query options.
+ */
+export type QueryOptions<R = unknown> = {
+    /**
+     * Whether to keep the previous data.
+     */
+    keepPreviousData?: boolean;
+    /**
+     * The initial data.
+     */
+    initialData?: R;
+} & Pick<UseQueryOptions<ApiResponse<R>, VefError, R>, "staleTime" | "enabled" | "placeholderData" | "refetchInterval" | "refetchIntervalInBackground" | "refetchOnMount" | "refetchOnWindowFocus">;
+/**
+ * The API client.
+ */
+export declare class ApiClient {
+    #private;
+    readonly options: ApiClientOptions;
+    /**
+     * The useApiQuery hook.
+     * These hook functions are doing this because React's Hooks cannot be used in class methods,
+     * and this approach can bypass the check.
+     */
+    readonly useApiQuery: <T = unknown, R = unknown>(queryFn: Readonly<QueryApi<T, R>>, args: T, options?: QueryOptions<R>) => QueryResult<R>;
+    /**
+     * The useApiMutation hook.
+     * These hook functions are doing this because React's Hooks cannot be used in class methods,
+     * and this approach can bypass the check.
+     */
+    readonly useApiMutation: <T = unknown, R = unknown>(mutationFn: Readonly<MutationApi<T, R>>) => MutationResult<T, R>;
+    /**
+     * The useIsFetching hook.
+     */
+    readonly useIsFetching: BiMapperOptional1<string, unknown, boolean>;
+    /**
+     * The useIsMutating hook.
+     */
+    readonly useIsMutating: Mapper<string, boolean>;
+    /**
+     * THe QueryClientProvider component.
+     */
+    readonly QueryClientProvider: FC<ChildrenProps>;
+    /**
+     * Create an API client.
+     *
+     * @param options - The options of the API client.
+     */
+    constructor(options: ApiClientOptions);
+    /**
+     * Fetch the API query.
+     *
+     * @param queryFn - The API function.
+     * @param args - The arguments of the API.
+     * @param options - The options of the API.
+     * @returns The API query.
+     */
+    fetchApiQuery<T extends ObjectType = ObjectValue, R = unknown>(queryFn: Api<T, R>, args: T, options?: Pick<QueryOptions<R>, "initialData">): Promise<R>;
+    /**
+     * Create a query API.
+     *
+     * @param key - The key of the API.
+     * @param factory - The factory of the API function.
+     * @returns The query API.
+     */
+    createQueryApi<T extends ObjectType = ObjectValue, R = AnyValue>(key: string, factory: Mapper<RequestMethods<R>, Mapper<T, Promise<ApiResponse<R>>>>): Readonly<QueryApi<T, R>>;
+    /**
+     * Create a mutation API.
+     *
+     * @param key - The key of the API.
+     * @param factory - The factory of the API function.
+     * @param relatedQueries - The related queries.
+     * @returns The mutation API.
+     */
+    createMutationApi<T, R>(key: string, factory: Mapper<Except<RequestMethods<R>, "get">, Mapper<T, Promise<ApiResponse<R>>>>, relatedQueries?: Array<Readonly<QueryApi<any, any>>>): Readonly<MutationApi<T, R>>;
+    /**
+     * Get the API query data.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     * @returns The API query data.
+     */
+    getApiQueryData<T>(apiKey: string, args?: unknown): T | undefined;
+    /**
+     * Get the API queries data.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     * @returns The API queries data.
+     */
+    getApiQueriesData(apiKey: string, args?: unknown): [import("@tanstack/react-query").QueryKey, unknown][];
+    /**
+     * Set the API query data.
+     *
+     * @param data - The data.
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     */
+    setApiQueryData<T>(data: MaybeUndefined<T | Mapper<MaybeUndefined<T>, MaybeUndefined<T>>>, apiKey: string, args?: unknown): void;
+    /**
+     * Remove the API queries.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     */
+    removeApiQueries(apiKey: string, args?: unknown): void;
+    /**
+     * Invalidate the API queries.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     */
+    invalidateApiQueries(apiKey: string, args?: unknown): Promise<void>;
+    /**
+     * Reset the API queries.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     */
+    resetApiQueries(apiKey: string, args?: unknown): Promise<void>;
+    /**
+     * Refetch the API queries.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     */
+    refetchApiQueries(apiKey: string, args?: unknown): Promise<void>;
+    /**
+     * Cancel the API queries.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     */
+    cancelApiQueries(apiKey: string, args?: unknown): Promise<void>;
+    /**
+     * Check if the API query/queries is fetching.
+     *
+     * @param apiKey - The key of the API.
+     * @param args - The arguments of the API.
+     * @returns Whether the API query is fetching.
+     */
+    isFetching(apiKey: string, args?: unknown): boolean;
+    /**
+     * Check if the API mutation is mutating.
+     *
+     * @param apiKey - The key of the API.
+     * @returns Whether the API mutation is mutating.
+     */
+    isMutating(apiKey: string): boolean;
+}
+/**
+ * Create an API client.
+ *
+ * @param options - The options of the API client.
+ * @returns The API client.
+ */
+export declare function createApiClient(options: ApiClientOptions): Readonly<ApiClient>;

package/dist/api/api-client.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import{useQuery as e,keepPreviousData as t,useMutation as i,useIsFetching as r,useIsMutating as s,QueryClientProvider as a}from"@tanstack/react-query";import{createElement as n}from"react";import{createQueryClient as u}from"./query-client.js";import{createRequestClient as c}from"./request-client.js";var h,o,l,d,y,g,p,f,Q=Object.defineProperty,v=e=>{throw TypeError(e)},m=(e,t,i)=>((e,t,i)=>t in e?Q(e,t,{enumerable:!0,configurable:!0,writable:!0,value:i}):e[t]=i)(e,"symbol"!=typeof t?t+"":t,i),A=(e,t,i)=>t.has(e)||v("Cannot "+i),b=(e,t,i)=>(A(e,t,"read from private field"),i?i.call(e):t.get(e)),D=(e,t,i)=>t.has(e)?v("Cannot add the same private member more than once"):t instanceof WeakSet?t.add(e):t.set(e,i),w=(e,t,i,r)=>(A(e,t,"write to private field"),r?r.call(e,i):t.set(e,i),i),q=(e,t,i)=>(A(e,t,"access private method"),i);class M{constructor(f){this.options=f,D(this,y),m(this,"useApiQuery"),m(this,"useApiMutation"),m(this,"useIsFetching"),m(this,"useIsMutating"),m(this,"QueryClientProvider"),D(this,h),D(this,o),D(this,l),D(this,d),w(this,h,u(f)),w(this,o,c(f)),w(this,l,{get:async(e,t)=>{const i=b(this,d);return w(this,d,void 0),await b(this,o).get(e,{...t,signal:i})},post:async(e,t,i)=>{const r=b(this,d);return w(this,d,void 0),await b(this,o).post(e,t,{...i,signal:r})},put:async(e,t,i)=>{const r=b(this,d);return w(this,d,void 0),await b(this,o).put(e,t,{...i,signal:r})},delete:async(e,t)=>{const i=b(this,d);return w(this,d,void 0),await b(this,o).delete(e,{...t,signal:i})}});const Q=this;this.useApiQuery=function(i,r,s){var a;const{keepPreviousData:n,placeholderData:u,initialData:c,...h}=s??{},o=e({queryKey:[i.key,r],queryFn:({signal:e})=>i(r,{signal:e}),select:q(Q,y,g),placeholderData:u??!0===n?t:void 0,initialData:c?{code:0,message:"ok",data:c}:void 0,...h});return q(a=Q,y,p).call(a,o)},this.useApiMutation=function(e){const{isPending:t,isIdle:r,isError:s,isSuccess:a,error:n,data:u,mutateAsync:c}=i({mutationKey:[e.key],mutationFn:t=>e(t)});return{mutate:async e=>await c(e),isPending:t,isIdle:r,isError:s,isSuccess:a,message:u?.message,error:n??void 0,data:u?.data}},this.useIsFetching=function(e,t){return r({queryKey:arguments.length>1?[e,t]:[e],type:"active",exact:!1})>0},this.useIsMutating=function(e){return s({mutationKey:[e],exact:!1})>0},this.QueryClientProvider=function({children:e}){return n(a,{client:b(Q,h)},e)}}async fetchApiQuery(e,t,i){const{initialData:r,...s}=i??{};return(await b(this,h).fetchQuery({queryKey:[e.key,t],queryFn:({signal:i})=>e(t,{signal:i}),initialData:r?{code:0,message:"ok",data:r}:void 0,...s})).data}createQueryApi(e,t){const i=q(this,y,f).call(this,e,t);return i.getQueryData=this.getApiQueryData.bind(this,e),i.getQueriesData=this.getApiQueriesData.bind(this,e),i.setQueryData=(t,i)=>this.setApiQueryData(t,e,i),i.removeQueries=this.removeApiQueries.bind(this,e),i.invalidateQueries=this.invalidateApiQueries.bind(this,e),i.resetQueries=this.resetApiQueries.bind(this,e),i.refetchQueries=this.refetchApiQueries.bind(this,e),i.cancelQueries=this.cancelApiQueries.bind(this,e),i.isFetching=this.isFetching.bind(this,e),i.useIsFetching=this.useIsFetching.bind(void 0,e),Object.freeze(i)}createMutationApi(e,t,i=[]){const r=q(this,y,f).call(this,e,t);return r.relatedQueries=Object.freeze(i),r.refetchRelatedQueries=function(){return Promise.all(i.map((e=>e.refetchQueries())))},r.invalidateRelatedQueries=function(){return Promise.all(i.map((e=>e.invalidateQueries())))},r.isMutating=this.isMutating.bind(this,e),r.useIsMutating=this.useIsMutating.bind(void 0,e),Object.freeze(r)}getApiQueryData(e,t){return b(this,h).getQueryData(arguments.length>1?[e,t]:[e])}getApiQueriesData(e,t){return b(this,h).getQueriesData({queryKey:arguments.length>1?[e,t]:[e],type:"active",exact:!1})}setApiQueryData(e,t,i){b(this,h).setQueryData(arguments.length>2?[t,i]:[t],e)}removeApiQueries(e,t){b(this,h).removeQueries({type:"all",exact:!1,queryKey:arguments.length>1?[e,t]:[e]})}invalidateApiQueries(e,t){return b(this,h).invalidateQueries({queryKey:arguments.length>1?[e,t]:[e],type:"all",exact:!1,stale:!1,refetchType:"active"},{throwOnError:!1,cancelRefetch:!1})}resetApiQueries(e,t){return b(this,h).resetQueries({queryKey:arguments.length>1?[e,t]:[e],type:"active",exact:!1},{cancelRefetch:!0,throwOnError:!1})}refetchApiQueries(e,t){return b(this,h).refetchQueries({queryKey:arguments.length>1?[e,t]:[e],type:"active",exact:!1},{throwOnError:!1,cancelRefetch:!1})}cancelApiQueries(e,t){return b(this,h).cancelQueries({queryKey:arguments.length>1?[e,t]:[e],type:"active",exact:!1},{revert:!0,silent:!0})}isFetching(e,t){return b(this,h).isFetching({queryKey:arguments.length>1?[e,t]:[e],type:"active",exact:!1})>0}isMutating(e){return b(this,h).isMutating({mutationKey:[e],exact:!1})>0}}function k(e){return Object.freeze(new M(e))}h=new WeakMap,o=new WeakMap,l=new WeakMap,d=new WeakMap,y=new WeakSet,g=function(e){return e.data},p=function({isPending:e,isFetching:t,isLoading:i,isRefetching:r,isSuccess:s,isPlaceholderData:a,isError:n,isLoadingError:u,isRefetchError:c,isStale:h,error:o,data:l,refetch:d}){return{isPending:e,isSuccess:s,isError:n,isLoadingError:u,isRefetchError:c,isLoading:i,isFetching:t,isRefetching:r,isPlaceholderData:a,isStale:h,error:o??void 0,data:l,refetch:async()=>{const e=await d();return{isSuccess:e.isSuccess,isError:e.isError,error:e.error,data:e.data}}}},f=function(e,t){const i=t(b(this,l)),r=async(e,t)=>(w(this,d,t?.signal),await i(e));return r.key=e,r};export{M as ApiClient,k as createApiClient};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/api/api-context.d.ts

@@ -0,0 +1,137 @@
+import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
+import { type ChildrenProps, type DataDictionaryQueryApi, type MutationApi, type QueryApi } from "@vef-framework/shared";
+import { type FC } from "react";
+import type { ApiClient } from "./api-client";
+/**
+ * The API context provider props.
+ */
+export interface ApiContextProviderProps extends ChildrenProps {
+    /**
+     * The API client.
+     */
+    client: Readonly<ApiClient>;
+    /**
+     * The query API for the data dictionary.
+     */
+    dataDictionaryQueryApi?: Readonly<DataDictionaryQueryApi>;
+}
+/**
+ * The API context.
+ */
+export interface ApiContext {
+    /**
+     * The useApiQuery hook.
+     */
+    useApiQuery: ApiClient["useApiQuery"];
+    /**
+     * The useApiMutation hook.
+     */
+    useApiMutation: ApiClient["useApiMutation"];
+    /**
+     * The useIsFetching hook.
+     */
+    useIsFetching: ApiClient["useIsFetching"];
+    /**
+     * The useIsMutating hook.
+     */
+    useIsMutating: ApiClient["useIsMutating"];
+    /**
+     * The fetchApiQuery function.
+     */
+    fetchApiQuery: ApiClient["fetchApiQuery"];
+    /**
+     * The create query API function.
+     */
+    createQueryApi: ApiClient["createQueryApi"];
+    /**
+     * The create mutation API function.
+     */
+    createMutationApi: ApiClient["createMutationApi"];
+    /**
+     * The get query API data function.
+     */
+    getApiQueryData: ApiClient["getApiQueryData"];
+    /**
+     * The get query APIs data function.
+     */
+    getApiQueriesData: ApiClient["getApiQueriesData"];
+    /**
+     * The set query API data function.
+     */
+    setApiQueryData: ApiClient["setApiQueryData"];
+    /**
+     * The remove API queries function.
+     */
+    removeApiQueries: ApiClient["removeApiQueries"];
+    /**
+     * The invalidate API queries function.
+     */
+    invalidateApiQueries: ApiClient["invalidateApiQueries"];
+    /**
+     * The reset API queries function.
+     */
+    resetApiQueries: ApiClient["resetApiQueries"];
+    /**
+     * The refetch API queries function.
+     */
+    refetchApiQueries: ApiClient["refetchApiQueries"];
+    /**
+     * The cancel API queries function.
+     */
+    cancelApiQueries: ApiClient["cancelApiQueries"];
+    /**
+     * The is fetching function.
+     */
+    isFetching: ApiClient["isFetching"];
+    /**
+     * The is mutating function.
+     */
+    isMutating: ApiClient["isMutating"];
+    /**
+     * The stub query API.
+     */
+    stubQueryApi: Readonly<QueryApi<any, any>>;
+    /**
+     * The async function query API.
+     */
+    asyncFnQueryApi: Readonly<QueryApi<AsyncFnParams, any>>;
+    /**
+     * The stub mutation API.
+     */
+    stubMutationApi: Readonly<MutationApi<any, any>>;
+    /**
+     * The async function mutation API.
+     */
+    asyncFnMutationApi: Readonly<MutationApi<AsyncFnParams, any>>;
+    /**
+     * The query API for the data dictionary.
+     */
+    dataDictionaryQueryApi?: Readonly<DataDictionaryQueryApi>;
+}
+/**
+ * The async function params.
+ */
+export interface AsyncFnParams {
+    /**
+     * The key.
+     */
+    key: string;
+    /**
+     * The arguments.
+     */
+    args: any[];
+    /**
+     * The function.
+     */
+    fn: (...args: any[]) => Promise<any>;
+}
+/**
+ * The API context provider.
+ */
+declare const ApiContextProvider: FC<ApiContextProviderProps>;
+/**
+ * The use API context hook.
+ */
+declare function useApiContext(): Readonly<ApiContext>;
+declare const ApiQueryDevtools: typeof ReactQueryDevtoolsPanel;
+export { ApiContextProvider, ApiQueryDevtools, useApiContext, };

package/dist/api/api-context.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import{ReactQueryDevtoolsPanel as e}from"@tanstack/react-query-devtools";import{VefError as i}from"@vef-framework/shared";import{createContext as t,useMemo as a,createElement as r,useContext as n}from"react";const u=t(null),s=({client:e,dataDictionaryQueryApi:i,children:t})=>{const n=a((()=>{const t=e.createQueryApi("_vefStubQueryApi",(()=>async e=>({code:0,message:"ok",data:e}))),a=e.createQueryApi("_vefAsyncFnQueryApi",(()=>async({args:e,fn:i})=>({code:0,message:"ok",data:await i(...e)}))),r=e.createMutationApi("_vefStubMutationApi",(()=>async e=>({code:0,message:"ok",data:e}))),n=e.createMutationApi("_vefAsyncFnMutationApi",(()=>async({args:e,fn:i})=>({code:0,message:"ok",data:await i(...e)})));return Object.freeze({useApiQuery:e.useApiQuery,useApiMutation:e.useApiMutation,useIsFetching:e.useIsFetching,useIsMutating:e.useIsMutating,fetchApiQuery:e.fetchApiQuery.bind(e),createQueryApi:e.createQueryApi.bind(e),createMutationApi:e.createMutationApi.bind(e),getApiQueryData:e.getApiQueryData.bind(e),getApiQueriesData:e.getApiQueriesData.bind(e),setApiQueryData:e.setApiQueryData.bind(e),removeApiQueries:e.removeApiQueries.bind(e),invalidateApiQueries:e.invalidateApiQueries.bind(e),resetApiQueries:e.resetApiQueries.bind(e),refetchApiQueries:e.refetchApiQueries.bind(e),cancelApiQueries:e.cancelApiQueries.bind(e),isFetching:e.isFetching.bind(e),isMutating:e.isMutating.bind(e),stubQueryApi:t,asyncFnQueryApi:a,stubMutationApi:r,asyncFnMutationApi:n,dataDictionaryQueryApi:i})}),[e,i]);return r(u.Provider,{value:n},r(e.QueryClientProvider,{},t))};function c(){const e=n(u);if(null===e)throw new i(-1,"Api context not found: Please ensure useApiContext is called within an ApiContextProvider");return e}const o=e;export{s as ApiContextProvider,o as ApiQueryDevtools,c as useApiContext};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/api/index.d.ts

@@ -0,0 +1,3 @@
+export { ApiClient, createApiClient, type ApiClientOptions, type QueryOptions, } from "./api-client";
+export * from "./api-context";
+export { useMutation } from "@tanstack/react-query";

package/dist/api/index.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+export{ApiClient,createApiClient}from"./api-client.js";export{ApiContextProvider,ApiQueryDevtools,useApiContext}from"./api-context.js";export{useMutation}from"@tanstack/react-query";
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/api/query-client.d.ts

@@ -0,0 +1,27 @@
+import type { VefError } from "@vef-framework/shared";
+import { QueryClient } from "@tanstack/react-query";
+declare module "@tanstack/react-query" {
+    interface Register {
+        defaultError: VefError;
+    }
+}
+/**
+ * The query client options.
+ */
+export interface QueryClientOptions {
+    /**
+     * The stale time of the query client.
+     */
+    staleTime?: number;
+    /**
+     * The garbage collection time of the query client.
+     */
+    gcTime?: number;
+}
+/**
+ * Create a query client.
+ *
+ * @param options - The options of the query client.
+ * @returns The query client.
+ */
+export declare function createQueryClient(options?: QueryClientOptions): QueryClient;

package/dist/api/query-client.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import{QueryClient as e}from"@tanstack/react-query";function r(r){const t=r?.staleTime??1/0;return new e({defaultOptions:{queries:{networkMode:"always",staleTime:t,gcTime:r?.gcTime??6e5,retry:3,structuralSharing:!0,throwOnError:!1,refetchOnMount:!1,refetchOnReconnect:!0,refetchOnWindowFocus:!0},mutations:{networkMode:"always",gcTime:t,retry:!1,throwOnError:!1}}})}export{r as createQueryClient};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/api/request-client.d.ts

@@ -0,0 +1,85 @@
+import type { GenericAbortSignal } from "axios";
+import { type ApiResponse, type Consumer, type Except, type Mapper, type MaybeNullish, type ObjectType, type ObjectValue } from "@vef-framework/shared";
+/**
+ * The request client options.
+ */
+export interface RequestClientOptions {
+    baseUrl: string;
+    timeout?: number;
+    getAccessToken: () => MaybeNullish<string>;
+}
+/**
+ * The request options.
+ */
+export interface RequestOptions<P extends ObjectType = ObjectValue> {
+    signal?: GenericAbortSignal;
+    params?: P;
+    onProgress?: Consumer<number>;
+}
+/**
+ * The request client.
+ */
+export declare class RequestClient {
+    #private;
+    readonly options: RequestClientOptions;
+    constructor(options: RequestClientOptions);
+    /**
+     * Perform a GET request.
+     *
+     * @param url - The url.
+     * @param options - The request options.
+     * @returns The response data promise.
+     */
+    get<P extends ObjectType = ObjectValue, R = unknown>(url: string, options?: Except<RequestOptions<P>, "onProgress">): Promise<ApiResponse<R>>;
+    /**
+     * Perform a POST request.
+     *
+     * @param url - The url.
+     * @param data - The request data.
+     * @param options - The request options.
+     * @returns The response data promise.
+     */
+    post<D extends ObjectType = ObjectValue, R = unknown, P extends ObjectType = ObjectValue>(url: string, data?: D, options?: Except<RequestOptions<P>, "onProgress">): Promise<ApiResponse<R>>;
+    /**
+     * Perform a PUT request.
+     *
+     * @param url - The url.
+     * @param data - The request data.
+     * @param options - The request options.
+     * @returns The response data promise.
+     */
+    put<D extends ObjectType = ObjectValue, R = unknown, P extends ObjectType = ObjectValue>(url: string, data?: D, options?: Except<RequestOptions<P>, "onProgress">): Promise<ApiResponse<R>>;
+    /**
+     * Perform a DELETE request.
+     *
+     * @param url - The url.
+     * @param options - The request options.
+     * @returns The response data promise.
+     */
+    delete<P extends ObjectType = ObjectValue, R = unknown>(url: string, options?: Except<RequestOptions<P>, "onProgress">): Promise<ApiResponse<R>>;
+    /**
+     * Perform a file upload request.
+     *
+     * @param url - The url.
+     * @param data - The file data.
+     * @param options - The request options.
+     * @returns The response data promise.
+     */
+    upload<R = unknown, P extends ObjectType = ObjectValue>(url: string, data: FormData, options?: RequestOptions<P>): Promise<ApiResponse<R>>;
+    /**
+     * Perform a file download request.
+     *
+     * @param url - The url.
+     * @param options - The request options.
+     */
+    download<P extends ObjectType = ObjectValue>(url: string, options?: RequestOptions<P> & {
+        fileName?: string | Mapper<string, string>;
+    }): Promise<void>;
+}
+/**
+ * Create a request client.
+ *
+ * @param options - The options of the request client.
+ * @returns The request client.
+ */
+export declare function createRequestClient(options: RequestClientOptions): Readonly<RequestClient>;

package/dist/api/request-client.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import{isNullish as e,showWarningMessage as t,VefError as a,isString as s,showErrorMessage as r,isFunction as o}from"@vef-framework/shared";import n,{CanceledError as i}from"axios";import l from"qs";var c,p=e=>{throw TypeError(e)},d=(e,t,a)=>t.has(e)||p("Cannot "+a),m=(e,t,a)=>(d(e,t,"read from private field"),a?a.call(e):t.get(e));const u=/\{(\w+)\}/;class h{constructor(o){var h,f,g;this.options=o,h=this,(f=c).has(h)?p("Cannot add the same private member more than once"):f instanceof WeakSet?f.add(h):f.set(h,g),((e,t,a,s)=>{d(e,t,"write to private field"),s?s.call(e,a):t.set(e,a)})(this,c,n.create({baseURL:o.baseUrl,timeout:o.timeout??3e4,headers:{"Content-Type":"application/json"},paramsSerializer:e=>l.stringify(e,{arrayFormat:"repeat",skipNulls:!0,charset:"utf-8"}),responseType:"json",validateStatus:()=>!0})),m(this,c).interceptors.request.use((t=>{const a=this.options.getAccessToken();a&&(t.headers.Authorization=`Bearer ${a}`);const s=t.url;return s&&u.test(s)&&(t.url=s.replace(u,((a,s)=>{const r=t.params?.[s];if(e(r))throw new Error(`Path parameter ${s} is nil`);return r}))),t})),m(this,c).interceptors.response.use((e=>{const{code:s,message:r}=e.data;return 0===s?e:(t(r),Promise.reject(new a(s,r)))}),(e=>{if(e instanceof i)return Promise.reject(e);const{response:t,message:o}=e;if(t?.data){const e=`处理请求响应信息异常：${o??"无"}`;return Promise.reject(new a(t.status,e))}{let t=o??(s(e)?e:"");if("Network Error"===t)t="接口连接异常可能原因：网络不通或存在跨域问题。";else if(t.includes("timeout"))t="接口请求超时";else if(t.includes("Request failed with status code")){t=`接口状态码异常：${o.substring(o.length-3)}`}else t="接口未知异常";return r(t),Promise.reject(new a(-1,t))}}))}async get(e,t){return(await m(this,c).get(e,{params:t?.params,signal:t?.signal})).data}async post(e,t,a){return(await m(this,c).post(e,t,{params:a?.params,signal:a?.signal})).data}async put(e,t,a){return(await m(this,c).put(e,t,{params:a?.params,signal:a?.signal})).data}async delete(e,t){return(await m(this,c).delete(e,{params:t?.params,signal:t?.signal})).data}async upload(e,t,a){return(await m(this,c).postForm(e,t,{params:a?.params,signal:a?.signal,onUploadProgress:o(a?.onProgress)?e=>{const t=e.lengthComputable?e.total??0:0,s=e.loaded,r=Math.round(s/t*100);a.onProgress?.(r)}:void 0})).data}async download(e,t){const{data:r,headers:n}=await m(this,c).get(e,{params:t?.params,responseType:"blob",onDownloadProgress:o(t?.onProgress)?e=>{const a=e.lengthComputable?e.total??0:0,s=e.loaded,r=Math.round(s/a*100);t.onProgress?.(r)}:void 0});let i=null;try{i=JSON.parse(await r.text())}catch{}if(i&&0!==i.code)throw new a(i.code,i.message);const l=n.get("content-disposition");if(s(l)){const e=/filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/.exec(l);if(e){const a=decodeURIComponent(e[1]),s=document.createElement("a");s.href=URL.createObjectURL(r),s.download=o(t?.fileName)?t.fileName(a):t?.fileName??a,s.click(),URL.revokeObjectURL(s.href)}}}}function f(e){return Object.freeze(new h(e))}c=new WeakMap;export{h as RequestClient,f as createRequestClient};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/auth/auth-context.d.ts

@@ -0,0 +1,29 @@
+import { type Api, type ChildrenProps, type Mapper, type PermissionChecker } from "@vef-framework/shared";
+import { type FC } from "react";
+/**
+ * The props of the AuthContextProvider component.
+ */
+export interface AuthContextProviderProps extends ChildrenProps {
+    /**
+     * The permission checker.
+     */
+    permissionChecker?: PermissionChecker;
+}
+/**
+ * The auth context.
+ */
+export interface AuthContext {
+    /**
+     * The function to check the permission.
+     */
+    checkPermission: Mapper<string | Api<any, any>, boolean>;
+}
+/**
+ * The auth context provider.
+ */
+declare const AuthContextProvider: FC<AuthContextProviderProps>;
+/**
+ * The use auth context hook.
+ */
+declare function useAuthContext(): AuthContext;
+export { AuthContextProvider, useAuthContext, };

package/dist/auth/auth-context.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import{isString as e,VefError as r}from"@vef-framework/shared";import{createContext as t,useMemo as o,createElement as n,useContext as i}from"react";const s=t(null),u=({permissionChecker:r,children:t})=>{const i=o((()=>({checkPermission:t=>!r||(e(t)?r(t):r(t.key))})),[r]);return n(s.Provider,{value:i},t)};function c(){const e=i(s);if(null===e)throw new r(-1,"useAuthContext must be used within a AuthContextProvider");return e}export{u as AuthContextProvider,c as useAuthContext};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/auth/index.d.ts

@@ -0,0 +1 @@
+export * from "./auth-context";

package/dist/auth/index.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+export{AuthContextProvider,useAuthContext}from"./auth-context.js";
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/expr/compiler.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Tokens are strings that map to functions.
+ */
+interface Tokens {
+    [index: string]: (...args: any[]) => any;
+}
+/**
+ * The compiler output, a function that adds the required tokens.
+ */
+export interface ExpressionEvaluator {
+    (tokens?: Tokens): any;
+    provide: (bind: (names: string[]) => Tokens) => ExpressionEvaluator;
+}
+/**
+ * Compiles a logical string like `"a != z || b == c"` into a single function.
+ * The return value is an object with a "provide" method that iterates over all
+ * requirement tokens to use as replacements.
+ *
+ * @example
+ *
+ * ```typescript
+ * let name = {
+ *   value: 'jon'
+ * }
+ * const condition = compile("$name == 'bob'").provide((token) => {
+ *  return () => name.value // must return a function!
+ * })
+ *
+ * condition() // false
+ * ```
+ *
+ * @param expr - An expression string to compile.
+ */
+export declare function compile(expr: string): ExpressionEvaluator;
+export {};

package/dist/expr/compiler.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import{parseArgs as n,getAt as t,isQuotedString as e,rmEscapes as r}from"./helpers.js";function i(s){let l;const o=new Set,u=function(n,t){return"function"==typeof n?n(t):n},f=[{"&&":(n,t,e)=>u(n,e)&&u(t,e),"||":(n,t,e)=>u(n,e)||u(t,e)},{"===":(n,t,e)=>!(u(n,e)!==u(t,e)),"!==":(n,t,e)=>!(u(n,e)===u(t,e)),"==":(n,t,e)=>!(u(n,e)!=u(t,e)),"!=":(n,t,e)=>!(u(n,e)==u(t,e)),">=":(n,t,e)=>!!(u(n,e)>=u(t,e)),"<=":(n,t,e)=>!!(u(n,e)<=u(t,e)),">":(n,t,e)=>!!(u(n,e)>u(t,e)),"<":(n,t,e)=>!!(u(n,e)<u(t,e))},{"+":(n,t,e)=>u(n,e)+u(t,e),"-":(n,t,e)=>u(n,e)-u(t,e)},{"*":(n,t,e)=>u(n,e)*u(t,e),"/":(n,t,e)=>u(n,e)/u(t,e),"%":(n,t,e)=>u(n,e)%u(t,e)}],c=f.reduce(((n,t)=>n.concat(Object.keys(t))),[]),d=new Set(c.map((n=>n.charAt(0))));function g(n,t,e,r){const i=n.filter((n=>n.startsWith(t)));return!!i.length&&i.find((n=>{if(r.length>=e+n.length){if(r.substring(e,e+n.length)===n)return n}return!1}))}function h(n,t,e=1){let r=e?t.substring(n+1).trim():t.substring(0,n).trim();if(!r.length)return-1;if(!e){const n=r.split("").reverse(),t=n.findIndex((n=>d.has(n)));r=n.slice(t).join("")}const i=r[0];return f.findIndex((n=>!!g(Object.keys(n),i,0,r)))}function a(n,t){let e="";const r=t.length;let i=0;for(let s=n;s<r;s++){const n=t.charAt(s);if("("===n)i++;else if(")"===n)i--;else if(0===i&&" "===n)continue;if(0===i&&g(c,n,s,t))return[e,s-1];e+=n}return[e,t.length-1]}function b(n,t=0){const e=f[t],r=n.length,i=Object.keys(e);let s,l=0,o=!1,u=null,c="",d=null,b="",y="",m="",$="",j=0;const v=(n,t)=>{n?m+=t:c+=t};for(let f=0;f<r;f++)if(b=y,y=n.charAt(f),"'"!==y&&'"'!==y||"\\"===b||!(0===l&&!o||l&&!$))if(o&&(y!==o||"\\"===b)||$&&(y!==$||"\\"===b))v(l,y);else if(o!==y)if($!==y){if(" "!==y)if("("===y)0===l?j=f:m+=y,l++;else if(")"===y)if(l--,0===l){const e="string"==typeof c&&c.startsWith("$")?c:void 0,r=e&&"."===n.charAt(f+1);let i="";r&&([i,f]=a(f+2,n));const s=u?t:h(j,n,0),l=h(f,n);-1===s&&-1===l?(c=p(m,-1,e,i),"string"==typeof c&&(c=m)):u&&(s>=l||-1===l)&&t===s?(d=u.bind(null,p(m,-1,e,i)),u=null,c=""):l>s&&t===l?c=p(m,-1,e,i):c+=`(${m})${r?`.${i}`:""}`,m=""}else m+=y;else{if(0===l&&(s=g(i,y,f,n))){0===f&&console.error(103,[s,n]),f+=s.length-1,f===n.length-1&&console.error(104,[s,n]),u?c&&(d=u.bind(null,p(c,t)),u=e[s].bind(null,d),c=""):d?(u=e[s].bind(null,p(d,t)),d=null):(u=e[s].bind(null,p(c,t)),c="");continue}v(l,y)}}else $=!1,v(l,y);else o=!1,v(l,y);else l?$=y:o=y,v(l,y);return c&&u&&(u=u.bind(null,p(c,t))),u=!u&&d?d:u,!u&&c&&(u=(n,t)=>"function"==typeof n?n(t):n,u=u.bind(null,p(c,t))),u||c||console.error(105,n),u}function p(s,u,c,d){if(c){const e=p(c,f.length);let r,o=!!d&&i(`$${d}`);if("function"==typeof e){const i=n(String(s)).map((n=>p(n,-1)));return n=>{const s=e(n);return"function"!=typeof s?(console.warn(150,c),s):(r=s(...i.map((t=>"function"==typeof t?t(n):t))),o&&(o=o.provide((n=>{const e=l(n);return n.reduce(((n,i)=>{if(i===d||d?.startsWith(`${i}(`)){const e=t(r,i);n[i]=()=>e}else n[i]=e[i];return n}),{})}))),o?o():r)}}}else if("string"==typeof s){if("true"===s)return!0;if("false"===s)return!1;if("undefined"===s)return;if(e(s))return r(s.substring(1,s.length-1));if(!Number.isNaN(+s))return Number(s);if(u<f.length-1)return b(s,u+1);if(s.startsWith("$")){const n=s.substring(1);return o.add(n),function(t){return n in t?t[n]():void 0}}return s}return s}const y=b(s),m=Array.from(o);return Object.assign(y,{provide:function n(t){return l=t,Object.assign(y.bind(null,t(m)),{provide:n})}})}export{i as compile};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/expr/helpers.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Checks if the given property exists on the given object.
+ *
+ * @param obj - An object to check.
+ * @param property - The property to check.
+ *
+ * @returns `boolean`
+ */
+export declare function has(obj: {
+    [index: string]: any;
+    [index: number]: any;
+}, property: string | symbol | number): boolean;
+/**
+ * Get a specific value via dot notation.
+ *
+ * @param obj - An object to fetch data from.
+ * @param addr - An "address" in dot notation.
+ *
+ * @returns `unknown`
+ */
+export declare function getAt(obj: any, addr: string): unknown;
+/**
+ * Determine if the given string is fully quoted.
+ *
+ * @example
+ *
+ * ```javascript
+ * hello - false
+ * "hello" - true
+ * 'world' - true
+ * "hello"=="world" - false
+ * "hello'this'" - false
+ * "hello"'there' - false
+ * "hello""there" - false
+ * 'hello === world' - true
+ * ```
+ *
+ * @param str - The string to check.
+ *
+ * @returns `boolean`
+ */
+export declare function isQuotedString(str: string): boolean;
+/**
+ * Parse a string for comma-separated arguments.
+ *
+ * @param str - String to parse arguments from.
+ *
+ * @returns `string[]`
+ */
+export declare function parseArgs(str: string): string[];
+/**
+ * Remove extra escape characters.
+ *
+ * @param str - String to remove extra escape characters from.
+ *
+ * @returns `string`
+ */
+export declare function rmEscapes(str: string): string;

package/dist/expr/helpers.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+function t(t,n){return Object.prototype.hasOwnProperty.call(t,n)}function n(n,r){if(!n||"object"!=typeof n)return null;const e=r.split(".");let o=n;for(const n in e){const r=e[n];if(t(o,r)&&(o=o[r]),+n==e.length-1)return o;if(!o||"object"!=typeof o)return null}return null}function r(t){if('"'!==t[0]&&"'"!==t[0])return!1;if(t[0]!==t[t.length-1])return!1;const n=t[0];for(let r=1;r<t.length;r++)if(t[r]===n&&(1===r||"\\"!==t[r-1])&&r!==t.length-1)return!1;return!0}function e(t){const n=[];let r="",e=0,o="",l="";for(let u=0;u<t.length;u++){const c=t.charAt(u);c===o&&"\\"!==l?o="":"'"!==c&&'"'!==c||o||"\\"===l?"("!==c||o?")"!==c||o||e--:e++:o=c,","!==c||o||0!==e?(" "!==c||o)&&(r+=c):(n.push(r),r=""),l=c}return r&&n.push(r),n}function o(t){if(!t.length)return"";let n="",r="";for(let e=0;e<t.length;e++){const o=t.charAt(e);"\\"===o&&"\\"!==r||(n+=o),r=o}return n}export{n as getAt,t as has,r as isQuotedString,e as parseArgs,o as rmEscapes};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./api";
+export * from "./auth";
+export { compile } from "./expr/compiler";

package/dist/index.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+import"./api/index.js";import"./auth/index.js";export{compile}from"./expr/compiler.js";export{ApiClient,createApiClient}from"./api/api-client.js";export{useMutation}from"@tanstack/react-query";export{ApiContextProvider,ApiQueryDevtools,useApiContext}from"./api/api-context.js";export{AuthContextProvider,useAuthContext}from"./auth/auth-context.js";
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/dist/middleware/dispatcher.d.ts

@@ -0,0 +1,22 @@
+/**
+ * All Middleware conform to the pattern of accepting a payload and a
+ * `next()` function. They can either pass the payload to the next middleware
+ * explicitly (as an argument of next), or implicitly (no argument for next).
+ */
+export type Middleware<T = unknown> = (payload: T, next: (payload: T) => T) => T;
+/**
+ * The Dispatcher interface is responsible creating/running "hooks".
+ */
+export interface Dispatcher<T> {
+    (middleware: Middleware<T>): number;
+    unshift: (middleware: Middleware<T>) => number;
+    remove: (middleware: Middleware<T>) => void;
+    dispatch: (payload: T) => T;
+}
+/**
+ * Creates a new dispatcher that allows the addition/removal of middleware
+ * functions, and the ability to dispatch a payload to all middleware.
+ *
+ * @returns Dispatcher
+ */
+export default function createDispatcher<T>(): Dispatcher<T>;

package/dist/middleware/dispatcher.js

@@ -0,0 +1,3 @@
+/*! VefFramework version: 1.0.5, build time: 2024-12-10T10:24:47.065Z, made by Venus. */
+function t(){const t=[];let n=0;const e=n=>t.push(n),s=e=>{const o=t[n];return"function"==typeof o?o(e,(t=>(n++,s(t)))):(n=0,e)};return e.dispatch=s,e.unshift=n=>t.unshift(n),e.remove=n=>{const e=t.indexOf(n);e>-1&&t.splice(e,1)},e}export{t as default};
+/*! VefFramework is a blazingly high-level, modern, flexible, easy-to-use UI framework made by Venus. Follow me on Github: https://github.com/ilxqx! @ilxqx */

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@vef-framework/core",
+  "type": "module",
+  "version": "1.0.5",
+  "private": false,
+  "description": "The core of the VEF framework",
+  "author": "Venus",
+  "keywords": [
+    "vef",
+    "vef-framework",
+    "vef-core"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "*"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "pnpm clean && tsx build.ts",
+    "clean": "rimraf dist"
+  },
+  "peerDependencies": {
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "zustand": "5.0.1"
+  },
+  "dependencies": {
+    "@emotion/cache": "11.13.5",
+    "@emotion/react": "11.13.5",
+    "@emotion/styled": "11.13.5",
+    "antd": "5.22.3",
+    "tslib": "2.8.1",
+    "@tanstack/react-query": "5.62.0",
+    "@tanstack/react-query-devtools": "5.62.0",
+    "@vef-framework/shared": "1.0.5",
+    "axios": "1.7.8",
+    "qs": "6.13.1"
+  },
+  "devDependencies": {
+    "@types/qs": "6.9.17"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}