@firecms/core 3.4.0-canary.8635253 → 3.4.0-canary.9408c41

package/README.md

@@ -145,6 +145,10 @@ Keep in mind you need to update the dependencies in that project if you want to
 use it as it is, without linking it to the library source code. More details in
 its README
 
+## Who builds this
+
+Built and maintained by [Camberi](https://camberi.com?utm_source=firecms&utm_medium=referral&utm_campaign=built-by), a product engineering studio in Madrid and Munich that also builds for clients.
+
 ## Contact and support
 
 If you need general support, you can open a GitHub issue.

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/EntityCollectionTable/internal/popup_field/PopupFormField.d.ts

@@ -5,6 +5,8 @@ import { OnCellValueChangeParams } from "../../../common";
 interface PopupFormFieldProps<M extends Record<string, any>> {
     customFieldValidator?: CustomFieldValidator;
     path: string;
+    /** `path` split at its real segment boundaries; forwarded to the datasource. */
+    pathSegments?: string[];
     entityId: string;
     tableKey: string;
     propertyKey?: Extract<keyof M, string>;
@@ -20,7 +22,7 @@ interface PopupFormFieldProps<M extends Record<string, any>> {
     onCellValueChange?: (params: OnCellValueChangeParams<any, any>) => Promise<void> | void;
 }
 export declare function PopupFormField<M extends Record<string, any>>(props: PopupFormFieldProps<M>): React.JSX.Element | null;
-export declare function PopupFormFieldLoading<M extends Record<string, any>>({ tableKey, entityId, customFieldValidator, propertyKey, collection: inputCollection, path, cellRect, open, onClose, onCellValueChange, container }: PopupFormFieldProps<M>): React.JSX.Element | null;
+export declare function PopupFormFieldLoading<M extends Record<string, any>>({ tableKey, entityId, customFieldValidator, propertyKey, collection: inputCollection, path, pathSegments, cellRect, open, onClose, onCellValueChange, container }: PopupFormFieldProps<M>): React.JSX.Element | null;
 export declare function PopupFormFieldInternal<M extends Record<string, any>>({ tableKey, entityId, customFieldValidator, propertyKey, collection: inputCollection, path, cellRect, open, onClose, onCellValueChange, container, entity }: PopupFormFieldProps<M> & {
     entity?: Entity<M>;
 }): React.JSX.Element;

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

@@ -4,6 +4,8 @@ export type EntityCollectionBoardViewProps<M extends Record<string, any> = any>
     collection: EntityCollection<M>;
     tableController: EntityTableController<M>;
     fullPath: string;
+    /** `fullPath` split at its real segment boundaries; forwarded to the datasource. */
+    pathSegments?: string[];
     parentCollectionIds?: string[];
     columnProperty: string;
     onEntityClick?: (entity: Entity<M>) => void;
@@ -17,4 +19,4 @@ export type EntityCollectionBoardViewProps<M extends Record<string, any> = any>
 /**
  * Kanban board view for displaying entities grouped by a string enum property.
  */
-export declare function EntityCollectionBoardView<M extends Record<string, any> = any>({ collection, tableController, fullPath, parentCollectionIds, columnProperty, onEntityClick, selectionController, selectionEnabled, highlightedEntities, emptyComponent, deletedEntities }: EntityCollectionBoardViewProps<M>): React.JSX.Element;
+export declare function EntityCollectionBoardView<M extends Record<string, any> = any>({ collection, tableController, fullPath, pathSegments, parentCollectionIds, columnProperty, onEntityClick, selectionController, selectionEnabled, highlightedEntities, emptyComponent, deletedEntities }: EntityCollectionBoardViewProps<M>): React.JSX.Element;

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

@@ -13,6 +13,14 @@ 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.
+     *
+     * Optional, and never derived by splitting `fullPath` — a guess would be wrong in
+     * exactly the case the field exists for. Absent means "not known here", not "no slashes".
+     */
+    pathSegments?: string[];
     /**
      * If this is a subcollection, specify the parent collection ids.
      */

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

@@ -3,6 +3,8 @@ import { EntityCollection, EntityTableController, SelectionController } from "..
 export type EntityCollectionViewActionsProps<M extends Record<string, any>> = {
     collection: EntityCollection<M>;
     path: string;
+    /** `path` split at its real segment boundaries, when known. Never derived from `path`. */
+    pathSegments?: string[];
     relativePath: string;
     parentCollectionIds: string[];
     selectionEnabled: boolean;
@@ -12,4 +14,4 @@ export type EntityCollectionViewActionsProps<M extends Record<string, any>> = {
     tableController: EntityTableController<M>;
     collectionEntitiesCount?: number;
 };
-export declare function EntityCollectionViewActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, onNewClick, onMultipleDeleteClick, selectionEnabled, path, selectionController, tableController, collectionEntitiesCount, }: EntityCollectionViewActionsProps<M>): React.JSX.Element;
+export declare function EntityCollectionViewActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, onNewClick, onMultipleDeleteClick, selectionEnabled, path, pathSegments, selectionController, tableController, collectionEntitiesCount, }: EntityCollectionViewActionsProps<M>): React.JSX.Element;

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

