@rebasepro/types 0.0.1-canary.0

package/dist/types/entities.d.ts

@@ -0,0 +1,140 @@
+/**
+ * New or existing status
+ * @group Models
+ */
+export type EntityStatus = "new" | "existing" | "copy";
+/**
+ * Representation of an entity fetched from the datasource
+ * @group Models
+ */
+export interface Entity<M extends object = object> {
+    /**
+     * ID of the entity
+     */
+    id: string | number;
+    /**
+     * A string representing the path of the referenced document (relative
+     * to the root of the database).
+     */
+    path: string;
+    /**
+     * Current values
+     */
+    values: EntityValues<M>;
+    /**
+     * Which datasource this entity belongs to (e.g., 'postgres', 'firestore').
+     * If not specified, the default datasource is assumed.
+     */
+    datasource?: string;
+    /**
+     * Which database within the datasource (e.g., for Firestore multi-database).
+     * If not specified, the default database of the datasource is used.
+     */
+    databaseId?: string;
+}
+/**
+ * This type represents a record of key value pairs as described in an
+ * entity collection.
+ * @group Models
+ */
+export type EntityValues<M extends object> = M;
+/**
+ * Props for creating an EntityReference
+ */
+export interface EntityReferenceProps {
+    /** ID of the entity */
+    id: string;
+    /** Path of the collection (relative to the root of the database) */
+    path: string;
+    /** Which datasource (e.g., 'postgres', 'firestore'). Defaults to "(default)" */
+    datasource?: string;
+    /** Which database within the datasource. Defaults to "(default)" */
+    databaseId?: string;
+}
+/**
+ * Class used to create a reference to an entity in a different path.
+ *
+ * @example
+ * // Simple reference (most common case - single datasource, single db)
+ * new EntityReference({ id: "123", path: "users" })
+ *
+ * // Reference to a different datasource (e.g., Firestore)
+ * new EntityReference({ id: "123", path: "analytics", datasource: "firestore" })
+ *
+ * // Reference to a specific database within a datasource
+ * new EntityReference({ id: "123", path: "orders", datasource: "postgres", databaseId: "orders_db" })
+ */
+export declare class EntityReference {
+    readonly __type = "reference";
+    /**
+     * ID of the entity
+     */
+    readonly id: string;
+    /**
+     * A string representing the path of the referenced document (relative
+     * to the root of the database).
+     */
+    readonly path: string;
+    /**
+     * Which datasource (e.g., 'postgres', 'firestore').
+     * Defaults to "(default)" if not specified.
+     */
+    readonly datasource?: string;
+    /**
+     * Which database within the datasource.
+     * Defaults to "(default)" if not specified.
+     */
+    readonly databaseId?: string;
+    /**
+     * Create a reference to an entity.
+     *
+     * @example
+     * // Simple reference (most common case)
+     * new EntityReference({ id: "123", path: "users" })
+     *
+     * // With datasource
+     * new EntityReference({ id: "123", path: "analytics", datasource: "firestore" })
+     */
+    constructor(props: EntityReferenceProps);
+    get pathWithId(): string;
+    /**
+     * Get the full path including datasource and database prefixes if specified.
+     * For the common case (single datasource, single db), this just returns pathWithId.
+     */
+    get fullPath(): string;
+    isEntityReference(): boolean;
+}
+/**
+ * Class used to create a reference to an entity in a different path
+ */
+export declare class EntityRelation {
+    readonly __type = "relation";
+    /**
+     * ID of the entity
+     */
+    readonly id: string | number;
+    /**
+     * A string representing the path of the referenced document (relative
+     * to the root of the database).
+     */
+    readonly path: string;
+    constructor(id: string | number, path: string);
+    get pathWithId(): string;
+    isEntityReference(): boolean;
+    isEntityRelation(): boolean;
+}
+export declare class GeoPoint {
+    /**
+     * The latitude of this GeoPoint instance.
+     */
+    readonly latitude: number;
+    /**
+     * The longitude of this GeoPoint instance.
+     */
+    readonly longitude: number;
+    constructor(latitude: number, longitude: number);
+}
+export declare class Vector {
+    readonly value: number[];
+    constructor(value: number[]);
+}

