@rebasepro/plugin-data-enhancement 0.2.1 → 0.2.3

package/dist/admin/src/preview/util.d.ts

@@ -0,0 +1,7 @@
+import { CollectionSize } from "@rebasepro/types";
+import type { PreviewSize } from "../types/components/PropertyPreviewProps";
+export declare const SMALL_THUMBNAIL = 40;
+export declare const MEDIUM_THUMBNAIL = 100;
+export declare const LARGE_THUMBNAIL = 200;
+export declare function getThumbnailMeasure(size: PreviewSize): number;
+export declare function getPreviewSizeFrom(size: CollectionSize): PreviewSize;

package/dist/admin/src/routes/CustomViewRoute.d.ts

@@ -0,0 +1,4 @@
+import type { AppView } from "@rebasepro/types";
+export declare function CustomViewRoute({ view }: {
+    view: AppView;
+}): import("react").ReactNode;

package/dist/admin/src/routes/RebaseRoute.d.ts

@@ -0,0 +1 @@
+export declare function RebaseRoute(): import("react/jsx-runtime").JSX.Element | null;

package/dist/admin/src/routes/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./CustomViewRoute";
+export * from "./RebaseRoute";

package/dist/admin/src/types/components/EntityFormActionsProps.d.ts

@@ -0,0 +1,19 @@
+import { Entity } from "@rebasepro/types";
+import { EntityCollection } from "@rebasepro/types";
+import { FormContext } from "../fields";
+import { FormexController } from "./formex";
+export interface EntityFormActionsProps {
+    path: string;
+    collection: EntityCollection;
+    entity?: Entity;
+    layout: "bottom" | "side" | "responsive";
+    savingError?: Error;
+    formex: FormexController<any>;
+    disabled: boolean;
+    status: "new" | "existing" | "copy";
+    pluginActions: React.ReactNode[];
+    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
+    showDefaultActions?: boolean;
+    navigateBack: () => void;
+    formContext: FormContext;
+}

package/dist/admin/src/types/components/EntityFormProps.d.ts

@@ -0,0 +1,49 @@
+import { Entity, EntityStatus } from "@rebasepro/types";
+import { EntityCollection, EntityCustomViewParams } from "@rebasepro/types";
+import { FormContext } from "../fields";
+import { FormexController } from "./formex";
+import { EntityFormActionsProps } from "./EntityFormActionsProps";
+export type EntityFormProps<M extends Record<string, unknown>> = {
+    path: string;
+    fullIdPath?: string;
+    collection: EntityCollection<M>;
+    entityId?: string | number;
+    entity?: Entity<M>;
+    databaseId?: string;
+    onIdChange?: (id: string | number) => void;
+    onValuesModified?: (modified: boolean, values: M) => void;
+    onSaved?: (params: OnUpdateParams) => void;
+    initialDirtyValues?: Partial<M>;
+    onFormContextReady?: (formContext: FormContext<M>) => void;
+    forceActionsAtTheBottom?: boolean;
+    className?: string;
+    initialStatus: EntityStatus;
+    onStatusChange?: (status: EntityStatus) => void;
+    onEntityChange?: (entity: Entity<M>) => void;
+    formex?: FormexController<M>;
+    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
+    /**
+     * If true, the form will be disabled and no actions will be available
+     */
+    disabled?: boolean;
+    /**
+     * Include the copy and delete actions in the form
+     */
+    showDefaultActions?: boolean;
+    /**
+     * Display the entity path in the form
+     */
+    showEntityPath?: boolean;
+    EntityFormActionsComponent?: React.FC<EntityFormActionsProps>;
+    navigateBack?: () => void;
+    Builder?: React.ComponentType<EntityCustomViewParams<M>>;
+    children?: React.ReactNode;
+};
+export type OnUpdateParams = {
+    entity: Entity<any>;
+    status: EntityStatus;
+    path: string;
+    entityId?: string | number;
+    selectedTab?: string;
+    collection: EntityCollection<any>;
+};

package/dist/admin/src/types/components/PropertyPreviewProps.d.ts

