@firecms/core 3.3.0 → 3.4.0-canary.63041d0

package/dist/app/useApp.d.ts

@@ -9,6 +9,7 @@ export type AppState = {
     drawerOpen: boolean;
     openDrawer: () => void;
     closeDrawer: () => void;
+    closeHover?: () => void;
     autoOpenDrawer?: boolean;
     logo?: string;
 };

package/dist/components/EntityCollectionTable/column_utils.d.ts

@@ -1,15 +1,16 @@
 import React from "react";
-import { FilterValues, ResolvedProperties, ResolvedProperty } from "../../types";
+import { ResolvedProperties, ResolvedProperty } from "../../types";
 import { VirtualTableColumn } from "../VirtualTable";
 export declare function buildIdColumn(largeLayout?: boolean): VirtualTableColumn;
 export interface PropertiesToColumnsParams<M extends Record<string, any>> {
     properties: ResolvedProperties<M>;
     sortable?: boolean;
-    forceFilter?: FilterValues<keyof M extends string ? keyof M : never>;
+    forcedFilters?: (keyof M)[];
+    allowedFilters?: (keyof M)[];
     AdditionalHeaderWidget?: React.ComponentType<{
         property: ResolvedProperty;
         propertyKey: string;
         onHover: boolean;
     }>;
 }
-export declare function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forceFilter, AdditionalHeaderWidget }: PropertiesToColumnsParams<M>): VirtualTableColumn[];
+export declare function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forcedFilters, AdditionalHeaderWidget, allowedFilters }: PropertiesToColumnsParams<M>): VirtualTableColumn[];

package/dist/components/EntityCollectionTable/internal/CollectionTableToolbar.d.ts

@@ -11,6 +11,11 @@ interface CollectionTableToolbarProps {
     onTextSearchClick?: () => void;
     onTextSearch?: (searchString?: string) => void;
     textSearchLoading?: boolean;
+    /**
+     * Search term the search bar should start with, typically the one restored from the
+     * URL query params by the table controller.
+     */
+    initialSearchString?: string;
 }
-export declare function CollectionTableToolbar({ actions, actionsStart, loading, onTextSearch, onTextSearchClick, textSearchLoading, title, viewModeToggle }: CollectionTableToolbarProps): React.JSX.Element;
+export declare function CollectionTableToolbar({ actions, actionsStart, loading, onTextSearch, onTextSearchClick, textSearchLoading, initialSearchString, title, viewModeToggle }: CollectionTableToolbarProps): React.JSX.Element;
 export {};

package/dist/components/EntityCollectionView/EntityCollectionView.d.ts

