@rebasepro/cms 0.17.3 → 0.18.0

package/src/types/components/PropertyPreviewProps.tsx

@@ -1,85 +0,0 @@
-import { InferPropertyType } from "@rebasepro/types";
-import { Property } from "@rebasepro/types";
-
-/**
- * @group Preview components
- */
-export type PreviewSize = "small" | "medium" | "large";
-
-/**
- * @group Preview components
- */
-export interface PropertyPreviewProps<P extends Property | Property, CustomProps = unknown> {
-    /**
-     * Name of the property
-     */
-    propertyKey?: string;
-
-    value: InferPropertyType<P> | any;
-
-    /**
-     * Property this display is related to, now strongly typed to P
-     */
-    property: P;
-
-    /**
-     * 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;
-
-    /**
-     * If the preview should be interactive or not.
-     * This applies only to videos.
-     */
-    interactive?: boolean;
-
-    /**
-     * If true, image previews will fill their container completely.
-     * Only applies to image type properties.
-     */
-    fill?: boolean;
-
-    /**
-     * If true, relations/references will render as plain text strings rather than full cards.
-     */
-    textOnly?: boolean;
-
-    /**
-     * The preview has one line and cannot grow — it fills a slot in a card, a
-     * chip, or a table cell of fixed height.
-     *
-     * Properties whose natural rendering is a block (Markdown, multi-line text,
-     * maps, arrays) render a one-line stand-in instead: an opening excerpt, or
-     * a count. Left unset, {@link PropertyPreview} infers it from the entity
-     * preview nesting depth, which is where the constraint actually comes from;
-     * pass it explicitly only to force the compact form somewhere the nesting
-     * does not say so.
-     */
-    compact?: boolean;
-
-    /**
-     * The caller has already labelled this value, so the preview must not
-     * repeat the property name. A boolean is the one that does: it renders its
-     * name beside the checkbox, which reads as a caption in a table cell and as
-     * a stutter under a field label — "VIP" over a checkbox saying "VIP".
-     */
-    hideLabel?: boolean;
-
-}

package/src/types/components/formex.tsx

@@ -1,2 +0,0 @@
-export type { FormexController, FormexResetProps } from "@rebasepro/forms";
-

package/src/types/components/index.ts

@@ -1,3 +0,0 @@
-export * from "./PropertyPreviewProps";
-export * from "./EntityFormProps";
-export * from "./EntityFormActionsProps";

package/src/types/fields.tsx