@@ -0,0 +1,47 @@
+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: 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;
+}

package/dist/admin/src/types/components/formex.d.ts

@@ -0,0 +1,40 @@
+import React, { FormEvent } from "react";
+export type FormexController<T extends object> = {
+    values: T;
+    initialValues: T;
+    setValues: (values: T) => void;
+    setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
+    touched: Record<string, boolean>;
+    setFieldTouched: (key: string, touched: boolean, shouldValidate?: boolean) => void;
+    setTouched: (touched: Record<string, boolean>) => void;
+    dirty: boolean;
+    setDirty: (dirty: boolean) => void;
+    setSubmitCount: (submitCount: number) => void;
+    errors: Record<string, string>;
+    setFieldError: (key: string, error?: string) => void;
+    handleChange: (event: React.SyntheticEvent) => void;
+    handleBlur: (event: React.FocusEvent) => void;
+    handleSubmit: (event?: FormEvent<HTMLFormElement>) => void;
+    validate: () => void;
+    resetForm: (props?: FormexResetProps<T>) => void;
+    submitCount: number;
+    isSubmitting: boolean;
+    setSubmitting: (isSubmitting: boolean) => void;
+    isValidating: boolean;
+    /**
+     * The version of the form. This is incremented every time the form is reset
+     * or the form is submitted.
+     */
+    version: number;
+    debugId?: string;
+    undo: () => void;
+    redo: () => void;
+    canUndo: boolean;
+    canRedo: boolean;
+};
+export type FormexResetProps<T extends object> = {
+    values?: T;
+    submitCount?: number;
+    errors?: Record<string, string>;
+    touched?: Record<string, boolean>;
+};

package/dist/admin/src/types/components/index.d.ts

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

package/dist/admin/src/types/fields.d.ts

@@ -0,0 +1,221 @@
+import { Entity } from "@rebasepro/types";
+import { FormexController } from "./components/formex";
+import { EntityCollection } from "@rebasepro/types";
+import { Property } from "@rebasepro/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_as_string" | "reference" | "multi_references" | "relation" | "date_time" | "group" | "key_value" | "repeat" | "custom_array" | "block" | "vector_input";
+/**
+ * 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 = any, M extends Record<string, any> = any> {
+    /**
+     * 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: any;
+    /**
+     * Set value of field directly
+     */
+    setValue: (value: any | null, 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;
+    /**
+     * 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;
+    /**
+     * Save the entity.
+     */
+    save: (values: M) => void;
+    /**
+     * Collection of the entity being modified
+     */
+    collection?: EntityCollection<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;
+}
+/**
+ * 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 CMS 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;
+    /**
+     * 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/dist/admin/src/types/index.d.ts

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

package/dist/admin/src/util/entity_actions.d.ts

@@ -0,0 +1,2 @@
+import type { EntityAction } from "@rebasepro/types";
+export declare function mergeEntityActions(currentActions: EntityAction[], newActions: EntityAction[]): EntityAction[];

package/dist/admin/src/util/index.d.ts

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

package/dist/admin/src/util/navigation_utils.d.ts

@@ -0,0 +1,26 @@
+import type { EntityCollection, UrlController, SideEntityController } from "@rebasepro/types";
+export { removeInitialAndTrailingSlashes, removeInitialSlash, removeTrailingSlash, addInitialSlash, getLastSegment, resolveCollectionPathIds, getCollectionBySlugWithin, getCollectionPathsCombinations } from "@rebasepro/common";
+/**
+ * Navigate to an entity using either a side panel or full-screen mode.
+ * This is an admin-specific UI concern and lives here (not in common).
+ */
+export declare function navigateToEntity({ openEntityMode, collection, entityId, copy, path, selectedTab, defaultValues, sideEntityController, onClose, navigation }: {
+    openEntityMode: "side_panel" | "full_screen" | "split" | "dialog";
+    collection?: EntityCollection;
+    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 EntitySidePanelProps → EntityEditView.
+     * 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;
+    sideEntityController: SideEntityController;
+    onClose?: () => void;
+    navigation: UrlController;
+}): void;

