@baseplate-dev/react-generators/dist/generators/core/react-router/react-router.generator.d.ts

React Generators for Baseplate

import type { TsCodeFragment } from '@baseplate-dev/core-generators';
/**
 * A field in the root route context.
 */
export interface RootRouteContextField {
    /** The name of the field */
    name: string;
    /** The type of the field */
    type: TsCodeFragment;
    /** Whether the field is optional */
    optional: boolean;
    /** The code to initialize the field in the createRouter function */
    createRouteInitializer?: TsCodeFragment;
    /** The code to initialize the field in the RouterProvider context */
    routerProviderInitializer?: {
        /** The code to initialize the field */
        code: TsCodeFragment;
        /** Any dependencies that should be included in the useMemo dependency array */
        dependencies: string[];
    };
}
declare const reactRouterConfigProvider: import("@baseplate-dev/sync").ProviderType<Omit<import("@baseplate-dev/utils").FieldMap<{
    routerSetupFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
    routerBodyFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
    rootLayoutComponent: import("@baseplate-dev/utils").ScalarContainer<TsCodeFragment | undefined>;
    rootContextFields: import("@baseplate-dev/utils").NamedArrayFieldContainer<RootRouteContextField>;
    errorComponentHeaderFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
    errorComponentBodyFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
}>, "getValues">>;
export { reactRouterConfigProvider };
export interface ReactRouterProvider {
    getRootRouteDirectory(): string;
}
export declare const reactRouterProvider: import("@baseplate-dev/sync").ProviderType<ReactRouterProvider>;
export declare const reactRouterGenerator: import("@baseplate-dev/sync").GeneratorBundleCreator<{
    renderPlaceholderIndex?: boolean | undefined;
}, {
    setup: import("@baseplate-dev/sync").GeneratorTask<import("@baseplate-dev/sync").ProviderExportMap<Record<string, import("@baseplate-dev/sync").Provider>> | undefined, import("@baseplate-dev/sync").ProviderDependencyMap<Record<string, import("@baseplate-dev/sync").Provider>>, import("@baseplate-dev/sync").ProviderExportMap<Record<string, import("@baseplate-dev/sync").Provider>> | undefined>;
    nodePackages: import("@baseplate-dev/sync").AnyGeneratorTask;
    paths: import("@baseplate-dev/sync").GeneratorTask<{
        coreReactRouterPaths: import("@baseplate-dev/sync").ProviderExport<import("./generated/template-paths.js").CoreReactRouterPaths>;
    }, {
        packageInfo: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/core-generators").PackageInfoProvider>;
        reactRoutes: import("@baseplate-dev/sync").ProviderType<import("#src/providers/routes.js").ReactRoutesProvider>;
    }, undefined>;
    imports: import("@baseplate-dev/sync").GeneratorTask<{
        reactRouterImports: import("@baseplate-dev/sync").ProviderExport<import("@baseplate-dev/core-generators").InferTsImportMapFromSchema<{
            AppRoutes: {};
            router: {};
        }>>;
    }, {
        paths: import("@baseplate-dev/sync").ProviderType<import("./generated/template-paths.js").CoreReactRouterPaths>;
    }, undefined>;
    renderers: import("@baseplate-dev/sync").GeneratorTask<{
        coreReactRouterRenderers: import("@baseplate-dev/sync").ProviderExport<import("./generated/template-renderers.js").CoreReactRouterRenderers>;
    }, {
        paths: import("@baseplate-dev/sync").ProviderType<import("./generated/template-paths.js").CoreReactRouterPaths>;
        reactComponentsImports: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/core-generators").InferTsImportMapFromSchema<{
            AddOptionRequiredFields: {
                isTypeOnly: true;
            };
            Alert: {};
            AlertDescription: {};
            AlertTitle: {};
            Badge: {};
            badgeVariants: {};
            BadgeWithIcon: {};
            BadgeWithIconProps: {
                isTypeOnly: true;
            };
            Breadcrumb: {};
            BreadcrumbEllipsis: {};
            BreadcrumbItem: {};
            BreadcrumbLink: {};
            BreadcrumbList: {};
            BreadcrumbPage: {};
            BreadcrumbSeparator: {};
            Button: {};
            buttonVariants: {};
            Calendar: {};
            Card: {};
            CardContent: {};
            CardDescription: {};
            CardFooter: {};
            CardHeader: {};
            CardTitle: {};
            Checkbox: {};
            CheckboxField: {};
            CheckboxFieldController: {};
            CheckedInput: {};
            CircularProgress: {};
            cn: {};
            Combobox: {};
            ComboboxField: {};
            ComboboxFieldController: {};
            Command: {};
            CommandDialog: {};
            CommandEmpty: {};
            CommandGroup: {};
            CommandInput: {};
            CommandItem: {};
            CommandList: {};
            CommandSeparator: {};
            CommandShortcut: {};
            ConfirmDialog: {};
            DatePickerField: {};
            DatePickerFieldController: {};
            DateTimePickerField: {};
            DateTimePickerFieldController: {};
            Dialog: {};
            DialogClose: {};
            DialogContent: {};
            DialogDescription: {};
            DialogFooter: {};
            DialogHeader: {};
            DialogOverlay: {};
            DialogPortal: {};
            DialogTitle: {};
            DialogTrigger: {};
            DialogWidth: {
                isTypeOnly: true;
            };
            DropdownMenu: {};
            DropdownMenuCheckboxItem: {};
            DropdownMenuContent: {};
            DropdownMenuGroup: {};
            DropdownMenuItem: {};
            DropdownMenuLabel: {};
            DropdownMenuPortal: {};
            DropdownMenuRadioGroup: {};
            DropdownMenuRadioItem: {};
            DropdownMenuSeparator: {};
            DropdownMenuShortcut: {};
            DropdownMenuSub: {};
            DropdownMenuSubContent: {};
            DropdownMenuSubTrigger: {};
            DropdownMenuTrigger: {};
            EmptyDisplay: {};
            ErrorableLoader: {};
            ErrorDisplay: {};
            FormControl: {};
            FormDescription: {};
            FormFieldProps: {
                isTypeOnly: true;
            };
            FormItem: {};
            FormLabel: {};
            FormMessage: {};
            IconElement: {
                isTypeOnly: true;
            };
            Input: {};
            InputField: {};
            InputFieldController: {};
            inputVariants: {};
            Label: {};
            LinkButton: {};
            Loader: {};
            mergeRefs: {};
            Modal: {};
            MultiCombobox: {};
            MultiComboboxContent: {};
            MultiComboboxEmpty: {};
            MultiComboboxField: {};
            MultiComboboxFieldController: {};
            MultiComboboxFieldProps: {
                isTypeOnly: true;
            };
            MultiComboboxGroup: {};
            MultiComboboxInput: {};
            MultiComboboxItem: {};
            MultiSelectOptionProps: {
                isTypeOnly: true;
            };
            NavigationMenu: {};
            NavigationMenuContent: {};
            NavigationMenuIndicator: {};
            NavigationMenuItem: {};
            NavigationMenuItemWithLink: {};
            NavigationMenuLink: {};
            NavigationMenuList: {};
            NavigationMenuTrigger: {};
            navigationMenuTriggerStyle: {};
            NavigationMenuViewport: {};
            NotFoundCard: {};
            Popover: {};
            PopoverAnchor: {};
            PopoverContent: {};
            PopoverTrigger: {};
            ReactDatePickerInput: {};
            ReactSelectInput: {};
            ScrollArea: {};
            Select: {};
            selectCheckVariants: {};
            selectContentVariants: {};
            SelectField: {};
            SelectFieldController: {};
            SelectInput: {};
            selectItemVariants: {};
            SelectOptionProps: {
                isTypeOnly: true;
            };
            selectTriggerVariants: {};
            Separator: {};
            Sheet: {};
            SheetClose: {};
            SheetContent: {};
            SheetDescription: {};
            SheetFooter: {};
            SheetHeader: {};
            SheetTitle: {};
            SheetTrigger: {};
            Sidebar: {};
            SidebarContent: {};
            SidebarFooter: {};
            SidebarGroup: {};
            SidebarGroupAction: {};
            SidebarGroupContent: {};
            SidebarGroupLabel: {};
            SidebarHeader: {};
            SidebarInput: {};
            SidebarInset: {};
            SidebarMenu: {};
            SidebarMenuAction: {};
            SidebarMenuBadge: {};
            SidebarMenuButton: {};
            SidebarMenuItem: {};
            SidebarMenuSkeleton: {};
            SidebarMenuSub: {};
            SidebarMenuSubButton: {};
            SidebarMenuSubItem: {};
            SidebarProvider: {};
            SidebarRail: {};
            SidebarSeparator: {};
            SidebarTrigger: {};
            Skeleton: {};
            Switch: {};
            SwitchField: {};
            SwitchFieldController: {};
            Table: {};
            TableBody: {};
            TableCaption: {};
            TableCell: {};
            TableFooter: {};
            TableHead: {};
            TableHeader: {};
            TableRow: {};
            Textarea: {};
            TextareaField: {};
            TextareaFieldController: {};
            TextAreaInput: {};
            TextInput: {};
            Toaster: {};
            Tooltip: {};
            TooltipContent: {};
            TooltipProvider: {};
            TooltipTrigger: {};
            useConfirmDialog: {};
            UseConfirmDialogRequestOptions: {
                isTypeOnly: true;
            };
            useConfirmDialogState: {};
            useControlledState: {};
            useControllerMerged: {};
            useIsMobile: {};
            useMultiComboboxContext: {};
            useSidebar: {};
        }>>;
        typescriptFile: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/core-generators").TypescriptFileProvider>;
    }, undefined>;
    vite: import("@baseplate-dev/sync").GeneratorTask<undefined, {
        provider: import("@baseplate-dev/sync").ProviderType<Omit<import("@baseplate-dev/utils").FieldMap<{
            appFragment: import("@baseplate-dev/utils").ScalarContainer<TsCodeFragment | undefined>;
            headerFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
            vitePlugins: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
            viteServerOptions: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
        }>, "getValues">>;
    }, undefined>;
    reactAppConfig: import("@baseplate-dev/sync").GeneratorTask<any, {
        reactAppConfig: import("@baseplate-dev/sync").ProviderType<Omit<import("@baseplate-dev/utils").FieldMap<{
            errorBoundary: import("@baseplate-dev/utils").ScalarContainer<((contents: TsCodeFragment) => TsCodeFragment) | undefined>;
            renderWrappers: import("@baseplate-dev/utils").MapContainer<string, import("../react-app/react-app.generator.js").RenderWrapper>;
            renderSiblings: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
            renderRoot: import("@baseplate-dev/utils").ScalarContainer<TsCodeFragment | undefined>;
        }>, "getValues">>;
        paths: import("@baseplate-dev/sync").ProviderType<import("./generated/template-paths.js").CoreReactRouterPaths>;
    }, any>;
    prettier: import("@baseplate-dev/sync").GeneratorTask<undefined, {
        provider: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/core-generators").PrettierProvider>;
    }, undefined>;
    eslint: import("@baseplate-dev/sync").GeneratorTask<undefined, {
        provider: import("@baseplate-dev/sync").ProviderType<Omit<import("@baseplate-dev/utils").FieldMap<{
            react: import("@baseplate-dev/utils").ScalarContainer<boolean | undefined>;
            eslintIgnore: import("@baseplate-dev/utils").ArrayContainer<string>;
            devDependencies: import("@baseplate-dev/utils").ArrayContainer<string>;
            disableVitest: import("@baseplate-dev/utils").ScalarContainer<boolean | undefined>;
            tsDefaultProjectFiles: import("@baseplate-dev/utils").ArrayContainer<string>;
        }>, "getValues">>;
    }, undefined>;
    routes: import("@baseplate-dev/sync").GeneratorTask<{
        reactRoutes: import("@baseplate-dev/sync").ProviderExport<import("#src/providers/routes.js").ReactRoutesProvider>;
        reactRouter: import("@baseplate-dev/sync").ProviderExport<ReactRouterProvider>;
    }, {
        pathRoots: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/core-generators").PathRootsProvider>;
    }, any>;
    main: import("@baseplate-dev/sync").GeneratorTask<any, {
        reactRouterConfigValues: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/utils").FieldMapValues<{
            routerSetupFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
            routerBodyFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
            rootLayoutComponent: import("@baseplate-dev/utils").ScalarContainer<TsCodeFragment | undefined>;
            rootContextFields: import("@baseplate-dev/utils").NamedArrayFieldContainer<RootRouteContextField>;
            errorComponentHeaderFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
            errorComponentBodyFragments: import("@baseplate-dev/utils").MapContainer<string, TsCodeFragment>;
        }>>;
        renderers: import("@baseplate-dev/sync").ProviderType<import("./generated/template-renderers.js").CoreReactRouterRenderers>;
        reactErrorImports: import("@baseplate-dev/sync").ProviderType<import("@baseplate-dev/core-generators").InferTsImportMapFromSchema<{
            formatError: {};
            logAndFormatError: {};
            logError: {};
        }>>;
    }, any>;
}>;
//# sourceMappingURL=react-router.generator.d.ts.map