@@ -1,340 +0,0 @@
-import { InferPropertyType } from "@rebasepro/types";
-import { Entity } from "@rebasepro/types";
-import { FormexController } from "./components/formex";
-
-import { Property } from "@rebasepro/types";
-import type { AdminCollection } from "@rebasepro/cms-types";
-
-export type DefaultFieldConfig =
-    | "text_field"
-    | "multiline"
-    | "markdown"
-    | "url"
-    | "email"
-    | "switch"
-    | "select"
-    | "multi_select"
-    | "user_select"
-    | "number_input"
-    | "number_select"
-    | "multi_number_select"
-    | "file_upload"
-    | "multi_file_upload"
-    | "reference"
-    | "multi_references"
-    | "relation"
-    | "date_time"
-    | "group"
-    | "key_value"
-    | "repeat"
-    | "custom_array"
-    | "block"
-    | "vector_input"
-    | "geopoint"
-    | "binary";
-
-/**
- * When building a custom field you need to create a React component that takes
- * this interface as props.
- *
- * @group Form custom fields
- */
-export interface FieldProps<
-    P extends Property | Property = Property,
-    CustomProps = unknown,
-    M extends Record<string, unknown> = Record<string, unknown>> {
-
-    /**
-     * Key of the property
-     * E.g. "user.name" for a property with path "user.name"
-     */
-    propertyKey: string;
-
-    /**
-     * Current value of this field, inferred from the property type P
-     */
-    value: InferPropertyType<P> | any;
-    setValue: (value: InferPropertyType<P> | null | any, shouldValidate?: boolean) => void;
-
-    /**
-     * Set value of a different field directly
-     * @param propertyKey
-     * @param value
-     * @param shouldValidate
-     */
-    setFieldValue: (propertyKey: string, value: unknown, shouldValidate?: boolean) => void;
-
-    /**
-     * Is the form currently submitting
-     */
-    isSubmitting?: boolean;
-
-    /**
-     * Should this field show the error indicator.
-     * Note that there might be an error (like an empty field that should be
-     * filled) but we don't want to show the error until the user has tried
-     * saving.
-     */
-    showError?: boolean;
-
-    /**
-     * Is there an error in this field. The error field has the same shape as
-     * the field, replacing values with a string containing the error.
-     * It takes the value `null` if there is no error
-     */
-    error?: string;
-
-    /**
-     * Has this field been touched
-     */
-    touched?: boolean;
-
-    /**
-     * Property related to this field, now strongly typed to P
-     */
-    property: P;
-
-    /**
-     * Should this field include a description
-     */
-    includeDescription?: boolean;
-
-    /**
-     * The container is rendering the label and the description itself, so this
-     * field should render only its control.
-     *
-     * This is what the generated form sets. Field types used to disagree about
-     * where a label goes — text and number put it inside the input, select,
-     * array, storage and read-only put it above — which read as two design
-     * systems in one column. The label now belongs to the form, and the binding
-     * to the control.
-     *
-     * A custom field that ignores this still renders its own label, so it
-     * degrades to the old look rather than losing its label.
-     */
-    hideLabel?: boolean;
-
-    /**
-     * Flag to indicate that the underlying value has been updated in the
-     * driver
-     */
-    underlyingValueHasChanged?: boolean;
-
-    /**
-     * Is this field part of an array
-     */
-    partOfArray?: boolean;
-
-    /**
-     * Is this field part of a block
-     */
-    partOfBlock?: boolean;
-
-    /**
-     * Display the child properties directly, without being wrapped in an
-     * extendable panel. Note that this will also hide the title of this property.
-     */
-    minimalistView?: boolean;
-
-    /**
-     * Should this field autofocus on mount
-     */
-    autoFocus?: boolean;
-
-    /**
-     * Additional properties set by the developer
-     */
-    customProps?: CustomProps;
-
-    /**
-     * Additional values related to the state of the form or the entity
-     */
-    context: FormContext<M>;
-
-    /**
-     * Flag to indicate if this field should be disabled
-     */
-    disabled?: boolean;
-
-    /**
-     * Size of the field
-     */
-    size?: "small" | "medium" | "large";
-
-    /**
-     * Some properties might change internal state (like expanding a panel).
-     * This function should be called when the internal state changes.
-     * This is used to preserve state in array containers.
-     *
-     * @param property
-     */
-    onPropertyChange?: (property: Partial<Property>) => void;
-
-}
-
-/**
- * Context passed to custom fields
- * @group Form custom fields
- */
-export interface FormContext<M extends Record<string, unknown> = Record<string, unknown>> {
-
-    /**
-     * Current values of the entity
-     */
-    values: M;
-
-    /**
-     * Update the value of a field
-     * @param key
-     * @param value
-     * @param shouldValidate
-     */
-    setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
-
-    /**
-     * Quietly persist the entity to the database without any UI feedback
-     * (no validation, no snackbar, no form reset).
-     * Use this for programmatic/background saves from custom views.
-     */
-    save: (values: M) => void;
-
-    /**
-     * Submit the form — validates, saves, resets the form, and shows
-     * a success snackbar. This is what the Save button calls.
-     * Use this from custom views when you want the full "user saved" experience.
-     */
-    submit: () => void;
-
-    /**
-     * Collection of the entity being modified
-     */
-    collection?: AdminCollection<M>;
-
-    /**
-     * Entity id, it can be undefined if it's a new entity
-     */
-    entityId?: string | number;
-
-    /**
-     * Path this entity is located at
-     */
-    path?: string;
-
-    status: "new" | "existing" | "copy";
-
-    entity?: Entity<M>;
-
-    savingError?: Error;
-
-    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
-
-    /**
-     * This is the underlying formex controller that powers the form.
-     * If you are in a red only mode, the formex controller is there, but you can't
-     * operate with it
-     */
-    formex: FormexController<M>;
-
-    disabled: boolean;
-
-    /**
-     * A save is in flight, including the autosave debounce, which `formex`
-     * cannot report because it never goes through `handleSubmit`.
-     */
-    isSaving?: boolean;
-
-    /**
-     * Whether the form context is in read-only detail view mode.
-     * Custom entity views can use this to adjust their rendering.
-     */
-    readOnly?: boolean;
-}
-
-/**
- * In case you need to render a field bound to a Property inside your
- * custom field you can use {@link PropertyFieldBinding} with these props.
- * @group Form custom fields
- */
-export interface PropertyFieldBindingProps<M extends Record<string, unknown> = Record<string, unknown>> {
-
-    /**
-     * The key/path of the property, such as `age`. You can use nested and array
-     * indexed such as `address.street` or `people[3]`
-     */
-    propertyKey: string;
-
-    /**
-     * The admin property you are binding this field to
-     */
-    property: Property;
-
-    /**
-     * The context where this field is being rendered. You get a context as a
-     * prop when creating a custom field.
-     */
-    context: FormContext<M>;
-
-    /**
-     * Should the description be included in this field
-     */
-    includeDescription?: boolean;
-
-    /**
-     * The container renders the label and description; render only the control.
-     * See the note on {@link FieldProps.hideLabel}.
-     */
-    hideLabel?: boolean;
-
-    /**
-     * Has the value of this property been updated in the database while this
-     * field is being edited
-     */
-    underlyingValueHasChanged?: boolean;
-
-    /**
-     * Is this field part of an array
-     */
-    partOfArray?: boolean;
-
-    /**
-     * Is this field part of a block
-     */
-    partOfBlock?: boolean;
-
-    /**
-     * Display the child properties directly, without being wrapped in an
-     * extendable panel. Note that this will also hide the title of this property.
-     */
-    minimalistView?: boolean;
-
-    /**
-     * Should the field take focus when rendered. When opening the popup view
-     * in table mode, it makes sense to put the focus on the only field rendered.
-     */
-    autoFocus?: boolean;
-
-    /**
-     * Should this field be disabled
-     */
-    disabled?: boolean;
-
-    /**
-     * Index of the field in the array.
-     * Only used when the field is part of an array.
-     */
-    index?: number;
-
-    /**
-     * The size of the field
-     */
-    size?: "small" | "medium" | "large",
-
-    /**
-     * Some properties might change internal state (like expanding a panel).
-     * This function should be called when the internal state changes.
-     * This is used to preserve state in array containers.
-     *
-     * @param property
-     */
-    onPropertyChange?: (property: Partial<Property>) => void;
-}