package/dist/admin/src/util/previews.d.ts

@@ -0,0 +1,4 @@
+import type { EntityCollection, PropertyConfig } from "@rebasepro/types";
+import { AuthController } from "@rebasepro/types";
+export declare function getEntityPreviewKeys(authController: AuthController, targetCollection: EntityCollection<any>, fields: Record<string, PropertyConfig>, previewProperties?: string[], limit?: number): string[];
+export declare function getEntityTitlePropertyKey<M extends Record<string, unknown>>(collection: EntityCollection<M>, propertyConfigs: Record<string, PropertyConfig>): string | undefined;

package/dist/admin/src/util/property_utils.d.ts

@@ -0,0 +1,25 @@
+import type { Properties } from "@rebasepro/types";
+import type { EntityCollection, Property, PropertyConfig } from "@rebasepro/types";
+import React from "react";
+import type { IconSize } from "@rebasepro/ui";
+export declare function isReferenceProperty(property: Property): boolean | null;
+export declare function isRelationProperty(property: Property): boolean | null;
+export declare function getIconForWidget(widget: PropertyConfig | undefined, size: IconSize | number): import("react/jsx-runtime").JSX.Element;
+export declare function getIconForProperty(property: Property, size?: IconSize | number, fields?: Record<string, PropertyConfig>): React.ReactNode;
+/**
+ * Get a property in a property tree from a path like
+ * `address.street`
+ * @param properties
+ * @param path
+ */
+export declare function getPropertyInPath(properties: Properties, path: string): Property | undefined;
+export declare function getResolvedPropertyInPath(properties: Record<string, Property>, path: string): Property | undefined;
+export declare function getBracketNotation(path: string): string;
+/**
+ * Get properties sorted by their order, but include ALL properties.
+ * Nested keys (like "data.mode") in propertiesOrder are ignored - they're for column ordering.
+ * @param properties
+ * @param propertiesOrder
+ */
+export declare function getPropertiesWithPropertiesOrder(properties: Properties, propertiesOrder?: string[]): Properties;
+export declare function getDefaultPropertiesOrder(collection: EntityCollection): string[];

package/dist/admin/src/util/resolutions.d.ts

@@ -0,0 +1,9 @@
+import type { EntityCustomView } from "@rebasepro/types";
+import type { CustomizationController, EntityAction } from "@rebasepro/types";
+export declare function resolveEntityView(entityView: string | EntityCustomView<any>, contextEntityViews?: EntityCustomView<any>[]): EntityCustomView<any> | undefined;
+export declare function resolveEntityAction<M extends Record<string, unknown>>(entityAction: string | EntityAction<M>, contextEntityActions?: EntityAction<M>[]): EntityAction<M> | undefined;
+export declare function resolvedSelectedEntityView<M extends Record<string, unknown>>(customViews: (string | EntityCustomView<M>)[] | undefined, customizationController: CustomizationController, selectedTab?: string, _canEdit?: boolean): {
+    resolvedEntityViews: EntityCustomView[];
+    selectedEntityView: EntityCustomView | undefined;
+    selectedSecondaryForm: EntityCustomView | undefined;
+};

package/dist/common/src/data/query_builder.d.ts

