@firecms/core 3.0.0-alpha.8 → 3.0.0-alpha.81

package/dist/internal/EntityView.d.ts

@@ -0,0 +1,22 @@
+import { Entity, EntityCollection, User } from "../types";
+export interface EntityViewProps<M extends Record<string, any>> {
+    path: string;
+    collection: EntityCollection<M>;
+    entityId?: string;
+    copy?: boolean;
+    selectedSubPath?: string;
+    parentCollectionIds: string[];
+    formWidth?: number | string;
+    onValuesAreModified: (modified: boolean) => void;
+    onUpdate?: (params: {
+        entity: Entity<any>;
+    }) => void;
+    onClose?: () => void;
+}
+/**
+ * This is the default view that is used as the content of a side panel when
+ * an entity is opened.
+ * You probably don't want to use this view directly since it is bound to the
+ * side panel. Instead, you might want to use {@link EntityForm} or {@link EntityCollectionView}
+ */
+export declare function EntityView<M extends Record<string, any>, UserType extends User>({ path, entityId, selectedSubPath, copy, collection, parentCollectionIds, onValuesAreModified, formWidth, onUpdate, onClose }: EntityViewProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/internal/common.d.ts

@@ -0,0 +1,3 @@
+export declare const CONTAINER_FULL_WIDTH = "100vw";
+export declare const ADDITIONAL_TAB_WIDTH = "55vw";
+export declare const FORM_CONTAINER_WIDTH = "768px";

package/dist/internal/useBuildDataSource.d.ts

@@ -0,0 +1,22 @@
+import { DataSource, DataSourceDelegate, EntityReference, GeoPoint, NavigationController, PropertyConfig } from "../types";
+/**
+ * Use this hook to build a {@link DataSource} based on Firestore
+ * @param firebaseApp
+ * @group Firebase
+ */
+export declare function useBuildDataSource({ delegate, propertyConfigs, navigationController }: {
+    delegate: DataSourceDelegate;
+    propertyConfigs?: Record<string, PropertyConfig>;
+    navigationController: NavigationController;
+}): DataSource;
+/**
+ * Recursive function that converts Firestore data types into CMS or plain
+ * JS types.
+ * FireCMS uses Javascript dates internally instead of Firestore timestamps.
+ * This makes it easier to interact with the rest of the libraries and
+ * bindings.
+ * Also, Firestore references are replaced with {@link EntityReference}
+ * @param data
+ * @group Firestore
+ */
+export declare function cmsToDelegateModel(data: any, buildReference: (reference: EntityReference) => any, buildGeoPoint: (geoPoint: GeoPoint) => any, buildDate: (date: Date) => any, buildDelete: () => any): any;

package/dist/internal/useBuildNavigationController.d.ts

@@ -0,0 +1,14 @@
+import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, FireCMSPlugin, NavigationController, User, UserConfigurationPersistence } from "../types";
+type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+    basePath?: string;
+    baseCollectionPath?: string;
+    authController: AuthController<UserType>;
+    collections?: EC[] | EntityCollectionsBuilder<EC>;
+    views?: CMSView[] | CMSViewsBuilder;
+    userConfigPersistence?: UserConfigurationPersistence;
+    plugins?: FireCMSPlugin[];
+    dataSource: DataSourceDelegate;
+};
+export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>({ basePath, baseCollectionPath, authController, collections: baseCollections, views: baseViews, userConfigPersistence, plugins, dataSource }: BuildNavigationContextProps<EC, UserType>): NavigationController;
+export declare function getSidePanelKey(path: string, entityId?: string): string;
+export {};

package/dist/internal/useBuildSideDialogsController.d.ts

@@ -0,0 +1,2 @@
+import { SideDialogsController } from "../types";
+export declare function useBuildSideDialogsController(): SideDialogsController;

package/dist/internal/useBuildSideEntityController.d.ts

