@rebasepro/types 0.10.0 → 0.10.1-canary.0a881d4

package/src/types/entity_actions.tsx

@@ -1,125 +0,0 @@
-import React from "react";
-import type { Entity } from "./entities";
-import type { CollectionConfig, SelectionController } from "./collections";
-import type { FormContext } from "./entity_views";
-import type { User } from "../users";
-import type { RebaseContext } from "../rebase_context";
-import type { SidePanelController } from "../controllers/side_panel_controller";
-
-/**
- * A entity action is a custom action that can be performed on a entity.
- * They are displayed in the entity view and in the collection view.
- */
-export interface EntityAction<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> {
-    /**
-     * Title of the action
-     */
-    name: string;
-
-    /**
-     * Key of the action. You only need to provide this if you want to
-     * override the default actions, or if you are not passing the action
-     * directly to the `entityActions` prop of a collection.
-     * You can define your actions at the app level, in which case you
-     * must provide a key.
-     * The default actions are:
-     * - edit
-     * - delete
-     * - copy
-     */
-    key?: string;
-
-    /**
-     * Icon of the action
-     */
-    icon?: React.ReactElement;
-
-    /**
-     * Callback when the action is clicked
-     * @param props
-     */
-    onClick(props: EntityActionClickProps<M, USER>): Promise<void> | void;
-
-    /**
-     * Optional callback in case you want to disable the action
-     * @param props
-     */
-    isEnabled?(props: EntityActionClickProps<M, USER>): boolean;
-
-    /**
-     * When true, this action is rendered inline on each row in the list view.
-     * By default, entity actions only appear in the table view and entity form.
-     * Use this for actions that should be easily accessible regardless of view mode.
-     */
-    showActionsInListView?: boolean;
-
-    /**
-     * Show this action collapsed in the menu of the collection view.
-     * Defaults to true
-     * If false, the action will be shown in the menu
-     */
-    collapsed?: boolean;
-
-    /**
-     * Show this action in the form, defaults to true
-     */
-    includeInForm?: boolean;
-
-}
-
-export type EntityActionClickProps<M extends Record<string, unknown>, USER extends User = User> = {
-    entity?: Entity<M>;
-    context?: RebaseContext<USER>;
-
-    path?: string;
-    collection?: CollectionConfig<M>;
-
-    /**
-     * Optional form context, present if the action is being called from a form.
-     * This allows you to access the form state and methods, including modifying the form values.
-     */
-    formContext?: FormContext;
-
-    /**
-     * Present if this actions is being called from a side dialog only
-     */
-    sidePanelController?: SidePanelController;
-
-    /**
-     * Is the action being called from the collection view or from the entity form view?
-     */
-    view: "collection" | "form";
-
-    /**
-     * If the action is rendered in the form, is it open in a side panel or full screen?
-     */
-    openEntityMode?: "side_panel" | "full_screen" | "split" | "dialog";
-
-    /**
-     * Optional selection controller, present if the action is being called from a collection view
-     */
-    selectionController?: SelectionController;
-
-    /**
-     * Optional highlight function to highlight the entity in the collection view
-     * @param entity
-     */
-    highlightEntity?: (entity: Entity<Record<string, unknown>>) => void;
-
-    /**
-     * Optional unhighlight function to remove the highlight from the entity in the collection view
-     * @param entity
-     */
-    unhighlightEntity?: (entity: Entity<Record<string, unknown>>) => void;
-
-    /**
-     * Optional function to navigate back (e.g. when deleting a entity or navigating from a form)
-     */
-    navigateBack?: () => void;
-
-    /**
-     * Callback to be called when the collection changes, e.g. after a entity is deleted or created.
-     */
-    onCollectionChange?: () => void;
-
-};

package/src/types/entity_link_builder.ts

@@ -1,8 +0,0 @@
-import { Entity } from "./entities";
-
-/**
- * @group Models
- */
-export type EntityLinkBuilder<M extends Record<string, unknown> = Record<string, unknown>> = ({ entity }: {
-    entity: Entity<M>
-}) => string;

package/src/types/entity_views.tsx

