@firecms/core 3.0.0-3.0.0-beta.4.pre.1.0

package/src/preview/property_previews/StringPropertyPreview.tsx

@@ -0,0 +1,60 @@
+import React from "react";
+
+import { resolvePropertyEnum } from "../../util";
+import { EnumValuesChip } from "../components/EnumValuesChip";
+import { PreviewType } from "../../types";
+import { UrlComponentPreview } from "../components/UrlComponentPreview";
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+import { ErrorBoundary } from "../../components";
+import { Chip, cn, getColorSchemeForSeed } from "@firecms/ui";
+
+/**
+ * @group Preview components
+ */
+export function StringPropertyPreview({
+                                          propertyKey,
+                                          value,
+                                          property,
+                                          size
+                                      }: PropertyPreviewProps<string>): React.ReactElement {
+
+    if (property.enumValues) {
+        const enumKey = value;
+        const resolvedProperty = resolvePropertyEnum(property);
+        return <EnumValuesChip
+            enumKey={enumKey}
+            enumValues={resolvedProperty.enumValues}
+            size={size}/>;
+    } else if (property.previewAsTag) {
+        const colorScheme = getColorSchemeForSeed(propertyKey ?? "");
+        return (
+            <ErrorBoundary>
+                <Chip
+                    colorScheme={colorScheme}
+                    size={size}>
+                    {value}
+                </Chip>
+            </ErrorBoundary>);
+    } else if (property.url) {
+        return (
+            <UrlComponentPreview size={size}
+                                 url={value}
+                                 previewType={typeof property.url === "string" ? property.url as PreviewType : undefined}/>
+        );
+    } else {
+        if (!value) return <></>;
+        const lines = value.split("\n");
+        return value && value.includes("\n")
+            ? <div className={cn("overflow-x-scroll", size === "tiny" ? "text-sm" : "")}>
+                {lines.map((str, index) =>
+                    <React.Fragment key={`string_preview_${index}`}>
+                        <span>{str}</span>
+                        {index !== lines.length - 1 && <br/>}
+                    </React.Fragment>)}
+            </div>
+            : (size === "tiny"
+                    ? <span className={"text-sm"}>{value}</span>
+                    : <>{value}</>
+            );
+    }
+}

package/src/preview/util.ts

@@ -0,0 +1,31 @@
+import { CollectionSize } from "../types";
+import { PreviewSize } from "./PropertyPreviewProps";
+
+export const TINY_THUMBNAIL = 40;
+export const SMALL_THUMBNAIL = 100;
+export const REGULAR_THUMBNAIL = 200;
+
+export function getThumbnailMeasure(size: PreviewSize): number {
+    if (size === "tiny")
+        return TINY_THUMBNAIL;
+    else if (size === "small")
+        return SMALL_THUMBNAIL;
+    else if (size === "medium")
+        return REGULAR_THUMBNAIL;
+    else throw Error("Thumbnail size not mapped");
+}
+
+export function getPreviewSizeFrom(size: CollectionSize): PreviewSize {
+    switch (size) {
+        case "xs":
+        case "s":
+            return "tiny";
+        case "m":
+            return "small";
+        case "l":
+        case "xl":
+            return "medium";
+        default:
+            throw Error("Missing mapping value in getPreviewSizeFrom: " + size);
+    }
+}

package/src/types/analytics.ts

@@ -0,0 +1,35 @@
+export type CMSAnalyticsEvent =
+    | "entity_click"
+    | "entity_click_from_reference"
+
+    | "reference_selection_clear"
+    | "reference_selection_toggle"
+    | "reference_selected_single"
+    | "reference_selection_new_entity"
+
+    | "edit_entity_clicked"
+    | "entity_edited"
+    | "new_entity_click"
+    | "new_entity_saved"
+    | "copy_entity_click"
+    | "entity_copied"
+
+    | "single_delete_dialog_open"
+    | "multiple_delete_dialog_open"
+    | "single_entity_deleted"
+    | "multiple_entities_deleted"
+
+    | "drawer_navigate_to_home"
+    | "drawer_navigate_to_collection"
+    | "drawer_navigate_to_view"
+
+    | "home_navigate_to_collection"
+    | "home_favorite_navigate_to_collection"
+    | "home_navigate_to_view"
+    | "home_navigate_to_admin_view"
+    | "home_favorite_navigate_to_view"
+
+    | "collection_inline_editing"
+
+    | "unmapped_event"
+    ;

package/src/types/analytics_controller.tsx

@@ -0,0 +1,10 @@
+import { CMSAnalyticsEvent } from "./analytics";
+
+export type AnalyticsController = {
+
+    /**
+     * Callback used to get analytics events from the CMS
+     */
+    onAnalyticsEvent?: (event: CMSAnalyticsEvent, data?: object) => void;
+
+}

package/src/types/appcheck.ts

@@ -0,0 +1,29 @@
+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/types/auth.tsx

@@ -0,0 +1,59 @@
+import { User } from "./user";
+
+/**
+ * Controller for retrieving the logged user or performing auth related operations.
+ * Note that if you are implementing your AuthController, you probably will want
+ * to do it as the result of a hook.
+ * @group Hooks and utilities
+ */
+export type AuthController<UserType extends User = User, ExtraData extends any = any> = {
+
+    /**
+     * The user currently logged in
+     * The values can be: the user object, null if they skipped login
+     */
+    user: UserType | null;
+
+    /**
+     * Initial loading flag. It is used not to display the login screen
+     * when the app first loads, and it has not been checked whether the user
+     * is logged in or not.
+     */
+    initialLoading?: boolean;
+
+    /**
+     * Loading flag. It is used to display a loading screen when the user is
+     * logging in or out.
+     */
+    authLoading: boolean;
+
+    /**
+     * Sign out
+     */
+    signOut: () => void;
+
+    /**
+     * Error initializing the authentication
+     */
+    authError?: any;
+
+    /**
+     * Error dispatched by the auth provider
+     */
+    authProviderError?: any;
+
+    /**
+     * You can use this method to retrieve the auth token for the current user.
+     */
+    getAuthToken: () => Promise<string>;
+
+    /**
+     * Has the user skipped the login process
+     */
+    loginSkipped: boolean;
+
+    extra: ExtraData;
+
+    setExtra: (extra: ExtraData) => void;
+
+};