@firecms/core 3.0.0-canary.14 → 3.0.0-canary.140

package/dist/form/EntityForm.d.ts

@@ -1,77 +0,0 @@
-import { Entity, EntityCollection, EntityStatus, EntityValues, FormContext, ResolvedEntityCollection } from "../types";
-import { ValidationError } from "yup";
-/**
- * @group Components
- */
-export interface EntityFormProps<M extends Record<string, any>> {
-    /**
-     * New or existing status
-     */
-    status: EntityStatus;
-    /**
-     * Path of the collection this entity is located
-     */
-    path: string;
-    /**
-     * The collection is used to build the fields of the form
-     */
-    collection: EntityCollection<M>;
-    /**
-     * The updated entity is passed from the parent component when the underlying data
-     * has changed in the datasource
-     */
-    entity?: Entity<M>;
-    /**
-     * The callback function called when Save is clicked and validation is correct
-     */
-    onEntitySaveRequested: (props: EntityFormSaveParams<M>) => Promise<void>;
-    /**
-     * The callback function called when discard is clicked
-     */
-    onDiscard?: () => void;
-    /**
-     * The callback function when the form is dirty, so the values are different
-     * from the original ones
-     */
-    onModified?: (dirty: boolean) => void;
-    /**
-     * The callback function when the form original values have been modified
-     */
-    onValuesChanged?: (values?: EntityValues<M>) => void;
-    /**
-     *
-     * @param id
-     */
-    onIdChange?: (id: string) => void;
-    currentEntityId?: string;
-    onFormContextChange?: (formContext: FormContext<M>) => void;
-    hideId?: boolean;
-    autoSave?: boolean;
-    onIdUpdateError?: (error: any) => void;
-}
-export type EntityFormSaveParams<M extends Record<string, any>> = {
-    collection: ResolvedEntityCollection<M>;
-    path: string;
-    entityId: string | undefined;
-    values: EntityValues<M>;
-    previousValues?: EntityValues<M>;
-    closeAfterSave: boolean;
-    autoSave: boolean;
-};
-/**
- * This is the form used internally by the CMS
- * @param status
- * @param path
- * @param collection
- * @param entity
- * @param onEntitySave
- * @param onDiscard
- * @param onModified
- * @param onValuesChanged
- * @constructor
- * @group Components
- */
-export declare const EntityForm: typeof EntityFormInternal;
-declare function EntityFormInternal<M extends Record<string, any>>({ status, path, collection: inputCollection, entity, onEntitySaveRequested, onDiscard, onModified, onValuesChanged, onIdChange, onFormContextChange, hideId, autoSave, onIdUpdateError, }: EntityFormProps<M>): import("react/jsx-runtime").JSX.Element;
-export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;
-export {};

package/dist/form/field_bindings/MarkdownFieldBinding.d.ts

@@ -1,9 +0,0 @@
-import { FieldProps } from "../../types";
-/**
- * Render a markdown field that allows edition and seeing the preview.
- *
- * This is one of the internal components that get mapped natively inside forms
- * and tables to the specified properties.
- * @group Form fields
- */
-export declare function MarkdownFieldBinding({ propertyKey, value, setValue, error, showError, disabled, autoFocus, touched, property, tableMode, includeDescription, context }: FieldProps<string>): import("react/jsx-runtime").JSX.Element;

package/dist/internal/useBuildCustomizationController.d.ts

@@ -1,2 +0,0 @@
-import { CustomizationController } from "../types/customization_controller";
-export declare function useBuildCustomizationController(controller: CustomizationController): CustomizationController;

package/dist/internal/useLocaleConfig.d.ts

@@ -1 +0,0 @@
-export declare function useLocaleConfig(locale?: string): void;

package/dist/types/appcheck.d.ts

@@ -1,26 +0,0 @@
-import { FirebaseApp } from "firebase/app";
-/**
- * @group Firebase
- */
-export interface AppCheck {
-    firebaseApp?: FirebaseApp;
-}
-/**
- * @group Firebase
- */
-export interface AppCheckOptions {
-    providerKey: string;
-    useEnterpriseRecaptcha: boolean;
-    isTokenAutoRefreshEnabled?: boolean;
-    debugToken?: string;
-    forceRefresh?: boolean;
-}
-/**
- * @group Firebase
- */
-export declare interface AppCheckTokenResult {
-    /**
-     * The token string in JWT format.
-     */
-    readonly token: string;
-}