package/src/types/index.ts

@@ -1,4 +0,0 @@
-export * from "./fields";
-export * from "./components";
-
-

package/src/util/dataControllerAdapter.ts

@@ -1,88 +0,0 @@
-/**
- * Adapts an `EntityTableController<M>` (from @rebasepro/types) to a
- * `CollectionDataController<T>` (from @rebasepro/ui), bridging the
- * entity-aware data layer to the headless collection view.
- */
-
-import { useMemo } from "react";
-import type { Entity } from "@rebasepro/types";
-import type { EntityTableController } from "@rebasepro/cms-types";
-import type { CollectionDataController } from "@rebasepro/ui";
-
-/**
- * Unwrap `Entity<M>` objects to flat rows for the headless view.
- * The entity system uses `{ id, path, values: M }`; `values` is already the
- * flat row `M` carrying its real primary key, so unwrapping is just `.values` —
- * no `id`/`path` merge (those are view-model metadata, not row columns).
- */
-function flattenEntities<M extends Record<string, unknown>>(
-    entities: Entity<M>[]
-): M[] {
-    return entities.map(entity => entity.values);
-}
-
-/**
- * React hook that adapts a EntityTableController to a CollectionDataController.
- *
- * Usage:
- * ```tsx
- * const tableController = useDataTableController({ path, collection });
- * const dataController = useCollectionDataController(tableController);
- *
- * <CollectionView dataController={dataController} ... />
- * ```
- */
-export function useCollectionDataController<M extends Record<string, unknown>>(
-    tableController: EntityTableController<M>
-): CollectionDataController<M> {
-    const flatData = useMemo(
-        () => flattenEntities(tableController.data),
-        [tableController.data]
-    );
-
-    return useMemo((): CollectionDataController<M> => ({
-        data: flatData,
-        loading: tableController.dataLoading,
-        noMoreToLoad: tableController.noMoreToLoad,
-        error: tableController.dataLoadingError,
-
-        filterValues: tableController.filterValues as Record<string, [string, unknown]> | undefined,
-        setFilterValues: tableController.setFilterValues as
-            ((values: Record<string, [string, unknown]> | undefined) => void) | undefined,
-
-        sortBy: tableController.sortBy,
-        setSortBy: tableController.setSortBy,
-
-        searchString: tableController.searchString,
-        setSearchString: tableController.setSearchString,
-
-        clearFilter: tableController.clearFilter,
-
-        initialScroll: tableController.initialScroll,
-        onScroll: tableController.onScroll,
-
-        paginationEnabled: tableController.paginationEnabled,
-        pageSize: tableController.pageSize,
-        itemCount: tableController.itemCount,
-        setItemCount: tableController.setItemCount,
-    }), [flatData, tableController]);
-}
-
-/**
- * Non-hook version for cases where you already have the data
- * and just need to build a static controller.
- */
-export function createStaticDataController<T extends Record<string, unknown>>(
-    data: T[],
-    options?: {
-        loading?: boolean;
-        error?: Error;
-    }
-): CollectionDataController<T> {
-    return {
-        data,
-        loading: options?.loading ?? false,
-        noMoreToLoad: true,
-        error: options?.error,
-    };
-}