@@ -3,6 +3,8 @@ import { EntityCollection, EntityTableController, ResolvedProperty, SelectionCon
 export type EntityCollectionViewStartActionsProps<M extends Record<string, any>> = {
     collection: EntityCollection<M>;
     path: string;
+    /** `path` split at its real segment boundaries, when known. Never derived from `path`. */
+    pathSegments?: string[];
     relativePath: string;
     parentCollectionIds: string[];
     selectionController: SelectionController<M>;
@@ -13,4 +15,4 @@ export type EntityCollectionViewStartActionsProps<M extends Record<string, any>>
      */
     resolvedProperties?: Record<string, ResolvedProperty>;
 };
-export declare function EntityCollectionViewStartActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, path, selectionController, tableController, collectionEntitiesCount, resolvedProperties }: EntityCollectionViewStartActionsProps<M>): React.JSX.Element;
+export declare function EntityCollectionViewStartActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, path, pathSegments, selectionController, tableController, collectionEntitiesCount, resolvedProperties }: EntityCollectionViewStartActionsProps<M>): React.JSX.Element;

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

@@ -38,6 +38,8 @@ export interface BoardDataController<M extends Record<string, any> = any, COLUMN
 export interface UseBoardDataControllerProps<M extends Record<string, any> = any> {
     /** Full path to the collection */
     fullPath: string;
+    /** `fullPath` split at its real segment boundaries; forwarded to the datasource. */
+    pathSegments?: string[];
     /** The entity collection configuration */
     collection: EntityCollection<M>;
     /** Property key used for column assignment */
@@ -57,4 +59,4 @@ export interface UseBoardDataControllerProps<M extends Record<string, any> = any
  * Hook that manages per-column data loading for the Kanban board.
  * Each column gets its own independent query to the data source.
  */
-export declare function useBoardDataController<M extends Record<string, any> = any, COLUMN extends string = string>({ fullPath, collection, columnProperty, columns, orderProperty, pageSize, searchString, filterValues }: UseBoardDataControllerProps<M>): BoardDataController<M, COLUMN>;
+export declare function useBoardDataController<M extends Record<string, any> = any, COLUMN extends string = string>({ fullPath, pathSegments, collection, columnProperty, columns, orderProperty, pageSize, searchString, filterValues }: UseBoardDataControllerProps<M>): BoardDataController<M, COLUMN>;

package/dist/components/ErrorBoundary.d.ts

@@ -1,11 +1,9 @@
 import React, { ErrorInfo, PropsWithChildren } from "react";
 export declare class ErrorBoundary extends React.Component<PropsWithChildren<Record<string, unknown>>, {
-    hasError: boolean;
-    error?: Error;
+    error: Error | null;
 }> {
     constructor(props: any);
     static getDerivedStateFromError(error: Error): {
-        hasError: boolean;
         error: Error;
     };
     componentDidCatch(error: Error, errorInfo: ErrorInfo): void;

package/dist/components/LicenseBanner.d.ts

@@ -0,0 +1,23 @@
+import React from "react";
+/**
+ * @group Components
+ */
+export interface LicenseBannerProps {
+    /**
+     * Applied to the banner's outer element when there is something to show.
+     */
+    className?: string;
+    style?: React.CSSProperties;
+}
+/**
+ * Tells the user where their FireCMS PRO license stands: days left in the
+ * trial, a paused state, or a license that covers fewer projects than are
+ * linked to it. Renders nothing when licensed, when no license is needed, and
+ * while the status is unknown.
+ *
+ * The default `Scaffold` already renders it above the main content. Place it
+ * yourself only in a custom layout.
+ *
+ * @group Components
+ */
+export declare function LicenseBanner({ className, style }: LicenseBannerProps): React.JSX.Element | null;

package/dist/components/ReferenceTable/ReferenceSelectionTable.d.ts

@@ -18,6 +18,15 @@ export interface ReferenceSelectionInnerProps<M extends Record<string, any>> {
      * dynamic. If not set, the dialog won't open.
      */
     path: string;
+    /**
+     * `path` split at its real segment boundaries, when the caller knows them.
+     *
+     * Left undefined by default and deliberately NOT derived from `path`: a reference
+     * path comes from a property's configuration, so there is no entity chain to recover
+     * the boundaries from. Splitting it would silently produce the wrong segments for a
+     * subcollection under a slash-bearing parent id, which is worse than not answering.
+     */
+    pathSegments?: string[];
     /**
      * If you are opening the dialog for the first time, you can select some
      * entity ids to be displayed first.
@@ -55,4 +64,4 @@ export interface ReferenceSelectionInnerProps<M extends Record<string, any>> {
  * You probably want to open this dialog as a side view using {@link useReferenceDialog}
  * @group Components
  */
-export declare function ReferenceSelectionTable<M extends Record<string, any>>({ onSingleEntitySelected, onMultipleEntitiesSelected, multiselect, collection, path: pathInput, selectedEntityIds: selectedEntityIdsProp, description, forceFilter, maxSelection, }: ReferenceSelectionInnerProps<M>): React.JSX.Element;
+export declare function ReferenceSelectionTable<M extends Record<string, any>>({ onSingleEntitySelected, onMultipleEntitiesSelected, multiselect, collection, path: pathInput, pathSegments, selectedEntityIds: selectedEntityIdsProp, description, forceFilter, maxSelection, }: ReferenceSelectionInnerProps<M>): 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,14 @@ 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.
+     *
+     * Optional, and never derived by splitting `fullPath` — a guess would be wrong in
+     * exactly the case the field exists for. Absent means "not known here", not "no slashes".
+     */
+    pathSegments?: string[];
     /**
      * The collection that is represented by this config.
      */
@@ -40,4 +48,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

@@ -2,9 +2,17 @@ import { EntityCollection } from "../../types";
 export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     collection: EntityCollection<M>;
     fullPath: string;
+    /** `fullPath` split at its real segment boundaries, when known. Never derived from it. */
+    pathSegments?: 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, pathSegments, parentCollectionIds, initialSearchString }: UseTableSearchHelperParams<M>): {
     textSearchLoading: boolean;
     textSearchInitialised: boolean;
     onTextSearchClick: (() => void) | undefined;

package/dist/components/index.d.ts

@@ -30,3 +30,4 @@ export * from "./FieldCaption";
 export * from "./EntityPreview";
 export * from "./AIIcon";
 export * from "./LanguageToggle";
+export * from "./LicenseBanner";

package/dist/contexts/LicenseStatusContext.d.ts

@@ -0,0 +1,16 @@
+import React from "react";
+import { AccessResponse } from "../types";
+/**
+ * License status of the enclosing `FireCMS`. `undefined` means there is no
+ * `FireCMS` above; `null` means the check has not answered (or was skipped).
+ * @internal
+ */
+export declare const LicenseStatusContext: React.Context<AccessResponse | null | undefined>;
+/** @internal */
+export declare function getLicenseStatusSnapshot(): AccessResponse | null;
+/** @internal */
+export declare function getServerLicenseStatusSnapshot(): AccessResponse | null;
+/** @internal */
+export declare function subscribeLicenseStatus(listener: () => void): () => void;
+/** @internal */
+export declare function publishLicenseStatus(status: AccessResponse | null): void;

package/dist/core/EntityEditView.d.ts

@@ -7,6 +7,8 @@ export type OnUpdateParams = {
     entity: Entity<any>;
     status: EntityStatus;
     path: string;
+    /** `path` split at its real segment boundaries, when known. Never derived from `path`. */
+    pathSegments?: string[];
     entityId?: string;
     selectedTab?: string;
     collection: EntityCollection<any>;
@@ -32,6 +34,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 +58,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/EntityEditViewFormActions.d.ts

@@ -1,3 +1,3 @@
 import React from "react";
 import { EntityFormActionsProps } from "../form/EntityFormActions";
-export declare function EntityEditViewFormActions({ collection, path, entity, layout, savingError, formex, disabled, status, pluginActions, openEntityMode, showDefaultActions, navigateBack, formContext }: EntityFormActionsProps): React.JSX.Element;
+export declare function EntityEditViewFormActions({ collection, path, pathSegments, entity, layout, savingError, formex, disabled, status, pluginActions, openEntityMode, showDefaultActions, navigateBack, formContext }: EntityFormActionsProps): React.JSX.Element;

package/dist/core/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./FireCMS";
+export * from "./pro_plugins";
 export * from "./DefaultDrawer";
 export * from "./DrawerNavigationItem";
 export * from "./DrawerNavigationGroup";

package/dist/core/plugin_translations.d.ts

@@ -0,0 +1,38 @@
+import type { i18n } from "i18next";
+import { FireCMSPlugin } from "../types";
+/**
+ * Record of which bundles have already been written to which locale, so the
+ * same one is never written twice.
+ *
+ * Plugin translation objects are module-level constants and a lazily loaded one
+ * resolves to the same module object every time, so identity is a sound test.
+ */
+export type AppliedBundles = Map<string, Set<object>>;
+export declare function createAppliedBundles(): AppliedBundles;
+/**
+ * Write the plugins' strings for one language into a live i18next instance.
+ *
+ * Only the language in use is resolved, plus English, which every other language
+ * falls back to — a locale given as a function is a bundle that has not been
+ * downloaded yet, and downloading all of them would undo the point of deferring
+ * them. Plain records are applied for every locale, as before: they are already
+ * in the bundle, so there is nothing to save by holding them back.
+ *
+ * `applied` is what stops the injection feeding itself. A write raises a store
+ * event; the event repaints everything subscribed to this instance, including
+ * the component that owns the `plugins` array — the collection editor and SaaS
+ * plugin hooks both call `useTranslation` — and that array is an inline literal,
+ * so its fresh identity re-runs the effect that called this. react-i18next
+ * happens to stop re-rendering after one pass, but that is a bail-out rather
+ * than a guarantee, and the redundant writes are worth avoiding regardless.
+ *
+ * Returns a function that reports whether the caller is still mounted, so a
+ * bundle that arrives after unmount is dropped rather than written.
+ */
+export declare function applyPluginTranslations({ i18n, plugins, language, applied, isActive }: {
+    i18n: i18n;
+    plugins?: FireCMSPlugin<any, any, any>[];
+    language: string;
+    applied: AppliedBundles;
+    isActive?: () => boolean;
+}): void;

package/dist/core/pro_plugins.d.ts

@@ -0,0 +1,40 @@
+import { AccessResponse, FireCMSPlugin } from "../types";
+/**
+ * Keys of the plugins that need a FireCMS PRO license.
+ *
+ * Kept in sync by hand with `PRO_PLUGIN_KEYS` in
+ * `saas_backend/functions/src/business_rules/licenses.ts`, which decides from
+ * the same list whether a project needs a license. Change both together.
+ *
+ * @group Core
+ */
+export declare const PRO_PLUGIN_KEYS: readonly string[];
+/**
+ * Whether PRO features are paused for this license status. Any `blocked`
+ * response pauses them, whatever its `licenseState` (`expired` and
+ * `invalid_project` both come with it). An unknown status pauses nothing.
+ *
+ * @group Core
+ */
+export declare function isProPaused(licenseStatus?: AccessResponse | null): boolean;
+/**
+ * Whether this plugin is dropped while PRO is paused.
+ *
+ * @group Core
+ */
+export declare function isPausedPlugin(plugin: Pick<FireCMSPlugin, "key">): boolean;
+/**
+ * Where to get or fix the license for this status: the server's
+ * `subscribeUrl` when it is an https URL, otherwise the license page on
+ * app.firecms.co with the project, when known.
+ *
+ * @group Core
+ */
+export declare function getLicenseSubscribeUrl(licenseStatus?: AccessResponse | null): string;
+/**
+ * The plugins that stay active under this license status. Returns the same
+ * array when nothing is dropped, so it can feed memo and effect dependencies.
+ *
+ * @group Core
+ */
+export declare function filterPausedPlugins<P extends Pick<FireCMSPlugin, "key">>(plugins: P[] | undefined, licenseStatus?: AccessResponse | null): P[] | undefined;