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

package/dist/hooks/data/save.d.ts

@@ -0,0 +1,42 @@
+import { DataSource, Entity, EntityCallbacks, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
+/**
+ * @group Hooks and utilities
+ */
+export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEntityProps<M> & {
+    callbacks?: EntityCallbacks<M>;
+    onSaveSuccess?: (updatedEntity: Entity<M>) => void;
+    onSaveFailure?: (e: Error) => void;
+    onPreSaveHookError?: (e: Error) => void;
+    onSaveSuccessHookError?: (e: Error) => void;
+};
+/**
+ * This function is in charge of saving an entity to the datasource.
+ * It will run all the save callbacks specified in the collection.
+ * It is also possible to attach callbacks on save success or error, and callback
+ * errors.
+ *
+ * If you just want to save the data without running the `onSaveSuccess`,
+ * `onSaveFailure` and `onPreSave` callbacks, you can use the `saveEntity` method
+ * in the datasource ({@link useDataSource}).
+ *
+ * @param collection
+ * @param path
+ * @param entityId
+ * @param callbacks
+ * @param values
+ * @param previousValues
+ * @param status
+ * @param dataSource
+ * @param context
+ * @param onSaveSuccess
+ * @param onSaveFailure
+ * @param onPreSaveHookError
+ * @param onSaveSuccessHookError
+ * @see useDataSource
+ * @group Hooks and utilities
+ */
+export declare function saveEntityWithCallbacks<M extends Record<string, any>, UserType extends User>({ collection, path, entityId, values, previousValues, status, dataSource, context, onSaveSuccess, onSaveFailure, onPreSaveHookError, onSaveSuccessHookError }: SaveEntityWithCallbacksProps<M> & {
+    collection: EntityCollection<M>;
+    dataSource: DataSource;
+    context: FireCMSContext<UserType>;
+}): Promise<void>;

package/dist/hooks/data/useCollectionFetch.d.ts

@@ -0,0 +1,50 @@
+import { Entity, EntityCollection, FilterValues, User } from "../../types";
+/**
+ * @group Hooks and utilities
+ */
+export interface CollectionFetchProps<M extends Record<string, any>> {
+    /**
+     * Absolute collection path
+     */
+    path: string;
+    /**
+     * collection of the entity displayed by this collection
+     */
+    collection: EntityCollection<M>;
+    /**
+     * Number of entities to fetch
+     */
+    itemCount?: number;
+    /**
+     * Filter the fetched data by the property
+     */
+    filterValues?: FilterValues<Extract<keyof M, string>>;
+    /**
+     * Sort the results by
+     */
+    sortBy?: [Extract<keyof M, string>, "asc" | "desc"];
+    /**
+     * Search string
+     */
+    searchString?: string;
+}
+/**
+ * @group Hooks and utilities
+ */
+export interface CollectionFetchResult<M extends Record<string, any>> {
+    data: Entity<M>[];
+    dataLoading: boolean;
+    noMoreToLoad: boolean;
+    dataLoadingError?: Error;
+}
+/**
+ * This hook is used to fetch collections using a given collection
+ * @param path
+ * @param collection
+ * @param filterValues
+ * @param sortBy
+ * @param itemCount
+ * @param searchString
+ * @group Hooks and utilities
+ */
+export declare function useCollectionFetch<M extends Record<string, any>, UserType extends User>({ path: inputPath, collection, filterValues, sortBy, itemCount, searchString }: CollectionFetchProps<M>): CollectionFetchResult<M>;

package/dist/hooks/data/useDataOrder.d.ts

@@ -0,0 +1,12 @@
+import { Entity } from "../../types";
+export interface DataOrderProps<M extends Record<string, any>> {
+    data: Entity<M>[];
+    entitiesDisplayedFirst?: Entity<M>[];
+}
+/**
+ * This hook is used to have some entities at the beginning of data.
+ * @param path
+ * @param entitiesDisplayedFirst
+ * @group Hooks and utilities
+ */
+export declare function useDataOrder<M extends Record<string, any>>({ data, entitiesDisplayedFirst }: DataOrderProps<M>): Entity<M>[];

package/dist/hooks/data/useDataSource.d.ts

@@ -0,0 +1,6 @@
+import { DataSource, EntityCollection } from "../../types";
+/**
+ * Use this hook to get the datasource being used
+ * @group Hooks and utilities
+ */
+export declare const useDataSource: (collection?: EntityCollection) => DataSource;

package/dist/hooks/data/useEntityFetch.d.ts

@@ -0,0 +1,28 @@
+import { Entity, EntityCollection, User } from "../../types";
+/**
+ * @group Hooks and utilities
+ */
+export interface EntityFetchProps<M extends Record<string, any>> {
+    path: string;
+    entityId?: string;
+    collection: EntityCollection<M>;
+    useCache?: boolean;
+}
+/**
+ * @group Hooks and utilities
+ */
+export interface EntityFetchResult<M extends Record<string, any>> {
+    entity?: Entity<M>;
+    dataLoading: boolean;
+    dataLoadingError?: Error;
+}
+/**
+ * This hook is used to fetch an entity.
+ * It gives real time updates if the datasource supports it.
+ * @param path
+ * @param collection
+ * @param entityId
+ * @param useCache
+ * @group Hooks and utilities
+ */
+export declare function useEntityFetch<M extends Record<string, any>, UserType extends User>({ path: inputPath, entityId, collection, useCache }: EntityFetchProps<M>): EntityFetchResult<M>;

package/dist/hooks/index.d.ts

@@ -0,0 +1,22 @@
+export * from "./data/useDataSource";
+export * from "./data/useCollectionFetch";
+export * from "./data/useEntityFetch";
+export * from "./data/save";
+export * from "./data/delete";
+export * from "./useNavigationController";
+export * from "./useResolvedNavigationFrom";
+export * from "./useStorageSource";
+export * from "./useAuthController";
+export * from "./useSideDialogsController";
+export * from "./useSideEntityController";
+export * from "./useFireCMSContext";
+export * from "./useSnackbarController";
+export * from "./useModeController";
+export * from "./useClipboard";
+export * from "./useLargeLayout";
+export * from "./useReferenceDialog";
+export * from "./useBrowserTitleAndIcon";
+export * from "./useCustomizationController";
+export * from "./useBuildNavigationController";
+export * from "./useBuildLocalConfigurationPersistence";
+export * from "./useBuildModeController";

package/dist/hooks/useAnalyticsController.d.ts

@@ -0,0 +1,5 @@
+import { AnalyticsController } from "../types";
+/**
+ * @group Hooks and utilities
+ */
+export declare const useAnalyticsController: () => AnalyticsController;

package/dist/hooks/useAuthController.d.ts

@@ -0,0 +1,11 @@
+import { AuthController, User } from "../types";
+/**
+ * Hook to retrieve the AuthContext.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @see AuthController
+ * @group Hooks and utilities
+ */
+export declare const useAuthController: <UserType extends User = User, AuthControllerType extends AuthController<UserType> = AuthController<UserType>>() => AuthControllerType;

package/dist/hooks/useBrowserTitleAndIcon.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Internal hook to handle the browser title and icon
+ * @param name
+ * @param logo
+ */
+export declare function useBrowserTitleAndIcon(name: string, logo?: string): void;

package/dist/hooks/useBuildLocalConfigurationPersistence.d.ts

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

package/dist/hooks/useBuildModeController.d.ts

@@ -0,0 +1,6 @@
+import { ModeController } from "./index";
+/**
+ * Use this hook to build a color mode controller that determines
+ * the theme of the CMS
+ */
+export declare function useBuildModeController(): ModeController;

package/dist/hooks/useBuildNavigationController.d.ts

@@ -0,0 +1,24 @@
+import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
+type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+    basePath?: string;
+    baseCollectionPath?: string;
+    authController: AuthController<UserType>;
+    collections?: EC[] | EntityCollectionsBuilder<EC>;
+    collectionPermissions?: PermissionsBuilder;
+    views?: CMSView[] | CMSViewsBuilder;
+    adminViews?: CMSView[] | CMSViewsBuilder;
+    viewsOrder?: string[];
+    userConfigPersistence?: UserConfigurationPersistence;
+    dataSourceDelegate: DataSourceDelegate;
+    /**
+     * Use this method to inject collections to the CMS.
+     * You receive the current collections as a parameter, and you can return
+     * a new list of collections.
+     * @see {@link joinCollectionLists}
+     * @param collections
+     */
+    injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
+};
+export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>(props: BuildNavigationContextProps<EC, UserType>): NavigationController;
+export declare function getSidePanelKey(path: string, entityId?: string): string;
+export {};