@@ -0,0 +1,51 @@
+import { FindResponse, CollectionAccessor, QueryBuilderInterface, FilterOperator } from "@rebasepro/types";
+export declare class QueryBuilder<M extends Record<string, unknown> = Record<string, unknown>> implements QueryBuilderInterface<M> {
+    private collection;
+    private params;
+    constructor(collection: CollectionAccessor<M>);
+    /**
+     * Add a filter condition to your query.
+     * @example
+     * client.collection('users').where('age', '>=', 18).find()
+     */
+    where(column: keyof M & string, operator: FilterOperator, value: unknown): this;
+    /**
+     * Order the results by a specific column.
+     * @example
+     * client.collection('users').orderBy('createdAt', 'desc').find()
+     */
+    orderBy(column: keyof M & string, ascending?: "asc" | "desc"): this;
+    /**
+     * Limit the number of results returned.
+     */
+    limit(count: number): this;
+    /**
+     * Skip the first N results.
+     */
+    offset(count: number): this;
+    /**
+     * Set a free-text search string if supported by the backend.
+     */
+    search(searchString: string): this;
+    /**
+     * Include related entities in the response.
+     * Relations will be populated with full entity data instead of just IDs.
+     *
+     * @param relations - Relation names to include, or "*" for all.
+     * @example
+     * // Include specific relations
+     * client.data.posts.include("tags", "author").find()
+     *
+     * // Include all relations
+     * client.data.posts.include("*").find()
+     */
+    include(...relations: string[]): this;
+    /**
+     * Execute the find query and return the results.
+     */
+    find(): Promise<FindResponse<M>>;
+    /**
+     * Listen to realtime updates matching this query.
+     */
+    listen(onUpdate: (data: FindResponse<M>) => void, onError?: (error: Error) => void): () => void;
+}

package/dist/common/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./util";
 export * from "./collections";
 export * from "./data/buildRebaseData";
+export * from "./data/query_builder";

package/dist/types/src/controllers/data.d.ts

@@ -76,6 +76,21 @@ export interface FindResponse<M extends Record<string, unknown> = Record<string,
         hasMore: boolean;
     };
 }
+export type FilterOperator = WhereFilterOpShort;
+/**
+ * Fluent Query Builder Interface supported on both client and server accessors.
+ * @group Data
+ */
+export interface QueryBuilderInterface<M extends Record<string, unknown> = Record<string, unknown>> {
+    where(column: keyof M & string, operator: FilterOperator, value: unknown): this;
+    orderBy(column: keyof M & string, ascending?: "asc" | "desc"): this;
+    limit(count: number): this;
+    offset(count: number): this;
+    search(searchString: string): this;
+    include(...relations: string[]): this;
+    find(): Promise<FindResponse<M>>;
+    listen(onUpdate: (data: FindResponse<M>) => void, onError?: (error: Error) => void): () => void;
+}
 /**
  * A single collection's CRUD accessor.
  *
@@ -124,6 +139,12 @@ export interface CollectionAccessor<M extends Record<string, unknown> = Record<s
      * Count the number of records matching the given filter.
      */
     count?(params?: FindParams): Promise<number>;
+    where(column: keyof M & string, operator: FilterOperator, value: unknown): QueryBuilderInterface<M>;
+    orderBy(column: keyof M & string, ascending?: "asc" | "desc"): QueryBuilderInterface<M>;
+    limit(count: number): QueryBuilderInterface<M>;
+    offset(count: number): QueryBuilderInterface<M>;
+    search(searchString: string): QueryBuilderInterface<M>;
+    include(...relations: string[]): QueryBuilderInterface<M>;
 }
 /**
  * The unified data access object.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/plugin-data-enhancement",
   "type": "module",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
@@ -16,12 +16,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@rebasepro/common": "0.2.1",
-    "@rebasepro/admin": "0.2.1",
-    "@rebasepro/core": "0.2.1",
-    "@rebasepro/types": "0.2.1",
-    "@rebasepro/utils": "0.2.1",
-    "@rebasepro/ui": "0.2.1"
+    "@rebasepro/admin": "0.2.3",
+    "@rebasepro/common": "0.2.3",
+    "@rebasepro/types": "0.2.3",
+    "@rebasepro/ui": "0.2.3",
+    "@rebasepro/core": "0.2.3",
+    "@rebasepro/utils": "0.2.3"
   },
   "peerDependencies": {
     "react": ">=19.0.0",
@@ -77,6 +77,11 @@
     "access": "public"
   },
   "gitHead": "d935eefa5aa8d1009a2398cfac2c1e4ee9aeb6b6",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rebasepro/rebase.git",
+    "directory": "packages/plugin-data-enhancement"
+  },
   "scripts": {
     "dev": "vite",
     "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",