@@ -13,6 +13,13 @@ export type EntityCollectionViewProps<M extends Record<string, any>> = {
      * Full path using navigation ids.
      */
     fullIdPath?: string;
+    /**
+     * `fullPath` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
+     * Forwarded to the datasource so a parent entity id containing "/" stays unambiguous.
+     * Defaults to splitting `fullPath`, which is correct for any backend whose ids cannot
+     * contain "/".
+     */
+    pathSegments?: string[];
     /**
      * If this is a subcollection, specify the parent collection ids.
      */

package/dist/components/EntityCollectionView/FiltersDialog.d.ts

@@ -7,9 +7,10 @@ export interface FiltersDialogProps {
     filterValues: FilterValues<any> | undefined;
     setFilterValues: (filterValues?: FilterValues<any>) => void;
     forceFilter?: FilterValues<any>;
+    allowedFilters?: string[];
 }
 /**
  * Dialog that displays all filterable properties from a collection
  * and allows setting filter values for each.
  */
-export declare function FiltersDialog({ open, onOpenChange, properties, filterValues, setFilterValues, forceFilter }: FiltersDialogProps): React.JSX.Element;
+export declare function FiltersDialog({ open, onOpenChange, properties, filterValues, setFilterValues, forceFilter, allowedFilters }: FiltersDialogProps): React.JSX.Element;

package/dist/components/EntityPreview.d.ts

@@ -29,4 +29,6 @@ export type EntityPreviewContainerProps = {
     style?: React.CSSProperties;
     onClick?: (e: React.SyntheticEvent) => void;
 };
-export declare const EntityPreviewContainer: React.ForwardRefExoticComponent<EntityPreviewContainerProps & React.RefAttributes<HTMLDivElement>>;
+export declare function EntityPreviewContainer({ children, hover, onClick, size, style, className, fullwidth, ref }: EntityPreviewContainerProps & {
+    ref?: React.Ref<HTMLDivElement>;
+}): React.JSX.Element;

package/dist/components/SelectableTable/filters/filter_text_input.d.ts

@@ -0,0 +1,30 @@
+export type FilterTextInputParseResult = {
+    /**
+     * Whether the filter value should be updated with `value`.
+     * It is `false` for intermediate inputs that are not a valid value yet,
+     * like "-" or "0.", so that the text typed by the user can be kept as it is
+     * while the current filter value is left untouched.
+     */
+    updateValue: boolean;
+    /**
+     * Parsed value, only relevant when `updateValue` is `true`.
+     * `undefined` means the filter should be cleared.
+     */
+    value?: string | number;
+};
+/**
+ * Turn the raw text of a filter input into the value used by the filter.
+ *
+ * The text shown to the user is never derived back from the parsed value, so
+ * intermediate states like "0.", ".0" or "-" survive while typing. Numbers are
+ * only committed to the filter once the text is a complete number, which makes
+ * values such as 0.01 reachable by typing them character by character.
+ *
+ * Note that `0` is a perfectly valid filter value, only an empty input clears
+ * the filter.
+ */
+export declare function parseFilterTextInput(text: string, dataType: "string" | "number"): FilterTextInputParseResult;
+/**
+ * Text a filter input should display for a given filter value.
+ */
+export declare function filterValueToText(value: unknown): string;

package/dist/components/SelectableTable/filters/filter_text_input.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/components/common/table_url_params.d.ts

@@ -0,0 +1,24 @@
+import { FilterValues } from "../../types";
+/**
+ * Internal helpers used by `useDataSourceTableController` to persist the state of a
+ * collection table (filters, sort and text search) in the URL query string.
+ *
+ * These functions are intentionally NOT re-exported by the package barrel files:
+ * they are pure and live in their own module only so that they can be unit tested.
+ * `encodeFilterAndSort` and `parseFilterAndSort` must stay exact inverses of each
+ * other, otherwise state written to the URL is silently dropped on reload.
+ */
+/**
+ * Serialise the state of a collection table into a URL query string,
+ * without the leading `?`. Returns an empty string when there is no state to persist.
+ */
+export declare function encodeFilterAndSort(filterValues?: FilterValues<string>, sortBy?: [string, "asc" | "desc"] | undefined, searchString?: string): string;
+/**
+ * Restore the state of a collection table from a URL query string.
+ * The inverse of {@link encodeFilterAndSort}.
+ */
+export declare function parseFilterAndSort<M>(search: string): {
+    filterValues: FilterValues<string> | undefined;
+    sortBy?: [Extract<keyof M, string>, "asc" | "desc"];
+    searchString?: string;
+};

package/dist/components/common/useDataSourceTableController.d.ts

@@ -5,6 +5,12 @@ export type DataSourceTableControllerProps<M extends Record<string, any> = any>
      * Full path where the data of this table is located
      */
     fullPath: string;
+    /**
+     * `fullPath` split at its real segment boundaries. Passed through to the datasource so
+     * a parent entity id containing "/" stays unambiguous. Defaults to splitting
+     * `fullPath`, which is correct for any backend whose ids cannot contain "/".
+     */
+    pathSegments?: string[];
     /**
      * The collection that is represented by this config.
      */
@@ -40,4 +46,4 @@ export type DataSourceTableControllerProps<M extends Record<string, any> = any>
  * @param forceFilterFromProps
  * @param updateUrl
  */
-export declare function useDataSourceTableController<M extends Record<string, any> = any, USER extends User = User>({ fullPath, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, updateUrl }: DataSourceTableControllerProps<M>): EntityTableController<M>;
+export declare function useDataSourceTableController<M extends Record<string, any> = any, USER extends User = User>({ fullPath, pathSegments, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, updateUrl }: DataSourceTableControllerProps<M>): EntityTableController<M>;

package/dist/components/common/useTableSearchHelper.d.ts

@@ -3,8 +3,14 @@ export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     collection: EntityCollection<M>;
     fullPath: string;
     parentCollectionIds?: string[];
+    /**
+     * Search term that is already being applied without the user having gone through the
+     * search bar, e.g. one restored from the URL query params. When set, text search is
+     * initialised automatically instead of waiting for a click on the search bar.
+     */
+    initialSearchString?: string;
 }