package/src/util/entity_actions.ts

@@ -1,28 +0,0 @@
-import type { EntityAction } from "@rebasepro/cms-types";
-
-const reservedKeys = ["edit", "copy", "delete"];
-
-export function mergeEntityActions(currentActions: EntityAction[], newActions: EntityAction[]): EntityAction[] {
-    // given the current actions, replace the ones with the same key
-    // and append the new ones
-    const updatedActions: EntityAction[] = [];
-    currentActions.forEach(action => {
-        const newAction = newActions.find(a => a.key === action.key);
-        if (newAction) {
-            const mergedAction = {
-                ...action,
-                ...newAction
-            }
-            updatedActions.push(mergedAction);
-        } else {
-            updatedActions.push(action);
-        }
-    });
-    newActions.forEach(action => {
-        if (!currentActions.find(a => a.key === action.key) && (!action.key || !reservedKeys.includes(action.key))) {
-            updatedActions.push(action);
-        }
-    });
-    return updatedActions;
-
-}

package/src/util/index.ts

@@ -1,5 +0,0 @@
-export * from "./entity_actions";
-export * from "./navigation_utils";
-export * from "./resolutions";
-export * from "./property_utils";
-export * from "./previews";

package/src/util/navigation_utils.ts

@@ -1,89 +0,0 @@
-
-import type { UrlController, SidePanelController, NavigateOptions, AdminCollection } from "@rebasepro/cms-types";
-import { withListState, withViewMode } from "./view_mode";
-
-// Canonical path utilities — single source of truth in @rebasepro/common
-export { removeInitialAndTrailingSlashes, removeInitialSlash, removeTrailingSlash, addInitialSlash, getLastSegment, resolveCollectionPathIds, getCollectionBySlugWithin, getCollectionPathsCombinations } from "@rebasepro/app";
-
-/**
- * Navigate to a entity using either a side panel or full-screen mode.
- * This is an admin-specific UI concern and lives here (not in common).
- */
-export function navigateToEntity({
-    openEntityMode,
-    collection,
-    entityId,
-    copy,
-    path,
-    selectedTab,
-    defaultValues,
-    sidePanelController,
-    onClose,
-    navigation,
-    replace
-}:
-
-    {
-        openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
-        collection?: AdminCollection;
-        entityId?: string | number;
-        selectedTab?: string;
-        copy?: boolean;
-        /**
-         * Pre-populate the new entity form with these values.
-         * Only applied when entityId is not set (i.e. "new" mode).
-         *
-         * Side panel: passed through SidePanelBindingProps → EditViewBinding.
-         * Full screen: carried via React Router location.state so the route
-         * component can read it on mount without polluting the URL.
-         */
-        defaultValues?: Record<string, unknown>;
-        path: string;
-        sidePanelController: SidePanelController;
-        onClose?: () => void;
-        navigation: UrlController;
-        replace?: boolean;
-    }) {
-
-    if (openEntityMode === "side_panel" || openEntityMode === "dialog") {
-
-        sidePanelController.open({
-            entityId,
-            path: path,
-            copy,
-            selectedTab,
-            collection,
-            updateUrl: openEntityMode !== "dialog",
-            onClose,
-            defaultValues
-        });
-
-    } else {
-        let to = navigation.buildUrlCollectionPath(entityId ? `${path ?? path}/${entityId}` : path ?? path);
-        if (entityId && selectedTab) {
-            to += `/${selectedTab}`;
-        }
-        // The whole list state, not just the view mode: a record opened from a
-        // search must come back to that search.
-        to = withListState(to);
-        if (!entityId) {
-            to += "#new";
-        }
-        if (copy) {
-            to += "#copy";
-        }
-        // Use React Router location.state to carry defaultValues — the correct SPA
-        // approach. No URL size limits, no encoding, nothing in the address bar.
-        // EntityFullScreenRoute reads location.state.defaultValues on mount.
-        const navigateOptions: NavigateOptions = {};
-        if (replace !== undefined) {
-            navigateOptions.replace = replace;
-        }
-        if (defaultValues) {
-            navigateOptions.state = { defaultValues };
-        }
-        const hasOptions = Object.keys(navigateOptions).length > 0;
-        navigation.navigate(to, hasOptions ? navigateOptions : undefined);
-    }
-
-}