package/dist/hooks/useClipboard.d.ts

@@ -0,0 +1,57 @@
+import { MutableRefObject } from "react";
+export interface UseClipboardProps {
+    /**
+     * It's callback function that is called after the `copy` command
+     * is executed.
+     *
+     * @param text: The selected clipboard text.
+     */
+    onSuccess?: (text: string) => void;
+    /**
+     * Triggers when the hook encounters an error.
+     * If passed hook won't throw an error.
+     *
+     * @param error: cause of the error
+     */
+    onError?: (error: string) => void;
+    /**
+     * Disables the new clipboard API `navigator.clipboard` even if
+     * it is supported.
+     */
+    disableClipboardAPI?: boolean;
+    /**
+     * revert back the isCopied flag to false again if a value is set.
+     */
+    copiedDuration?: number;
+}
+export interface useClipboardReturnType {
+    /**
+     * Use ref to pull the text content from.
+     */
+    ref: MutableRefObject<any>;
+    /**
+     * Use it to perform the copy operation
+     */
+    copy: (text?: string) => void;
+    /**
+     * Use it to perform the cut operation
+     */
+    cut: () => void;
+    /**
+     * Indicates wheater the content was successfully copied or not.
+     */
+    isCoppied: boolean;
+    /**
+     * Current selected clipboard content.
+     */
+    clipboard: string;
+    /**
+     * Clears the user clipboard.
+     */
+    clearClipboard: () => void;
+    /**
+     * Check to see if the browser supports the new `navigator.clipboard` API.
+     */
+    isSupported: () => boolean;
+}
+export declare const useClipboard: (options?: UseClipboardProps) => useClipboardReturnType;

