@firecms/core 3.4.0-canary.0ef7442 → 3.4.0-canary.1faa2a9

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/EntityCollectionView/EntityCollectionView.d.ts

@@ -16,8 +16,9 @@ export type EntityCollectionViewProps<M extends Record<string, any>> = {
     /**
      * `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 "/".
+     *
+     * 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[];
     /**

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/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/common/useDataSourceTableController.d.ts

@@ -7,8 +7,10 @@ export type DataSourceTableControllerProps<M extends Record<string, any> = any>
     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 "/".
+     * 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[];
     /**

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

@@ -2,6 +2,8 @@ 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
@@ -10,7 +12,7 @@ export interface UseTableSearchHelperParams<M extends Record<string, any>> {
      */
     initialSearchString?: string;
 }
-export declare function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds, initialSearchString }: 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>;

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;