package/src/components/FireCMSAppBar.tsx

@@ -1,165 +0,0 @@
-import React from "react";
-
-import { Link as ReactLink } from "react-router-dom";
-import { ErrorBoundary } from "../components";
-import {
-    Avatar,
-    cn,
-    DarkModeIcon,
-    IconButton,
-    LightModeIcon,
-    LogoutIcon,
-    Menu,
-    MenuItem,
-    Skeleton,
-    Typography
-} from "@firecms/ui";
-import { useAuthController, useLargeLayout, useModeController, useNavigationController } from "../hooks";
-import { User } from "../types";
-
-export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
-    title: string;
-    /**
-     * A component that gets rendered on the upper side of the main toolbar
-     */
-    endAdornment?: React.ReactNode;
-
-    startAdornment?: React.ReactNode;
-
-    dropDownActions?: React.ReactNode;
-
-    includeDrawer?: boolean;
-
-    drawerOpen: boolean;
-
-    className?: string;
-
-    style?: React.CSSProperties;
-
-    user?: User;
-} & ADDITIONAL_PROPS;
-
-/**
- * This component renders the main app bar of FireCMS.
- * You will likely not need to use this component directly.
- *
- * @param title
- * @param toolbarExtraWidget
- * @param drawerOpen
- * @constructor
- */
-export const FireCMSAppBar = function FireCMSAppBar({
-                                                        title,
-                                                        endAdornment,
-                                                        startAdornment,
-                                                        drawerOpen,
-                                                        dropDownActions,
-                                                        includeDrawer,
-                                                        className,
-                                                        style,
-                                                        user: userProp
-                                                    }: FireCMSAppBarProps) {
-    const navigation = useNavigationController();
-
-    const authController = useAuthController();
-    const {
-        mode,
-        toggleMode
-    } = useModeController();
-
-    const largeLayout = useLargeLayout();
-
-    const user = userProp ?? authController.user;
-
-    let avatarComponent: JSX.Element;
-    if (user && user.photoURL) {
-        avatarComponent = <Avatar
-            src={user.photoURL}/>;
-    } else if (user === undefined || authController.initialLoading) {
-        avatarComponent = <div className={"p-1 flex justify-center"}>
-            <Skeleton className={"w-10 h-10 rounded-full"}/>
-        </div>;
-    } else {
-        const initial = user?.displayName
-            ? user.displayName[0].toUpperCase()
-            : (user?.email ? user.email[0].toUpperCase() : "A");
-        avatarComponent = <Avatar>{initial}</Avatar>;
-    }
-
-    return (
-        <div
-            style={style}
-            className={cn("pr-2",
-                {
-                    "ml-[17rem]": drawerOpen && largeLayout,
-                    "ml-16": includeDrawer && !(drawerOpen && largeLayout) && !startAdornment,
-                    "h-16": true,
-                    "z-10": largeLayout,
-                    "transition-all": true,
-                    "ease-in": true,
-                    "duration-75": true,
-                    "w-full": !includeDrawer,
-                    "w-[calc(100%-64px)]": includeDrawer && !(drawerOpen && largeLayout),
-                    "w-[calc(100%-17rem)]": includeDrawer && (drawerOpen && largeLayout),
-                    "duration-150": drawerOpen && largeLayout,
-                    fixed: true,
-                },
-                className)}>
-
-            <div className="flex flex-row gap-2 px-4 h-full items-center">
-
-                {startAdornment}
-
-                {navigation && <div className="mr-8 hidden lg:block">
-                    <ReactLink
-                        className="visited:text-inherit visited:dark:text-inherit"
-                        to={navigation?.basePath ?? "/"}
-                    >
-                        <Typography variant="subtitle1"
-                                    noWrap
-                                    className={"ml-2 !font-medium"}>
-                            {title}
-                        </Typography>
-                    </ReactLink>
-                </div>}
-
-                <div className={"flex-grow"}/>
-
-                {endAdornment &&
-                    <ErrorBoundary>
-                        {endAdornment}
-                    </ErrorBoundary>}
-
-                <IconButton
-                    color="inherit"
-                    aria-label="Open drawer"
-                    onClick={toggleMode}
-                    size="large">
-                    {mode === "dark"
-                        ? <DarkModeIcon/>
-                        : <LightModeIcon/>}
-                </IconButton>
-
-                <Menu trigger={avatarComponent}>
-                    {user && <div className={"px-4 py-2 mb-2"}>
-                        {user.displayName && <Typography variant={"body1"} color={"secondary"}>
-                            {user.displayName}
-                        </Typography>}
-                        {user.email && <Typography variant={"body2"} color={"secondary"}>
-                            {user.email}
-                        </Typography>}
-                    </div>}
-
-                    {dropDownActions}
-
-                    {!dropDownActions && <MenuItem onClick={authController.signOut}>
-                        <LogoutIcon/>
-                        Log Out
-                    </MenuItem>}
-
-                </Menu>
-
-            </div>
-        </div>
-    );
-}