package/dist/hooks/useCustomizationController.d.ts

@@ -0,0 +1,11 @@
+import { CustomizationController } from "../types/customization_controller";
+/**
+ * Use this hook to retrieve the customization controller.
+ * This hook includes all the customization options that can be used
+ * to customize the CMS.
+ *
+ * You will likely not need to use this hook directly.
+ *
+ * @group Hooks and utilities
+ */
+export declare const useCustomizationController: () => CustomizationController;

package/dist/hooks/useDialogsController.d.ts

@@ -0,0 +1,11 @@
+import { DialogsController } from "../types/dialogs_controller";
+/**
+ * Use this hook to open a dialog imperatively.
+ * Alternatively, you can use dialogs declaratively using the `Dialog` component.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @group Hooks and utilities
+ */
+export declare const useDialogsController: () => DialogsController;

package/dist/hooks/useFireCMSContext.d.ts

@@ -0,0 +1,11 @@
+import { AuthController, FireCMSContext, User } from "../types";
+/**
+ * Hook to retrieve the {@link FireCMSContext}.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS` component.
+ *
+ * @see FireCMSContext
+ * @group Hooks and utilities
+ */
+export declare const useFireCMSContext: <UserType extends User = User, AuthControllerType extends AuthController<UserType> = AuthController<UserType>>() => FireCMSContext<UserType, AuthControllerType>;

package/dist/hooks/useLargeLayout.d.ts

@@ -0,0 +1 @@
+export declare const useLargeLayout: () => boolean;