package/dist/types/entity_actions.d.ts

@@ -0,0 +1,98 @@
+import React from "react";
+import { Entity } from "./entities";
+import { EntityCollection, SelectionController } from "./collections";
+import { FormContext } from "./fields";
+import { User } from "../users";
+import { RebaseContext } from "../rebase_context";
+import { SideEntityController } from "../controllers";
+/**
+ * An entity action is a custom action that can be performed on an entity.
+ * They are displayed in the entity view and in the collection view.
+ */
+export type EntityAction<M extends object = any, 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;
+    /**
+     * 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 object, USER extends User = User> = {
+    entity?: Entity<M>;
+    context: RebaseContext<USER>;
+    path?: string;
+    collection?: EntityCollection<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
+     */
+    sideEntityController?: SideEntityController;
+    /**
+     * 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";
+    /**
+     * 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 an entity or navigating from a form)
+     */
+    navigateBack?: () => void;
+    /**
+     * Callback to be called when the collection changes, e.g. after an entity is deleted or created.
+     */
+    onCollectionChange?: () => void;
+};

package/dist/types/entity_callbacks.d.ts

@@ -0,0 +1,173 @@
+import { EntityCollection } from "./collections";
+import { Entity, EntityStatus, EntityValues } from "./entities";
+import { User } from "../users";
+import { RebaseCallContext } from "../rebase_context";
+/**
+ * This interface defines all the callbacks that can be used when an entity
+ * is being created, updated or deleted.
+ * Useful for adding your own logic or blocking the execution of the operation.
+ * @group Models
+ */
+export type EntityCallbacks<M extends Record<string, any> = any, USER extends User = User> = {
+    /**
+     * Callback used after fetching data
+     * @param props
+     */
+    afterRead?(props: EntityAfterReadProps<M, USER>): Promise<Entity<M>> | Entity<M>;
+    /**
+     * Callback used before saving, you need to return the values that will get
+     * saved. If you throw an error in this method the process stops, and an
+     * error snackbar gets displayed.
+     * This runs after schema validation.
+     * @param props
+     */
+    beforeSave?(props: EntityBeforeSaveProps<M, USER>): Promise<Partial<EntityValues<M>>> | Partial<EntityValues<M>>;
+    /**
+     * Callback used when save is successful
+     * @param props
+     */
+    afterSave?(props: EntityAfterSaveProps<M, USER>): Promise<void> | void;
+    /**
+     * Callback used when saving fails
+     * @param props
+     */
+    afterSaveError?(props: EntityAfterSaveErrorProps<M, USER>): Promise<void> | void;
+    /**
+     * Callback used before the entity is deleted.
+     * If you throw an error in this method the process stops, and an
+     * error snackbar gets displayed.
+     *
+     * @param props
+     */
+    beforeDelete?(props: EntityBeforeDeleteProps<M, USER>): void;
+    /**
+     * Callback used after the entity is deleted.
+     *
+     * @param props
+     */
+    afterDelete?(props: EntityAfterDeleteProps<M, USER>): void;
+};
+/**
+ * Parameters passed to hooks when an entity is fetched
+ * @group Models
+ */
+export interface EntityAfterReadProps<M extends Record<string, any> = any, USER extends User = User> {
+    /**
+     * Collection of the entity
+     */
+    collection: EntityCollection<M, USER>;
+    /**
+     * Full path of the CMS where this collection is being fetched.
+     * Might contain unresolved aliases.
+     */
+    path: string;
+    /**
+     * Fetched entity
+     */
+    entity: Entity<M>;
+    /**
+     * Context of the app status
+     */
+    context: RebaseCallContext<USER>;
+}
+/**
+ * Parameters passed to hooks before an entity is saved
+ * @group Models
+ */
+export type EntityBeforeSaveProps<M extends Record<string, any> = any, USER extends User = User> = Omit<EntityAfterSaveProps<M, USER>, "entityId"> & {
+    entityId?: string | number;
+};
+/**
+ * Parameters passed to hooks before an entity is saved
+ * @group Models
+ */
+export type EntityAfterSaveErrorProps<M extends Record<string, any> = any, USER extends User = User> = Omit<EntityAfterSaveProps<M, USER>, "entityId"> & {
+    entityId?: string | number;
+};
+/**
+ * Parameters passed to hooks when an entity is saved
+ * @group Models
+ */
+export interface EntityAfterSaveProps<M extends Record<string, any> = any, USER extends User = User> {
+    /**
+     * Resolved collection of the entity
+     */
+    collection: EntityCollection<M>;
+    /**
+     * Full path of the CMS where this entity is being saved.
+     * Might contain unresolved aliases.
+     */
+    path: string;
+    /**
+     * ID of the entity
+     */
+    entityId: string | number;
+    /**
+     * Values being saved
+     */
+    values: Partial<EntityValues<M>>;
+    /**
+     * Previous values
+     */
+    previousValues?: Partial<EntityValues<M>>;
+    /**
+     * New or existing entity
+     */
+    status: EntityStatus;
+    /**
+     * Context of the app status
+     */
+    context: RebaseCallContext<USER>;
+}
+/**
+ * Parameters passed to hooks when an entity is deleted
+ * @group Models
+ */
+export interface EntityBeforeDeleteProps<M extends Record<string, any> = any, USER extends User = User> {
+    /**
+     * collection of the entity being deleted
+     */
+    collection: EntityCollection<M>;
+    /**
+     * Path of the parent collection
+     */
+    path: string;
+    /**
+     * Deleted entity id
+     */
+    entityId: string | number;
+    /**
+     * Deleted entity
+     */
+    entity: Entity<M>;
+    /**
+     * Context of the app status
+     */
+    context: RebaseCallContext<USER>;
+}
+/**
+ * Parameters passed to hooks after an entity is deleted
+ * @group Models
+ */
+export interface EntityAfterDeleteProps<M extends Record<string, any> = any, USER extends User = User> {
+    /**
+     * collection of the entity being deleted
+     */
+    collection: EntityCollection<M>;
+    /**
+     * Path of the parent collection
+     */
+    path: string;
+    /**
+     * Deleted entity id
+     */
+    entityId: string | number;
+    /**
+     * Deleted entity
+     */
+    entity: Entity<M>;
+    /**
+     * Context of the app status
+     */
+    context: RebaseCallContext<USER>;
+}