@@ -1,114 +0,0 @@
-import React from "react";
-import type { Entity, EntityValues } from "./entities";
-import type { CollectionConfig } from "./collections";
-import type { FormexController } from "./formex";
-import type { ComponentRef } from "./component_ref";
-
-/**
- * Context passed to custom fields and entity views.
- * @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
-     */
-    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?: CollectionConfig<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";
-
-    /**
-     * The underlying formex controller that powers the form.
-     */
-    formex: FormexController<M>;
-
-    disabled: boolean;
-
-    /**
-     * Whether the form context is in read-only detail view mode.
-     * Custom entity views can use this to adjust their rendering.
-     */
-    readOnly?: boolean;
-}
-
-
-export type EntityCustomView<M extends Record<string, unknown> = Record<string, unknown>> = {
-    key: string;
-    name: string;
-    icon?: string | React.ReactNode;
-    tabComponent?: React.ReactNode;
-    includeActions?: boolean | "bottom";
-    Builder?: ComponentRef<EntityCustomViewParams<M>>;
-    position?: "start" | "end";
-};
-
-/**
- * Configuration to replace the default entity form with a custom component.
- * The Builder receives the same props as entity view tabs (entity, formContext, etc.)
- * and has full control over the UI.
- *
- * The form tab still appears in the tab bar but renders your Builder
- * instead of the auto-generated field form.
- *
- * @group Models
- */
-export type FormViewConfig<M extends Record<string, unknown> = Record<string, unknown>> = {
-    /**
-     * Custom component that replaces the default form.
-     */
-    Builder: ComponentRef<EntityCustomViewParams<M>>;
-    /**
-     * If true, the save/delete action bar is rendered alongside the custom view.
-     * Defaults to true.
-     */
-    includeActions?: boolean;
-};
-
-export interface EntityCustomViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
-    collection: CollectionConfig<M>;
-    entity?: Entity<M>;
-    modifiedValues?: EntityValues<M>;
-    formContext: FormContext<M>;
-    parentCollectionSlugs?: string[];
-    parentEntityIds?: string[];
-}

package/src/types/export_import.ts

@@ -1,26 +0,0 @@
-import type { Entity } from "./entities";
-import type { User } from "../users";
-import type { RebaseContext } from "../rebase_context";
-
-/**
- * You can use this configuration to add additional fields to the data
- * exports
- * @group Models
- */
-export interface ExportConfig<USER extends User = User> {
-    additionalFields: ExportMappingFunction<USER>[];
-}
-
-/**
- * @group Models
- */
-export interface ExportMappingFunction<USER extends User = User> {
-    key: string;
-    builder: ({
-        entity,
-        context
-    }: {
-        entity: Entity,
-        context: RebaseContext<USER>
-    }) => Promise<string> | string;
-}

package/src/types/formex.ts

@@ -1,45 +0,0 @@
-import React, { FormEvent } from "react";
-
-export type FormexController<T = unknown> = {
-    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 = unknown> = {
-    values?: T;
-    submitCount?: number;
-    errors?: Record<string, string>;
-    touched?: Record<string, boolean>;
-};

package/src/types/locales.ts

@@ -1,81 +0,0 @@
-/**
- * @group Models
- */
-export type Locale =
-    "af" |
-    "ar" |
-    "arDZ" |
-    "arMA" |
-    "arSA" |
-    "az" |
-    "be" |
-    "bg" |
-    "bn" |
-    "ca" |
-    "cs" |
-    "cy" |
-    "da" |
-    "de" |
-    "el" |
-    "enAU" |
-    "enCA" |
-    "enGB" |
-    "enIN" |
-    "enNZ" |
-    "enUS" |
-    "eo" |
-    "es" |
-    "et" |
-    "eu" |
-    "faIR" |
-    "fi" |
-    "fil" |
-    "fr" |
-    "frCA" |
-    "frCH" |
-    "gd" |
-    "gl" |
-    "gu" |
-    "he" |
-    "hi" |
-    "hr" |
-    "hu" |
-    "hy" |
-    "id" |
-    "is" |
-    "it" |
-    "ja" |
-    "ka" |
-    "kk" |
-    "kn" |
-    "ko" |
-    "lb" |
-    "lt" |
-    "lv" |
-    "mk" |
-    "ms" |
-    "mt" |
-    "nb" |
-    "nl" |
-    "nlBE" |
-    "nn" |
-    "pl" |
-    "pt" |
-    "ptBR" |
-    "ro" |
-    "ru" |
-    "sk" |
-    "sl" |
-    "sr" |
-    "srLatn" |
-    "sv" |
-    "ta" |
-    "te" |
-    "th" |
-    "tr" |
-    "ug" |
-    "uk" |
-    "uz" |
-    "vi" |
-    "zhCN" |
-    "zhTW";

package/src/types/modify_collections.tsx

@@ -1,6 +0,0 @@
-import { CollectionConfig } from "./collections";
-
-export type ModifyCollectionProps = {
-    collection: CollectionConfig,
-    parentPaths: string[],
-};