package/dist/hooks/useModeController.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Use this controller to change color mode
+ * @group Hooks and utilities
+ */
+export interface ModeController {
+    mode: "light" | "dark";
+    setMode: (mode: "light" | "dark") => void;
+    toggleMode: () => void;
+}
+/**
+ * Hook to retrieve the current mode ("light" | "dark"), and `setMode`
+ * or `toggle` functions to change it.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @see ModeController
+ * @group Hooks and utilities
+ */
+export declare const useModeController: () => ModeController;

package/dist/hooks/useNavigationController.d.ts

@@ -0,0 +1,9 @@
+import { NavigationController } from "../types";
+/**
+ * Use this hook to get the navigation of the app.
+ * This controller provides the resolved collections for the CMS as well
+ * as utility methods.
+ *
+ * @group Hooks and utilities
+ */
+export declare const useNavigationController: () => NavigationController;

package/dist/hooks/useProjectLog.d.ts

@@ -0,0 +1,8 @@
+import { AuthController } from "../types";
+export declare const DEFAULT_SERVER_DEV = "https://api-kdoe6pj3qq-ey.a.run.app";
+export declare const DEFAULT_SERVER = "https://api-drplyi3b6q-ey.a.run.app";
+export type AccessResponse = {
+    blocked?: boolean;
+    message?: string;
+};
+export declare function useProjectLog(authController: AuthController): AccessResponse | null;

package/dist/hooks/useReferenceDialog.d.ts

@@ -0,0 +1,18 @@
+import { ReferenceSelectionInnerProps } from "../components";
+/**
+ * This hook is used to open a side dialog that allows the selection
+ * of entities under a given path.
+ * You can use it in custom views for selecting entities.
+ * You need to specify the path of the target collection at least.
+ * If your collection is not defined in your  top collection configuration
+ * (in your `FireCMS` component), you need to specify explicitly.
+ * This is the same hook used internally when a reference property is defined.
+ * @group Hooks and utilities
+ */
+export declare function useReferenceDialog<M extends Record<string, any>>(referenceDialogProps: Omit<ReferenceSelectionInnerProps<M>, "path"> & {
+    path?: string | false;
+    onClose?: () => void;
+}): {
+    open: () => void;
+    close: () => void;
+};

package/dist/hooks/useResolvedNavigationFrom.d.ts

@@ -0,0 +1,72 @@
+import { Entity, EntityCollection, EntityCustomView, FireCMSContext, User } from "../types";
+/**
+ * @see resolveNavigationFrom
+ * @group Hooks and utilities
+ */
+export type ResolvedNavigationEntry<M extends Record<string, any>> = ResolvedNavigationEntity<M> | ResolvedNavigationCollection<M> | ResolvedNavigationEntityCustom<M>;
+/**
+ * @see resolveNavigationFrom
+ * @group Hooks and utilities
+ */
+export interface ResolvedNavigationEntity<M extends Record<string, any>> {
+    type: "entity";
+    entity: Entity<M>;
+    entityId: string;
+    path: string;
+    parentCollection: EntityCollection<M>;
+}
+/**
+ * @see resolveNavigationFrom
+ * @group Hooks and utilities
+ */
+export interface ResolvedNavigationCollection<M extends Record<string, any>> {
+    type: "collection";
+    path: string;
+    collection: EntityCollection<M>;
+}
+/**
+ * @see resolveNavigationFrom
+ * @group Hooks and utilities
+ */
+interface ResolvedNavigationEntityCustom<M extends Record<string, any>> {
+    type: "custom_view";
+    path: string;
+    view: EntityCustomView<M>;
+}
+/**
+ * Use this function to retrieve an array of navigation entries (resolved
+ * collection, entity or entity custom_view) for the given path. You need to pass the app context
+ * that you receive in different callbacks, such as the save hooks.
+ *
+ * It will take into account the `navigation` provided at the `FireCMS` level.
+ *
+ * @param path
+ * @param context
+ * @group Hooks and utilities
+ */
+export declare function resolveNavigationFrom<M extends Record<string, any>, UserType extends User>({ path, context }: {
+    path: string;
+    context: FireCMSContext<UserType>;
+}): Promise<ResolvedNavigationEntry<M>[]>;
+/**
+ * @group Hooks and utilities
+ */
+export interface NavigationFromProps {
+    path: string;
+}
+/**
+ * @group Hooks and utilities
+ */
+export interface NavigationFrom<M extends Record<string, any>> {
+    data?: ResolvedNavigationEntry<M>[];
+    dataLoading: boolean;
+    dataLoadingError?: Error;
+}
+/**
+ * Use this hook to retrieve an array of navigation entries (resolved
+ * collection or entity) for the given path. You can use this hook
+ * in any React component that lives under `FireCMS`
+ * @group Hooks and utilities
+ */
+export declare function useResolvedNavigationFrom<M extends Record<string, any>, UserType extends User>({ path }: NavigationFromProps): NavigationFrom<M>;
+export {};