@@ -0,0 +1,4 @@
+import { EntityCollection, EntitySidePanelProps, NavigationController, SideDialogsController, SideEntityController } from "../types";
+export declare function getEntityViewWidth(props: EntitySidePanelProps<any>, small: boolean): string;
+export declare const useBuildSideEntityController: (navigation: NavigationController, sideDialogsController: SideDialogsController) => SideEntityController;
+export declare function buildSidePanelsFromUrl(path: string, collections: EntityCollection[], newFlag: boolean): EntitySidePanelProps<any>[];

package/dist/internal/useLocaleConfig.d.ts

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

package/dist/internal/useRestoreScroll.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export declare function useRestoreScroll(): {
+    containerRef: React.RefObject<HTMLDivElement>;
+    scroll: number;
+    direction: "up" | "down";
+};

package/dist/internal/useUnsavedChangesDialog.d.ts

@@ -0,0 +1,14 @@
+import React from "react";
+export declare function useNavigationUnsavedChangesDialog(when: boolean, onSuccess: () => void): {
+    navigationWasBlocked: boolean;
+    handleCancel: () => void;
+    handleOk: () => void;
+};
+export interface UnsavedChangesDialogProps {
+    open: boolean;
+    body?: React.ReactNode;
+    title?: string;
+    handleOk: () => void;
+    handleCancel: () => void;
+}
+export declare function UnsavedChangesDialog({ open, handleOk, handleCancel, body, title }: UnsavedChangesDialogProps): import("react/jsx-runtime").JSX.Element;

package/dist/preview/PropertyPreview.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { CMSType } from "../types";
+import { PropertyPreviewProps } from "./PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare const PropertyPreview: React.MemoExoticComponent<(<T extends CMSType>(props: PropertyPreviewProps<T, any, Record<string, any>>) => any)>;

package/dist/preview/PropertyPreviewProps.d.ts

@@ -0,0 +1,43 @@
+import { CMSType, Property, ResolvedProperty } from "../types";
+/**
+ * @group Preview components
+ */
+export type PreviewSize = "medium" | "small" | "tiny";
+/**
+ * @group Preview components
+ */
+export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any, M extends Record<string, any> = Record<string, any>> {
+    /**
+     * Name of the property
+     */
+    propertyKey?: string;
+    /**
+     * Current value of the property
+     */
+    value: T;
+    /**
+     * Property this display is related to
+     */
+    property: Property<T> | ResolvedProperty<T>;
+    /**
+     * Click handler
+     */
+    /**
+     * Desired size of the preview, depending on the context.
+     */
+    size: PreviewSize;
+    /**
+     * Max height assigned to the preview, depending on the context.
+     * It may be undefined if unlimited.
+     */
+    height?: number;
+    /**
+     * Max height width to the preview, depending on the context.
+     * It may be undefined if unlimited.
+     */
+    width?: number;
+    /**
+     * Additional properties set by the developer
+     */
+    customProps?: CustomProps;
+}

package/dist/preview/components/ArrayEnumPreview.d.ts

