@vef-framework/starter 1.0.134 → 2.0.1

package/types/components/index.d.ts

@@ -1,7 +0,0 @@
-export { default as VefAccessDeniedPage, type VefAccessDeniedPageProps } from "./vef-access-denied-page";
-export { default as VefApp, type VefAppProps } from "./vef-app";
-export { default as VefDevAssistant, type VefDevAssistantProps } from "./vef-dev-assistant";
-export { default as VefErrorPage, type VefErrorPageProps } from "./vef-error-page";
-export { default as VefLoginPage, type VefLoginPageProps } from "./vef-login-page";
-export { default as VefNotFoundPage, type VefNotFoundPageProps } from "./vef-not-found-page";
-export { default as VefRouterProvider, type RouterContext, type VefRouterProviderProps } from "./vef-router-provider";

package/types/components/vef-access-denied-page/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefAccessDeniedPageProps } from "./props";
-declare function VefAccessDeniedPage(props: VefAccessDeniedPageProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefAccessDeniedPageProps };
-export default VefAccessDeniedPage;

package/types/components/vef-access-denied-page/props.d.ts

@@ -1,5 +0,0 @@
-/**
- * The props of the VefAccessDeniedPage component.
- */
-export interface VefAccessDeniedPageProps {
-}

package/types/components/vef-app/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefAppProps } from "./props";
-declare function VefApp({ router, ...configProviderProps }: VefAppProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefAppProps };
-export default VefApp;

package/types/components/vef-app/props.d.ts

@@ -1,7 +0,0 @@
-import type { VefConfigProviderProps } from "@vef-framework/components";
-import type { VefRouterProviderProps } from "../vef-router-provider";
-/**
- * The props of the VefApp component.
- */
-export interface VefAppProps extends VefConfigProviderProps, VefRouterProviderProps {
-}

package/types/components/vef-dev-assistant/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefDevAssistantProps } from "./props";
-declare function VefDevAssistant(): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefDevAssistantProps };
-export default VefDevAssistant;

package/types/components/vef-dev-assistant/props.d.ts

@@ -1,5 +0,0 @@
-/**
- * The props of the VefDevAssistant component.
- */
-export interface VefDevAssistantProps {
-}

package/types/components/vef-error-page/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefErrorPageProps } from "./props";
-declare function VefErrorPage({ error, info, reset, }: VefErrorPageProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefErrorPageProps };
-export default VefErrorPage;

package/types/components/vef-error-page/props.d.ts

@@ -1,6 +0,0 @@
-import type { ErrorComponentProps } from "@tanstack/react-router";
-/**
- * The props for the VefErrorPage component.
- */
-export interface VefErrorPageProps extends ErrorComponentProps {
-}

package/types/components/vef-login-page/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefLoginPageProps } from "./props";
-declare function VefLoginPage(props: VefLoginPageProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefLoginPageProps };
-export default VefLoginPage;

package/types/components/vef-login-page/props.d.ts

@@ -1,7 +0,0 @@
-import type { VefLoginProps } from "@vef-framework/components";
-import type { Except } from "@vef-framework/shared";
-/**
- * The props of the VefLoginPage component.
- */
-export interface VefLoginPageProps extends Except<VefLoginProps, "onLoginSuccess"> {
-}

package/types/components/vef-not-found-page/index.d.ts

@@ -1,4 +0,0 @@
-import type { VefNotFoundPageProps } from "./props";
-declare function VefNotFoundPage(): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { VefNotFoundPageProps };
-export default VefNotFoundPage;

package/types/components/vef-not-found-page/props.d.ts

@@ -1,6 +0,0 @@
-import type { NotFoundRouteProps } from "@tanstack/react-router";
-/**
- * The props for the VefNotFoundPage component.
- */
-export interface VefNotFoundPageProps extends NotFoundRouteProps {
-}

package/types/components/vef-router-provider/index.d.ts

@@ -1,4 +0,0 @@
-import type { RouterContext, VefRouterProviderProps } from "./props";
-declare function VefRouterProvider({ router, }: VefRouterProviderProps): import("@emotion/react/jsx-runtime").JSX.Element;
-export type { RouterContext, VefRouterProviderProps };
-export default VefRouterProvider;

package/types/components/vef-router-provider/props.d.ts

@@ -1,16 +0,0 @@
-import type { RouterProps } from "@tanstack/react-router";
-import type { FetchAuthenticatedUserApi } from "@vef-framework/shared";
-/**
- * The context of the router.
- */
-export interface RouterContext {
-    /**
-     * The fetch authenticated user API.
-     */
-    fetchAuthenticatedUserApi: FetchAuthenticatedUserApi;
-}
-/**
- * The props of the VefRouterProvider component.
- */
-export interface VefRouterProviderProps extends Pick<RouterProps, "router"> {
-}

package/types/constants.d.ts

@@ -1,24 +0,0 @@
-/**
- * The path of the login page.
- */
-export declare const LOGIN_PAGE_PATH = "/login";
-/**
- * The route id of the login page.
- */
-export declare const LOGIN_PAGE_ROUTE = "/_common/login";
-/**
- * The path of the index page.
- */
-export declare const INDEX_PAGE_PATH = "/";
-/**
- * The route id of the index page.
- */
-export declare const INDEX_PAGE_ROUTE = "/_layout";
-/**
- * The path of the access denied page.
- */
-export declare const ACCESS_DENIED_PAGE_PATH = "/access-denied";
-/**
- * The route id of the access denied page.
- */
-export declare const ACCESS_DENIED_PAGE_ROUTE = "/_common/access-denied";

package/types/helper.d.ts