package/dist/hooks/useSideDialogsController.d.ts

@@ -0,0 +1,18 @@
+import { SideDialogsController } from "../types";
+/**
+ * Hook to retrieve the side dialogs' controller.
+ *
+ * This hook allows you to open and close side dialogs. This is the mechanism
+ * used when open a side entity dialog, or when selecting a reference.
+ *
+ * If you want to open a side entity dialog, you can use the {@link useSideEntityController}
+ * hook.
+ *
+ * If you want to select a reference, you can use the {@link useReferenceDialog}
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @group Hooks and utilities
+ */
+export declare const useSideDialogsController: () => SideDialogsController;

package/dist/hooks/useSideEntityController.d.ts

@@ -0,0 +1,12 @@
+import { SideEntityController } from "../types";
+/**
+ * Use this hook to retrieve an entity controller that allows you to open
+ * a side dialog to edit an entity.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @see SideEntityController
+ * @group Hooks and utilities
+ */
+export declare const useSideEntityController: () => SideEntityController;

package/dist/hooks/useSnackbarController.d.ts

@@ -0,0 +1,42 @@
+import React from "react";
+/**
+ * Possible snackbar types
+ * @group Hooks and utilities
+ */
+export type SnackbarMessageType = "success" | "info" | "warning" | "error";
+/**
+ * Controller to display snackbars
+ * @group Hooks and utilities
+ */
+export interface SnackbarController {
+    /**
+     * Close the currently open snackbar
+     */
+    close: () => void;
+    /**
+     * Display a new snackbar. You need to specify the type and message.
+     * You can optionally specify a title
+     */
+    open: (props: {
+        type: SnackbarMessageType;
+        message: React.ReactNode;
+        autoHideDuration?: number;
+    }) => void;
+}
+/**
+ * Hook to retrieve the SnackbarContext.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @see SnackbarController
+ * @group Hooks and utilities
+ */
+export declare const useSnackbarController: () => {
+    open: (props: {
+        type: SnackbarMessageType;
+        message: React.ReactNode;
+        autoHideDuration?: number;
+    }) => void;
+    close: () => void;
+};

package/dist/hooks/useStorageSource.d.ts

@@ -0,0 +1,6 @@
+import { EntityCollection, StorageSource } from "../types";
+/**
+ * Use this hook to get the storage source being used
+ * @group Hooks and utilities
+ */
+export declare const useStorageSource: (collection?: EntityCollection) => StorageSource;

package/dist/hooks/useUserConfigurationPersistence.d.ts

@@ -0,0 +1,8 @@
+import { UserConfigurationPersistence } from "../types";
+/**
+ * Use this controller to access the configuration that is stored externally,
+ * and not defined in code
+ *
+ * @group Hooks and utilities
+ */
+export declare const useUserConfigurationPersistence: () => UserConfigurationPersistence | undefined;

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./core";
+export * from "./types";
+export * from "./form";
+export * from "./preview";
+export * from "./hooks";
+export * from "./components";
+export * from "./util";
+export * from "./contexts";