package/src/util/number_format.ts

@@ -1,46 +0,0 @@
-import type { NumberFormatOptions } from "@rebasepro/cms-types";
-
-/**
- * Write a number out for reading, per a property's declared `admin.format`.
- *
- * Nothing is inferred here. With no options the number is returned as it came
- * out of the database — `String(value)`, not a locale-grouped rendering — so a
- * panel that declares nothing shows exactly the stored value, and an author who
- * wants thousands separators asks for them.
- *
- * `Intl.NumberFormat` throws on a bad currency code or an out-of-range fraction
- * count, and a record must not blank because one property is misconfigured, so a
- * failure falls back to the raw value.
- */
-export function formatNumber(
-    value: number,
-    options: NumberFormatOptions | undefined,
-    fallbackLocale?: string
-): string {
-
-    if (!options) return String(value);
-
-    // A currency code is the whole declaration in the common case: writing
-    // `{ currency: "EUR" }` and getting a bare `185.11` because `style` was
-    // omitted is a trap, and there is nothing else `currency` could mean.
-    const style = options.style ?? (options.currency ? "currency" : "decimal");
-
-    if (style === "currency" && !options.currency) {
-        // `Intl` throws on this rather than picking a currency, which is the
-        // right call — there is no sensible default — but the record still has
-        // to render.
-        return String(value);
-    }
-
-    try {
-        return new Intl.NumberFormat(options.locale ?? fallbackLocale ?? undefined, {
-            style,
-            currency: options.currency,
-            minimumFractionDigits: options.minimumFractionDigits,
-            maximumFractionDigits: options.maximumFractionDigits,
-            notation: options.notation
-        }).format(value);
-    } catch {
-        return String(value);
-    }
-}