@@ -1,9 +0,0 @@
-import type { FetchAuthenticatedUserApi } from "@vef-framework/shared";
-import type { VefRouterProviderProps } from "./components";
-/**
- * The utility function to handle logout.
- *
- * @param router The router instance.
- * @param fetchAuthenticatedUserApi The fetch authenticated user api instance.
- */
-export declare function handleClientLogout(router: VefRouterProviderProps["router"], fetchAuthenticatedUserApi: FetchAuthenticatedUserApi): Promise<void>;

package/types/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./api";
-export * from "./app";
-export * from "./components";
-export * from "./constants";
-export * from "./helper";
-export * from "./router";
-export * from "./routes";
-export * from "./store";

package/types/router.d.ts

@@ -1,23 +0,0 @@
-import type { AnyRoute } from "@tanstack/react-router";
-/**
- * The options for creating a router.
- */
-export interface RouterOptions {
-    /**
-     * The route tree to create the router from.
-     */
-    routeTree: AnyRoute;
-    /**
-     * The history mode to use.
-     */
-    history: "hash" | "browser";
-}
-/**
- * Creates a router.
- *
- * @param options The options for creating the router.
- * @param options.routeTree The route tree to create the router from.
- * @param options.history The history mode to use.
- * @returns The created router.
- */
-export declare function createRouter({ routeTree, history, }: RouterOptions): import("@tanstack/router-core").RouterCore<AnyRoute, "never", true, import("@tanstack/history").RouterHistory, Record<string, any>>;

package/types/routes/access-denied.d.ts

@@ -1,9 +0,0 @@
-import { VefAccessDeniedPage } from "../components";
-/**
- * The options of the access denied route.
- *
- * @returns The options of the access denied route.
- */
-export declare function createAccessDeniedRouteOptions(): {
-    readonly component: typeof VefAccessDeniedPage;
-};

package/types/routes/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./access-denied";
-export * from "./layout";
-export * from "./login";
-export * from "./root";

package/types/routes/layout.d.ts

@@ -1,33 +0,0 @@
-import type { ParsedLocation } from "@tanstack/react-router";
-import type { VefLayoutProps } from "@vef-framework/components";
-import type { Mapper } from "@vef-framework/shared";
-import type { RouterContext } from "../components";
-import type { AppState } from "../store";
-/**
- * The options for the layout route.
- */
-export interface LayoutOptions extends Pick<VefLayoutProps, "title" | "logo"> {
-    /**
-     * The user description mapper.
-     */
-    getUserDescription?: Mapper<NonNullable<AppState["user"]>, string>;
-}
-/**
- * Creates the options for the layout route.
- *
- * @returns The options for the layout route.
- */
-export declare function createLayoutRouteOptions({ title, logo, getUserDescription, }: LayoutOptions): {
-    readonly beforeLoad: ({ location }: {
-        location: ParsedLocation;
-    }) => void;
-    readonly loader: ({ context, location }: {
-        context: RouterContext;
-        location: ParsedLocation;
-    }) => Promise<void>;
-    readonly pendingComponent: () => import("@emotion/react/jsx-runtime").JSX.Element;
-    readonly component: () => import("@emotion/react/jsx-runtime").JSX.Element;
-    readonly staleTime: number;
-    readonly gcTime: 0;
-    readonly shouldReload: false;
-};

package/types/routes/login.d.ts

@@ -1,27 +0,0 @@
-import { z } from "@vef-framework/shared";
-import type { VefLoginPageProps } from "../components";
-/**
- * The options for the login route.
- */
-export interface LoginOptions extends VefLoginPageProps {
-}
-/**
- * Creates the options for the login route.
- *
- * @returns The options for the login route.
- */
-export declare function createLoginRouteOptions(props: LoginOptions): {
-    readonly validateSearch: z.ZodObject<{
-        redirect: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
-    }, "strip", z.ZodTypeAny, {
-        redirect: string;
-    }, {
-        redirect?: unknown;
-    }>;
-    readonly beforeLoad: ({ search }: {
-        search: {
-            redirect: string;
-        };
-    }) => void;
-    readonly component: () => import("@emotion/react/jsx-runtime").JSX.Element;
-};

package/types/routes/root.d.ts

@@ -1,7 +0,0 @@
-import type { RouterContext } from "../components";
-/**
- * Create the root route.
- *
- * @returns The root route.
- */
-export declare function createRootRoute(): import("@tanstack/react-router").RootRoute<undefined, RouterContext, import("@tanstack/router-core").AnyContext, import("@tanstack/router-core").AnyContext, {}, undefined, unknown, unknown>;

package/types/store.d.ts

@@ -1,34 +0,0 @@
-import type { AuthenticatedToken, AuthenticatedUser, BasicMenuItem, Except, GroupMenuItem, IdValue, MenuItem, SubmenuItem } from "@vef-framework/shared";
-/**
- * The state of the app.
- */
-export interface AppState {
-    /**
-     * Whether the user is authenticated.
-     */
-    isAuthenticated: boolean;
-    /**
-     * The authenticated user.
-     */
-    user?: Readonly<Except<AuthenticatedUser, "menus" | "permissions">>;
-    /**
-     * The authenticated token info.
-     */
-    token?: Readonly<AuthenticatedToken>;
-    /**
-     * The menus of the user.
-     */
-    menus?: readonly MenuItem[];
-    /**
-     * The route parent menus mappings.
-     */
-    routeParentMenusMappings?: Readonly<Map<IdValue, [BasicMenuItem | SubmenuItem | GroupMenuItem, Array<SubmenuItem | GroupMenuItem>]>>;
-    /**
-     * The authorized permissions of the user.
-     */
-    permissions?: Readonly<Set<string>>;
-}
-/**
- * Create the app store.
- */
-export declare const useAppStore: import("@vef-framework/shared").BoundStoreApi<AppState>;