@@ -0,0 +1,11 @@
+import { EnumValueConfig } from "../../types";
+import { PreviewSize } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayEnumPreview({ name, value, enumValues, size }: {
+    value: string[] | number[];
+    name: string | undefined;
+    enumValues: EnumValueConfig[];
+    size: PreviewSize;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/preview/components/AsyncPreviewComponent.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+export interface AsyncPreviewComponentProps {
+    builder: Promise<React.ReactNode>;
+}
+/**
+ * Utility component used to render the result of an async execution.
+ * It shows a loading indicator while at it.
+ *
+ * @group Preview components
+ */
+export declare const AsyncPreviewComponent: React.MemoExoticComponent<(<M extends Record<string, any>>({ builder }: AsyncPreviewComponentProps) => import("react/jsx-runtime").JSX.Element)>;

package/dist/preview/components/BooleanPreview.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+/**
+ * @group Preview components
+ */
+export declare function BooleanPreview({ value }: {
+    value: boolean;
+}): React.ReactElement;

package/dist/preview/components/DatePreview.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+/**
+ * @group Preview components
+ */
+export declare function DatePreview({ date }: {
+    date: Date;
+}): React.ReactElement;

package/dist/preview/components/EmptyValue.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @group Preview components
+ */
+export declare function EmptyValue(): import("react/jsx-runtime").JSX.Element;

package/dist/preview/components/EnumValuesChip.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { EnumValues } from "../../types";
+export interface EnumValuesChipProps {
+    enumValues?: EnumValues;
+    enumKey: string | number;
+    size: "small" | "medium";
+    className?: string;
+    children?: React.ReactNode;
+}
+/**
+ * @group Preview components
+ */
+export declare function EnumValuesChip({ enumValues, enumKey, size, className, children }: EnumValuesChipProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/components/ImagePreview.d.ts

@@ -0,0 +1,12 @@
+import { PreviewSize } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export interface ImagePreviewProps {
+    size: PreviewSize;
+    url: string;
+}
+/**
+ * @group Preview components
+ */
+export declare function ImagePreview({ size, url }: ImagePreviewProps): import("react/jsx-runtime").JSX.Element;

package/dist/preview/components/ReferencePreview.d.ts

@@ -0,0 +1,22 @@
+import * as React from "react";
+import { EntityReference } from "../../types";
+import { PreviewSize } from "../PropertyPreviewProps";
+export type ReferencePreviewProps = {
+    disabled?: boolean;
+    reference: EntityReference;
+    size: PreviewSize;
+    previewProperties?: string[];
+    onClick?: (e: React.SyntheticEvent) => void;
+    onHover?: boolean;
+    allowEntityNavigation?: boolean;
+};
+/**
+ * @group Preview components
+ */
+export declare const ReferencePreview: React.FunctionComponent<ReferencePreviewProps>;
+export declare function ReferencePreviewContainer({ children, onHover, size, onClick }: {
+    children: React.ReactNode;
+    onHover?: boolean;
+    size: PreviewSize;
+    onClick?: (e: React.SyntheticEvent) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/preview/components/StorageThumbnail.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { PreviewSize } from "../PropertyPreviewProps";
+type StorageThumbnailProps = {
+    storagePathOrDownloadUrl: string;
+    storeUrl: boolean;
+    size: PreviewSize;
+};
+/**
+ * @group Preview components
+ */
+export declare const StorageThumbnail: React.FunctionComponent<StorageThumbnailProps>;
+export declare function StorageThumbnailInternal({ storeUrl, storagePathOrDownloadUrl, size }: StorageThumbnailProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/preview/components/UrlComponentPreview.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+import { PreviewType } from "../../types";
+import { PreviewSize } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function UrlComponentPreview({ url, previewType, size, hint }: {
+    url: string;
+    previewType?: PreviewType;
+    size: PreviewSize;
+    hint?: string;
+}): React.ReactElement;

package/dist/preview/index.d.ts

@@ -0,0 +1,23 @@
+export { PropertyPreview } from "./PropertyPreview";
+export type { PropertyPreviewProps, PreviewSize } from "./PropertyPreviewProps";
+export * from "./property_previews/ArrayOfStringsPreview";
+export * from "./property_previews/ArrayPropertyEnumPreview";
+export * from "./property_previews/ArrayOfMapsPreview";
+export * from "./property_previews/NumberPropertyPreview";
+export * from "./property_previews/StringPropertyPreview";
+export * from "./property_previews/ArrayOfStorageComponentsPreview";
+export * from "./property_previews/ArrayOfReferencesPreview";
+export * from "./property_previews/MapPropertyPreview";
+export * from "./property_previews/ArrayPropertyPreview";
+export * from "./property_previews/ArrayOneOfPreview";
+export * from "./property_previews/SkeletonPropertyComponent";
+export * from "./components/AsyncPreviewComponent";
+export * from "./components/DatePreview";
+export * from "./components/UrlComponentPreview";
+export * from "./components/StorageThumbnail";
+export * from "./components/ArrayEnumPreview";
+export * from "./components/BooleanPreview";
+export * from "./components/EnumValuesChip";
+export * from "./components/EmptyValue";
+export * from "./components/ImagePreview";
+export * from "./components/ReferencePreview";

package/dist/preview/property_previews/ArrayOfMapsPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayOfMapsPreview({ propertyKey, value, property: inputProperty, size, }: PropertyPreviewProps<Record<string, any>[]>): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/ArrayOfReferencesPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayOfReferencesPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<any[]>): import("react/jsx-runtime").JSX.Element;

package/dist/preview/property_previews/ArrayOfStorageComponentsPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayOfStorageComponentsPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<any[]>): import("react/jsx-runtime").JSX.Element;

package/dist/preview/property_previews/ArrayOfStringsPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../../preview";
+/**
+ * @group Preview components
+ */
+export declare function ArrayOfStringsPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<string[]>): import("react/jsx-runtime").JSX.Element;

package/dist/preview/property_previews/ArrayOneOfPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayOneOfPreview({ propertyKey, value, property: inputProperty, size, }: PropertyPreviewProps<any[]>): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/ArrayPropertyEnumPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayPropertyEnumPreview({ propertyKey, value, property, size }: PropertyPreviewProps<string[] | number[]>): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/ArrayPropertyPreview.d.ts

@@ -0,0 +1,5 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function ArrayPropertyPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<any[]>): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/MapPropertyPreview.d.ts

@@ -0,0 +1,8 @@
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function MapPropertyPreview<T extends Record<string, any> = Record<string, any>>({ propertyKey, value, property, size }: PropertyPreviewProps<T>): import("react/jsx-runtime").JSX.Element | null;
+export declare function KeyValuePreview({ value }: {
+    value: any;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/NumberPropertyPreview.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+import { PropertyPreviewProps } from "../../preview";
+/**
+ * @group Preview components
+ */
+export declare function NumberPropertyPreview({ value, property, size }: PropertyPreviewProps<number>): React.ReactElement;

package/dist/preview/property_previews/SkeletonPropertyComponent.d.ts

@@ -0,0 +1,14 @@
+import { ResolvedProperty } from "../../types";
+import { PreviewSize } from "../PropertyPreviewProps";
+export interface SkeletonPropertyComponentProps {
+    property: ResolvedProperty;
+    size: PreviewSize;
+}
+/**
+ * @group Preview components
+ */
+export declare function SkeletonPropertyComponent({ property, size }: SkeletonPropertyComponentProps): any;
+export declare function renderSkeletonImageThumbnail(size: PreviewSize): import("react/jsx-runtime").JSX.Element;
+export declare function renderSkeletonText(index?: number, width?: number): import("react/jsx-runtime").JSX.Element;
+export declare function renderSkeletonCaptionText(index?: number): import("react/jsx-runtime").JSX.Element;
+export declare function renderSkeletonIcon(): import("react/jsx-runtime").JSX.Element;

package/dist/preview/property_previews/StringPropertyPreview.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+import { PropertyPreviewProps } from "../PropertyPreviewProps";
+/**
+ * @group Preview components
+ */
+export declare function StringPropertyPreview({ propertyKey, value, property, size }: PropertyPreviewProps<string>): React.ReactElement;

package/dist/preview/util.d.ts

@@ -0,0 +1,7 @@
+import { CollectionSize } from "../types";
+import { PreviewSize } from "./PropertyPreviewProps";
+export declare const TINY_THUMBNAIL = 40;
+export declare const SMALL_THUMBNAIL = 100;
+export declare const REGULAR_THUMBNAIL = 200;
+export declare function getThumbnailMeasure(size: PreviewSize): number;
+export declare function getPreviewSizeFrom(size: CollectionSize): PreviewSize;

package/dist/types/analytics.d.ts

@@ -0,0 +1 @@
+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_favorite_navigate_to_view" | "collection_inline_editing" | "unmapped_event";

package/dist/types/appcheck.d.ts

@@ -0,0 +1,26 @@
+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/dist/types/auth.d.ts

@@ -0,0 +1,40 @@
+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> = {
+    /**
+     * 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;
+    /**
+     * 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;
+};