package/dist/types/entity_link_builder.d.ts

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

package/dist/types/entity_overrides.d.ts

@@ -0,0 +1,5 @@
+import { DataSource, StorageSource } from "../controllers";
+export type EntityOverrides = {
+    dataSource?: DataSource;
+    storageSource?: StorageSource;
+};

package/dist/types/export_import.d.ts

@@ -0,0 +1,21 @@
+import { Entity } from "./entities";
+import { User } from "../users";
+import { 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<any>;
+        context: RebaseContext<USER>;
+    }) => Promise<string> | string;
+}

package/dist/types/fields.d.ts

@@ -0,0 +1,221 @@
+import { InferPropertyType, Property } from "./properties";
+import { Entity } from "./entities";
+import { FormexController } from "../components/formex";
+import { EntityCollection } from "./collections";
+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";
+/**
+ * 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, 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: InferPropertyType<P>;
+    /**
+     * Set value of field directly
+     */
+    setValue: (value: InferPropertyType<P> | 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
+     * datasource
+     */
+    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, any> = any> {
+    /**
+     * 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";
+    /**
+     * 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, any> = any> {
+    /**
+     * 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/types/index.d.ts

@@ -0,0 +1,19 @@
+export * from "./entities";
+export * from "./chips";
+export * from "./entity_actions";
+export * from "./properties";
+export * from "./collections";
+export * from "./relations";
+export * from "./locales";
+export * from "./fields";
+export * from "./property_config";
+export * from "./entity_link_builder";
+export * from "./user_management_delegate";
+export * from "./entity_callbacks";
+export * from "./entity_overrides";
+export * from "./plugins";
+export * from "./rebase";
+export * from "./export_import";
+export * from "./modify_collections";
+export * from "./websockets";
+export * from "./backend";

package/dist/types/locales.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @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";