package/src/components/PropertyIdCopyTooltipContent.tsx

@@ -1,28 +0,0 @@
-import { ContentPasteIcon, IconButton, Typography } from "@firecms/ui";
-import { useCallback, useState } from "react";
-
-export function PropertyIdCopyTooltipContent({ propertyId }: { propertyId: string }) {
-
-    const [copied, setCopied] = useState(false);
-
-    return (
-        <div className={"flex flex-row gap-2 items-center justify-center text-white"}>
-            <div>
-                <Typography variant={"caption"} className={"min-w-20 text-slate-400"}
-                            color={"disabled"}>{copied ? "Copied" : "Property ID"}</Typography>
-                <Typography variant={"caption"} className={"text-white"}><code>{propertyId}</code></Typography>
-            </div>
-            {/*    Copy to clipboard button*/}
-            <IconButton size={"small"}>
-                <ContentPasteIcon size={"smallest"}
-                                  className={"text-white"}
-                                  onClick={useCallback(() => {
-                                      navigator.clipboard.writeText(propertyId);
-                                      setCopied(true);
-                                      setTimeout(() => setCopied(false), 2000);
-                                  }, [propertyId])}
-                />
-            </IconButton>
-        </div>
-    );
-}

package/src/core/Drawer.tsx

@@ -1,191 +0,0 @@
-import React, { useCallback } from "react";
-
-import { useLargeLayout, useNavigationController } from "../hooks";
-
-import { NavLink, useNavigate } from "react-router-dom";
-import { CMSAnalyticsEvent, TopNavigationEntry, TopNavigationResult } from "../types";
-import { IconForView } from "../util";
-import { cn, IconButton, Menu, MenuItem, MoreVertIcon, Tooltip, Typography } from "@firecms/ui";
-import { useAnalyticsController } from "../hooks/useAnalyticsController";
-
-/**
- * Props used in case you need to override the default drawer
- * @group Core
- */
-export type DrawerProps<T = {}> = T & {
-    hovered: boolean,
-    drawerOpen: boolean,
-    closeDrawer: () => any,
-}
-
-/**
- * Default drawer used in the CMS
- * @group Core
- */
-export function Drawer({
-                           hovered,
-                           drawerOpen,
-                           closeDrawer
-                       }: DrawerProps) {
-
-    const analyticsController = useAnalyticsController();
-    const navigation = useNavigationController();
-
-    const tooltipsOpen = hovered && !drawerOpen;
-    const largeLayout = useLargeLayout();
-    const navigate = useNavigate();
-
-    const [adminMenuOpen, setAdminMenuOpen] = React.useState(false);
-
-    if (!navigation.topLevelNavigation)
-        throw Error("Navigation not ready in Drawer");
-
-    const {
-        navigationEntries,
-        groups
-    }: TopNavigationResult = navigation.topLevelNavigation;
-
-    const adminViews = navigationEntries.filter(e => e.type === "admin") ?? [];
-    const groupsWithoutAdmin = groups.filter(g => g !== "Admin");
-
-    const buildGroupHeader = useCallback((group?: string) => {
-        if (!drawerOpen) return <div className="h-12 w-full"/>;
-        return <div
-            className="pt-8 pl-6 pr-8 pb-2 flex flex-row items-center">
-            <Typography variant={"caption"}
-                        color={"secondary"}
-                        className="font-medium flex-grow line-clamp-1">
-                {group ? group.toUpperCase() : "Views".toUpperCase()}
-            </Typography>
-
-        </div>;
-    }, [drawerOpen]);
-
-    const onClick = (view: TopNavigationEntry) => {
-        const eventName: CMSAnalyticsEvent = view.type === "collection"
-            ? "drawer_navigate_to_collection"
-            : (view.type === "view" ? "drawer_navigate_to_view" : "unmapped_event");
-        analyticsController.onAnalyticsEvent?.(eventName, { url: view.url });
-        if (!largeLayout)
-            closeDrawer();
-    };
-
-    return (
-        <>
-
-            <div className={"flex-grow overflow-scroll no-scrollbar"}>
-
-                {groupsWithoutAdmin.map((group) => (
-                    <React.Fragment
-                        key={`drawer_group_${group}`}>
-                        {buildGroupHeader(group)}
-                        {Object.values(navigationEntries)
-                            .filter(e => e.group === group)
-                            .map((view, index) =>
-                                <DrawerNavigationItem
-                                    key={`navigation_${index}`}
-                                    icon={<IconForView collectionOrView={view.collection ?? view.view}/>}
-                                    tooltipsOpen={tooltipsOpen}
-                                    drawerOpen={drawerOpen}
-                                    onClick={() => onClick(view)}
-                                    url={view.url}
-                                    name={view.name}/>)}
-                    </React.Fragment>
-                ))}
-
-            </div>
-
-            {adminViews.length > 0 && <Menu
-                open={adminMenuOpen}
-                onOpenChange={setAdminMenuOpen}
-                trigger={
-                    <IconButton
-                        shape={"square"}
-                        className={"m-4 text-gray-900 dark:text-white w-fit"}>
-                        <Tooltip title={"Admin"}
-                                 open={tooltipsOpen}
-                                 side={"right"} sideOffset={28}>
-                            <MoreVertIcon/>
-                        </Tooltip>
-                        {drawerOpen && <div
-                            className={cn(
-                                drawerOpen ? "opacity-100" : "opacity-0 hidden",
-                                "mx-4 font-inherit text-inherit"
-                            )}>
-                            ADMIN
-                        </div>}
-                    </IconButton>}
-            >
-                {adminViews.map((entry, index) =>
-                    <MenuItem
-                        onClick={(event) => {
-                            event.preventDefault();
-                            navigate(entry.path);
-                        }}
-                        key={`navigation_${index}`}>
-                        {<IconForView collectionOrView={entry.view}/>}
-                        {entry.name}
-                    </MenuItem>)}
-
-            </Menu>}
-        </>
-    );
-}
-
-export function DrawerNavigationItem({
-                                         name,
-                                         icon,
-                                         drawerOpen,
-                                         tooltipsOpen,
-                                         url,
-                                         onClick
-                                     }: {
-    icon: React.ReactElement,
-    name: string,
-    tooltipsOpen: boolean,
-    drawerOpen: boolean,
-    url: string,
-    onClick?: () => void,
-}) {
-
-    const iconWrap = <div
-        className={"text-gray-600 dark:text-gray-500"}>
-        {icon}
-    </div>;
-
-    const listItem = <NavLink
-        onClick={onClick}
-        style={{
-            width: !drawerOpen ? "72px" : "280px",
-            transition: drawerOpen ? "width 150ms ease-in" : undefined
-        }}
-        className={({ isActive }: any) => cn("rounded-r-xl truncate",
-            "hover:bg-slate-300 hover:bg-opacity-75 dark:hover:bg-gray-700 dark:hover:bg-opacity-75 text-gray-800 dark:text-gray-200 hover:text-gray-900 hover:dark:text-white",
-            "flex flex-row items-center mr-8",
-            // "transition-all ease-in-out delay-100 duration-300",
-            // drawerOpen ? "w-full" : "w-18",
-            drawerOpen ? "pl-8 h-12" : "pl-6 h-11",
-            "font-medium text-sm",
-            isActive ? "bg-slate-200 bg-opacity-75 dark:bg-gray-800" : ""
-        )}
-        to={url}
-    >
-
-        {iconWrap}
-
-        <div
-            className={cn(
-                drawerOpen ? "opacity-100" : "opacity-0 hidden",
-                "ml-4 font-inherit text-inherit"
-            )}>
-            {name.toUpperCase()}
-        </div>
-    </NavLink>;
-
-    return <Tooltip
-        open={drawerOpen ? false : tooltipsOpen}
-        side="right"
-        title={name}>
-        {listItem}
-    </Tooltip>;
-}