-export declare function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds }: UseTableSearchHelperParams<M>): {
+export declare function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds, initialSearchString }: UseTableSearchHelperParams<M>): {
     textSearchLoading: boolean;
     textSearchInitialised: boolean;
     onTextSearchClick: (() => void) | undefined;

package/dist/core/DefaultDrawer.d.ts

@@ -8,11 +8,18 @@ export declare function DefaultDrawer({ className, style, }: {
     style?: React.CSSProperties;
 }): React.JSX.Element;
 /**
- * This is the logo displayed in the drawer
- * It expands when the drawer is open.
+ * Collapse/expand toggle rendered at the bottom of the drawer.
+ * Uses double-chevron icons to indicate direction. Reads the drawer state
+ * from {@link useApp} so it can be dropped into any drawer.
+ *
+ * @group Core
+ */
+export declare function DrawerToggle(): React.JSX.Element;
+/**
+ * This is the logo displayed in the drawer.
+ * A compact logo aligned to the left of the drawer header.
  *
  * @param logo
-
  */
 export declare function DrawerLogo({ logo }: {
     logo?: string;

package/dist/core/EntityEditView.d.ts

@@ -32,6 +32,12 @@ export interface EntityEditViewProps<M extends Record<string, any>> {
      * The navigation path to the entity.
      */
     fullIdPath?: string;
+    /**
+     * `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
+     * Forwarded to the datasource, and extended for any subcollection rendered inside this
+     * view, so a parent entity id containing "/" stays unambiguous.
+     */
+    pathSegments?: string[];
     collection: EntityCollection<M>;
     entityId?: string;
     databaseId?: string;
@@ -50,7 +56,7 @@ export interface EntityEditViewProps<M extends Record<string, any>> {
  * an entity is opened.
  */
 export declare function EntityEditView<M extends Record<string, any>, USER extends User>({ entityId, ...props }: EntityEditViewProps<M>): React.JSX.Element;
-export declare function EntityEditViewInner<M extends Record<string, any>>({ path, fullIdPath, entityId, selectedTab: selectedTabProp, collection, parentCollectionIds, onValuesModified, onSaved, onTabChange, entity, initialDirtyValues, dataLoading, layout, barActions, status, setStatus, formProps, canEdit }: EntityEditViewProps<M> & {
+export declare function EntityEditViewInner<M extends Record<string, any>>({ path, fullIdPath, pathSegments, entityId, selectedTab: selectedTabProp, collection, parentCollectionIds, onValuesModified, onSaved, onTabChange, entity, initialDirtyValues, dataLoading, layout, barActions, status, setStatus, formProps, canEdit }: EntityEditViewProps<M> & {
     entity?: Entity<M>;
     initialDirtyValues?: Partial<M>;
     dataLoading: boolean;

package/dist/core/field_configs.d.ts

@@ -3,5 +3,5 @@ export declare function isDefaultFieldConfigId(id: string): boolean;
 export declare const DEFAULT_FIELD_CONFIGS: Record<string, PropertyConfig<any>>;
 export declare function getDefaultFieldConfig(property: Property | ResolvedProperty): PropertyConfig | undefined;
 export declare function getFieldConfig(property: Property | ResolvedProperty, propertyConfigs: Record<string, PropertyConfig<any>>): PropertyConfig | undefined;
-export declare function getDefaultFieldId(property: Property | ResolvedProperty): "reference" | "date_time" | "text_field" | "multiline" | "markdown" | "url" | "email" | "user_select" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "reference_as_string" | "multi_references" | "switch" | "repeat" | "custom_array" | "block" | undefined;
+export declare function getDefaultFieldId(property: Property | ResolvedProperty): "reference" | "date_time" | "geopoint" | "text_field" | "multiline" | "markdown" | "url" | "email" | "user_select" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "reference_as_string" | "multi_references" | "switch" | "repeat" | "custom_array" | "block" | undefined;
 export declare function getFieldId(property: Property | ResolvedProperty): string | undefined;

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

@@ -0,0 +1,5 @@
+import React from "react";
+import { FieldProps, GeoPoint } from "../../types";
+type GeopointFieldBindingProps = FieldProps<GeoPoint>;
+export declare function GeopointFieldBinding({ propertyKey, value, setValue, error, showError, disabled, autoFocus, property, includeDescription, size }: GeopointFieldBindingProps): React.JSX.Element;
+export {};

package/dist/form/index.d.ts

@@ -7,6 +7,7 @@ export { StorageUploadFieldBinding } from "./field_bindings/StorageUploadFieldBi
 export { TextFieldBinding } from "./field_bindings/TextFieldBinding";
 export { SwitchFieldBinding } from "./field_bindings/SwitchFieldBinding";
 export { DateTimeFieldBinding } from "./field_bindings/DateTimeFieldBinding";
+export { GeopointFieldBinding } from "./field_bindings/GeopointFieldBinding";
 export { ReferenceFieldBinding } from "./field_bindings/ReferenceFieldBinding";
 export { ReferenceAsStringFieldBinding } from "./field_bindings/ReferenceAsStringFieldBinding";
 export { MapFieldBinding } from "./field_bindings/MapFieldBinding";

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

@@ -34,7 +34,7 @@ export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEn
  * @see useDataSource
  * @group Hooks and utilities
  */
-export declare function saveEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ collection, path, entityId, values, previousValues, status, dataSource, context, onSaveSuccess, onSaveFailure, onPreSaveHookError, onSaveSuccessHookError }: SaveEntityWithCallbacksProps<M> & {
+export declare function saveEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ collection, path, pathSegments, entityId, values, previousValues, status, dataSource, context, onSaveSuccess, onSaveFailure, onPreSaveHookError, onSaveSuccessHookError }: SaveEntityWithCallbacksProps<M> & {
     collection: EntityCollection<M, USER>;
     dataSource: DataSource;
     context: FireCMSContext;

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

@@ -4,6 +4,11 @@ import { Entity, EntityCollection, User } from "../../types";
  */
 export interface EntityFetchProps<M extends Record<string, any>, USER extends User = User> {
     path: string;
+    /**
+     * `path` split at its real segment boundaries. Forwarded to the datasource so a parent
+     * entity id containing "/" stays unambiguous. Defaults to splitting the resolved path.
+     */
+    pathSegments?: string[];
     entityId?: string;
     databaseId?: string;
     collection: EntityCollection<M, USER>;
@@ -26,4 +31,4 @@ export interface EntityFetchResult<M extends Record<string, any>> {
  * @param useCache
  * @group Hooks and utilities
  */
-export declare function useEntityFetch<M extends Record<string, any>, USER extends User>({ path: inputPath, entityId, collection, databaseId, useCache }: EntityFetchProps<M, USER>): EntityFetchResult<M>;
+export declare function useEntityFetch<M extends Record<string, any>, USER extends User>({ path: inputPath, pathSegments: inputPathSegments, entityId, collection, databaseId, useCache }: EntityFetchProps<M, USER>): EntityFetchResult<M>;