@rebasepro/plugin-insights 0.0.1-canary.09e5ec5

package/dist/core/src/hooks/useStorageSource.d.ts

@@ -0,0 +1,7 @@
+import type { EntityCollection } from "@rebasepro/types";
+import { StorageSource } from "@rebasepro/types";
+/**
+ * Use this hook to get the storage source being used
+ * @group Hooks and utilities
+ */
+export declare const useStorageSource: (collection?: EntityCollection) => StorageSource;

package/dist/core/src/hooks/useStudioBridge.d.ts

@@ -0,0 +1,91 @@
+import React from "react";
+import type { CollectionRegistryController, SideEntityController, UrlController, NavigationStateController } from "@rebasepro/types";
+export interface BreadcrumbEntry {
+    title: string;
+    url: string;
+    count?: number | null;
+    id?: string;
+}
+export interface BreadcrumbsController {
+    breadcrumbs: BreadcrumbEntry[];
+    set: (props: {
+        breadcrumbs: BreadcrumbEntry[];
+    }) => void;
+    updateCount: (id: string, count: number | null | undefined) => void;
+}
+/**
+ * StudioBridge provides optional CMS capabilities to Studio components.
+ * When CMS is present, a bridge provider injects real implementations.
+ * When CMS is absent, noop defaults ensure Studio works standalone.
+ */
+export interface StudioBridge {
+    collectionRegistry: CollectionRegistryController;
+    sideEntityController: SideEntityController;
+    urlController: UrlController;
+    navigationState: NavigationStateController;
+    breadcrumbs: BreadcrumbsController;
+}
+export declare const StudioBridgeContext: React.Context<StudioBridge>;
+/**
+ * Provider that injects CMS capabilities into Studio.
+ * Accepts partial overrides — any field not provided falls back to noop.
+ *
+ * Usage (in app wiring, when CMS is present):
+ * ```tsx
+ * <StudioBridgeProvider value={{
+ *     collectionRegistry: useCollectionRegistryController(),
+ *     sideEntityController: useSideEntityController(),
+ *     urlController: useUrlController(),
+ *     navigationState: useNavigationStateController(),
+ *     breadcrumbs: useBreadcrumbsController(),
+ * }}>
+ *     <RebaseStudio ... />
+ * </StudioBridgeProvider>
+ * ```
+ */
+export declare function StudioBridgeProvider({ value, children }: {
+    value: Partial<StudioBridge>;
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+/** Collection registry — returns noop if CMS is not present. */
+export declare function useStudioCollectionRegistry(): CollectionRegistryController;
+/** Side entity controller — returns noop if CMS is not present. */
+export declare function useStudioSideEntityController(): SideEntityController;
+/** URL controller — returns noop if CMS is not present. */
+export declare function useStudioUrlController(): UrlController;
+/** Navigation state — returns noop if CMS is not present. */
+export declare function useStudioNavigationState(): NavigationStateController;
+/** Breadcrumbs controller — returns noop if CMS is not present. */
+export declare function useStudioBreadcrumbs(): BreadcrumbsController;
+/**
+ * Registry that controllers use to self-register their implementations
+ * into the Studio bridge. Each controller calls `register(key, value)`
+ * on mount and `unregister(key)` on unmount.
+ */
+export interface StudioBridgeRegistry {
+    register: <K extends keyof StudioBridge>(key: K, value: StudioBridge[K]) => void;
+    unregister: (key: keyof StudioBridge) => void;
+}
+export declare const StudioBridgeRegistryContext: React.Context<StudioBridgeRegistry | null>;
+/**
+ * Provider that creates a self-assembling bridge.
+ *
+ * Mount this above the controller providers. Each controller calls
+ * `useBridgeRegistration(key, value)` to inject its implementation.
+ * The bridge context value is automatically kept in sync.
+ *
+ * ```tsx
+ * <StudioBridgeRegistryProvider>
+ *     <CollectionRegistryProvider>   // auto-registers
+ *     <SideEntityProvider>           // auto-registers
+ *     <UrlProvider>                  // auto-registers
+ *         <RebaseStudio />           // consumes bridge
+ *     </UrlProvider>
+ *     </SideEntityProvider>
+ *     </CollectionRegistryProvider>
+ * </StudioBridgeRegistryProvider>
+ * ```
+ */
+export declare function StudioBridgeRegistryProvider({ children }: {
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/src/hooks/useTranslation.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Internal hook for translating Rebase UI strings.
+ *
+ * Uses the `rebase_core` i18next namespace that is initialised by
+ * `RebaseI18nProvider`. Do NOT use `react-i18next` directly in internal
+ * components — always go through this hook so the namespace is consistent.
+ *
+ * @example
+ * const { t } = useTranslation();
+ * <Button>{t("save")}</Button>
+ *
+ * @internal
+ */
+export declare function useTranslation(): {
+    t: (key: string, vars?: Record<string, string>) => string;
+    i18n: import("i18next").i18n;
+};

package/dist/core/src/hooks/useUnsavedChangesDialog.d.ts

@@ -0,0 +1,12 @@
+import { UnsavedChangesDialogProps } from "../components/UnsavedChangesDialog";
+/**
+ * A single, unified hook to prevent navigation when there are unsaved changes.
+ *
+ * It automatically handles:
+ * 1. Internal React Router navigation using `useBlocker`.
+ * 2. External browser navigation (page refresh, tab close) using `beforeunload`.
+ */
+export declare function useUnsavedChangesDialog(when: boolean, onOk: () => void): {
+    dialogProps: UnsavedChangesDialogProps;
+    triggerDialog: () => void;
+};

package/dist/core/src/hooks/useUserConfigurationPersistence.d.ts

@@ -0,0 +1,8 @@
+import { UserConfigurationPersistence } from "@rebasepro/types";
+/**
+ * Use this controller to access the configuration that is stored externally,
+ * and not defined in code
+ *
+ * @group Hooks and utilities
+ */
+export declare const useUserConfigurationPersistence: () => UserConfigurationPersistence | undefined;

package/dist/core/src/hooks/useValidateAuthenticator.d.ts

@@ -0,0 +1,21 @@
+import { AuthController, Authenticator, RebaseData, StorageSource, User } from "@rebasepro/types";
+/**
+ * This hook is used internally for validating an authenticator.
+ *
+ * @param authController
+ * @param authentication
+ * @param storageSource
+ * @param data
+ */
+export declare function useValidateAuthenticator<USER extends User = any>({ disabled, authController, authenticator, storageSource, data }: {
+    disabled?: boolean;
+    authController: AuthController<USER>;
+    authenticator?: boolean | Authenticator<USER>;
+    data: RebaseData;
+    storageSource: StorageSource;
+}): {
+    canAccessMainView: boolean;
+    authLoading: boolean;
+    notAllowedError: any;
+    authVerified: boolean;
+};

package/dist/core/src/i18n/RebaseI18nProvider.d.ts

@@ -0,0 +1,33 @@
+import { PropsWithChildren } from "react";
+import { RebaseTranslations } from "@rebasepro/types";
+export declare const REBASE_LOCALE_STORAGE_KEY = "rebase_locale";
+/** DeepPartial helper — allows partial overrides at any nesting level */
+type DeepPartial<T> = T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+export interface RebaseI18nProviderProps {
+    /** BCP-47 locale tag, e.g. "en", "es", "fr". Defaults to "en". */
+    locale?: string;
+    /**
+     * Override or extend any Rebase UI string, keyed by locale.
+     *
+     * @example
+     * translations={{
+     *   en: { save: "Publish" },
+     *   es: { save: "Publicar", discard: "Descartar" }
+     * }}
+     */
+    translations?: {
+        [locale: string]: DeepPartial<RebaseTranslations>;
+    };
+}
+/**
+ * Initialises a dedicated i18next instance for Rebase's internal UI strings.
+ *
+ * This instance is isolated from any app-level i18next configuration the
+ * consumer may have. Mount this at the top of the Rebase component tree.
+ *
+ * @internal
+ */
+export declare function RebaseI18nProvider({ locale, translations, children }: PropsWithChildren<RebaseI18nProviderProps>): import("react/jsx-runtime").JSX.Element | null;
+export {};

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

@@ -0,0 +1,15 @@
+export * from "./core";
+export * from "./hooks";
+export * from "./components";
+export * from "./util";
+export * from "./contexts";
+export * from "./internal/common";
+export * from "./internal/useRestoreScroll";
+export { useUnsavedChangesDialog } from "./hooks/useUnsavedChangesDialog";
+export type { UnsavedChangesDialogProps } from "./components/UnsavedChangesDialog";
+export { UnsavedChangesDialog } from "./components/UnsavedChangesDialog";
+export * from "./i18n/RebaseI18nProvider";
+export * from "./locales/en";
+export * from "./locales/es";
+export * from "./hooks/useStudioBridge";
+export { useBridgeRegistration } from "./hooks/useBridgeRegistration";

package/dist/core/src/internal/common.d.ts

@@ -0,0 +1,3 @@
+export declare const CONTAINER_FULL_WIDTH = "100vw";
+export declare const ADDITIONAL_TAB_WIDTH = "55vw";
+export declare const FORM_CONTAINER_WIDTH = "768px";

package/dist/core/src/internal/useRestoreScroll.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export declare function useRestoreScroll(): {
+    containerRef: React.RefObject<HTMLDivElement | null>;
+    scroll: number;
+    direction: "up" | "down";
+};

package/dist/core/src/locales/de.d.ts

@@ -0,0 +1,2 @@
+import { RebaseTranslations } from "@rebasepro/types";
+export declare const de: RebaseTranslations;

package/dist/core/src/locales/en.d.ts

@@ -0,0 +1,10 @@
+import { RebaseTranslations } from "@rebasepro/types";
+/**
+ * English baseline translations for @rebasepro/core.
+ *
+ * This is the single source of truth for all default UI strings.
+ * Override any key via the `translations` prop on Rebase entry-point components.
+ *
+ * @group Core
+ */
+export declare const en: RebaseTranslations;

package/dist/core/src/locales/es.d.ts

@@ -0,0 +1,10 @@
+import { RebaseTranslations } from "@rebasepro/types";
+/**
+ * Spanish baseline translations for @rebasepro/core.
+ *
+ * This is the single source of truth for all default UI strings in Spanish.
+ * Override any key via the `translations` prop on Rebase entry-point components.
+ *
+ * @group Core
+ */
+export declare const es: RebaseTranslations;

package/dist/core/src/locales/fr.d.ts

@@ -0,0 +1,2 @@
+import { RebaseTranslations } from "@rebasepro/types";
+export declare const fr: RebaseTranslations;

package/dist/core/src/locales/hi.d.ts

@@ -0,0 +1,2 @@
+import { RebaseTranslations } from "@rebasepro/types";
+export declare const hi: RebaseTranslations;

package/dist/core/src/locales/it.d.ts

@@ -0,0 +1,2 @@
+import { RebaseTranslations } from "@rebasepro/types";
+export declare const it: RebaseTranslations;

package/dist/core/src/locales/pt.d.ts

@@ -0,0 +1,7 @@
+import { RebaseTranslations } from "@rebasepro/types";
+/**
+ * Portuguese (pt) translations for @rebasepro/core.
+ *
+ * @group Core
+ */
+export declare const pt: RebaseTranslations;

package/dist/core/src/util/constants.d.ts

@@ -0,0 +1 @@
+export declare const STUDIO_NAVIGATION_GROUPS: string[];

package/dist/core/src/util/createFormexStub.d.ts

@@ -0,0 +1,2 @@
+import { FormexController } from "@rebasepro/formex";
+export declare function createFormexStub<T extends object>(values: T): FormexController<T>;

package/dist/core/src/util/entity_cache.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Saves data to the in-memory cache and persists it individually in `sessionStorage`.
+ * @param path - The unique path/key for the data.
+ * @param data - The data to cache and persist.
+ */
+export declare function saveEntityToCache(path: string, data: object): void;
+export declare function removeEntityFromMemoryCache(path: string): void;
+export declare function saveEntityToMemoryCache(path: string, data: object): void;
+export declare function getEntityFromMemoryCache(path: string): object | undefined;
+export declare function hasEntityInCache(path: string): boolean;
+/**
+ * Retrieves an entity from the in-memory cache or `sessionStorage`.
+ * If the entity is not in the cache but exists in `sessionStorage`, it loads it into the cache.
+ * @param path - The unique path/key for the entity.
+ * @returns The cached entity or `undefined` if not found.
+ */
+export declare function getEntityFromCache(path: string): object | undefined;
+/**
+ * Removes an entity from both the in-memory cache and `sessionStorage`.
+ * @param path - The unique path/key for the entity to remove.
+ */
+export declare function removeEntityFromCache(path: string): void;
+/**
+ * Clears the entire in-memory cache and removes all related entities from `sessionStorage`.
+ */
+export declare function clearEntityCache(): void;
+export declare function flattenKeys(obj: Record<string, unknown> | unknown[], prefix?: string, result?: string[]): string[];

package/dist/core/src/util/enums.d.ts

@@ -0,0 +1,5 @@
+import { EnumValueConfig } from "@rebasepro/types";
+import { ChipColorScheme } from "@rebasepro/ui";
+export declare function getColorScheme(enumValues: EnumValueConfig[], key: string | number): ChipColorScheme | undefined;
+export declare function isEnumValueDisabled(labelOrConfig?: string | EnumValueConfig): boolean | undefined;
+export declare function buildEnumLabel(labelOrConfig?: string | EnumValueConfig): string | undefined;

package/dist/core/src/util/icon_list.d.ts

@@ -0,0 +1,5 @@
+import Fuse from "fuse.js";
+export declare const iconsSearch: Fuse<{
+    key: string;
+    synonyms: string;
+}>;

package/dist/core/src/util/icon_synonyms.d.ts

@@ -0,0 +1 @@
+export declare const iconSynonyms: Record<string, string>;

package/dist/core/src/util/icons.d.ts

@@ -0,0 +1,20 @@
+import React from "react";
+import { IconColor } from "@rebasepro/ui";
+/**
+ * Render an icon element from a string key or existing React element.
+ * This resolves the icon from the lucide-react icons map directly.
+ */
+export declare function getIcon(iconKey?: string | React.ReactNode, className?: string, color?: IconColor, size?: "smallest" | "small" | "medium" | "large" | number): React.ReactElement | undefined;
+export type IconViewProps = {
+    slug: string;
+    name: string;
+    singularName?: string;
+    group?: string;
+    icon?: string | React.ReactNode;
+};
+export declare const IconForView: React.NamedExoticComponent<{
+    collectionOrView?: IconViewProps;
+    color?: IconColor;
+    className?: string;
+    size?: "smallest" | "small" | "medium" | "large" | number;
+}>;

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

@@ -0,0 +1,10 @@
+export * from "./icon_list";
+export * from "./icon_synonyms";
+export * from "./icons";
+export * from "./createFormexStub";
+export * from "./entity_cache";
+export * from "./useStorageUploadController";
+export * from "./useTraceUpdate";
+export * from "./previews";
+export * from "./enums";
+export * from "./constants";

package/dist/core/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, any>>(collection: EntityCollection<M>, propertyConfigs: Record<string, PropertyConfig>): string | undefined;

package/dist/core/src/util/useStorageUploadController.d.ts

@@ -0,0 +1,38 @@
+import type { ArrayProperty, StringProperty } from "@rebasepro/types";
+import { EntityValues, StorageConfig, StorageSource } from "@rebasepro/types";
+export type StorageFieldSize = "smallest" | "small" | "medium" | "large" | number;
+/**
+ * Internal representation of an item in the storage
+ * It can have two states, having a storagePathOrDownloadUrl set,
+ * which means the file has been uploaded, and it is rendered as a preview
+ * Or have a pending file being uploaded.
+ */
+export interface StorageFieldItem {
+    id: number;
+    storagePathOrDownloadUrl?: string;
+    file?: File;
+    fileName?: string;
+    metadata?: any;
+    size: StorageFieldSize;
+}
+export declare function useStorageUploadController<M extends Record<string, unknown>>({ entityId, entityValues, path, value, property, propertyKey, storageSource, disabled, onChange }: {
+    entityId?: string | number;
+    entityValues: EntityValues<M>;
+    value: string | string[] | null;
+    path?: string;
+    propertyKey: string;
+    property: StringProperty | ArrayProperty | StringProperty | ArrayProperty;
+    storageSource: StorageSource;
+    disabled: boolean;
+    onChange: (value: string | string[] | null) => void;
+}): {
+    internalValue: StorageFieldItem[];
+    setInternalValue: import("react").Dispatch<import("react").SetStateAction<StorageFieldItem[]>>;
+    storage: StorageConfig;
+    fileNameBuilder: (file: File) => Promise<string>;
+    storagePathBuilder: (file: File) => string;
+    onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, metadata?: any, uploadedUrl?: string) => Promise<void>;
+    onFileUploadError: (entry: StorageFieldItem) => void;
+    onFilesAdded: (acceptedFiles: File[]) => Promise<void>;
+    multipleFilesSupported: boolean;
+};

package/dist/core/src/util/useTraceUpdate.d.ts

@@ -0,0 +1,2 @@
+export declare function printChanged(props: any, prev: any, path?: string | undefined, depth?: number | undefined, maxDepth?: number | undefined): void;
+export declare function useTraceUpdate(props: any, maxDepth?: number): void;

package/dist/formex/src/Field.d.ts

@@ -0,0 +1,52 @@
+import * as React from "react";
+import { FormexController } from "./types";
+export interface FieldInputProps<Value> {
+    /** Value of the field */
+    value: Value;
+    /** Name of the field */
+    name: string;
+    /** Multiple select? */
+    multiple?: boolean;
+    /** Is the field checked? */
+    checked?: boolean;
+    /** Change event handler */
+    onChange: (event: React.SyntheticEvent) => void;
+    /** Blur event handler */
+    onBlur: (event: React.FocusEvent) => void;
+}
+export interface FormexFieldProps<Value = any, FormValues extends object = object> {
+    field: FieldInputProps<Value>;
+    form: FormexController<FormValues>;
+}
+export interface FieldConfig<Value, C extends React.ElementType | undefined = undefined> {
+    /**
+     * Component to render. Can either be a string e.g. 'select', 'input', or 'textarea', or a component.
+     */
+    as?: C | string | React.ForwardRefExoticComponent<Record<string, unknown>>;
+    /**
+     * Children render function <Field name>{props => ...}</Field>)
+     */
+    children?: ((props: FormexFieldProps<Value>) => React.ReactNode) | React.ReactNode;
+    /**
+     * Validate a single field value independently
+     */
+    /**
+     * Used for 'select' and related input types.
+     */
+    multiple?: boolean;
+    /**
+     * Field name
+     */
+    name: string;
+    /** HTML input type */
+    type?: string;
+    /** Field value */
+    value?: unknown;
+    /** Inner ref */
+    innerRef?: (instance: unknown) => void;
+}
+export type FieldProps<T, C extends React.ElementType | undefined> = {
+    as?: C;
+} & (C extends React.ElementType ? (React.ComponentProps<C> & FieldConfig<T, C>) : FieldConfig<T, C>);
+export declare function Field<T, C extends React.ElementType | undefined = undefined>({ validate, name, children, as: is, // `as` is reserved in typescript lol
+className, ...props }: FieldProps<T, C>): any;

package/dist/formex/src/Formex.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { FormexController } from "./types";
+export declare const useFormex: <T = any>() => FormexController<T>;
+export declare const Formex: <T = any>({ value, children }: {
+    value: FormexController<T>;
+    children: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,5 @@
+export * from "./Field";
+export * from "./Formex";
+export * from "./types";
+export * from "./utils";
+export * from "./useCreateFormex";

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

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

package/dist/formex/src/useCreateFormex.d.ts

@@ -0,0 +1,14 @@
+import { FormexController } from "./types";
+export declare function useCreateFormex<T = any>({ initialValues, initialErrors, initialDirty, initialTouched, validation, validateOnChange, validateOnInitialRender, onSubmit, onReset, onValuesChangeDeferred, debugId }: {
+    initialValues: T;
+    initialErrors?: Record<string, string>;
+    initialDirty?: boolean;
+    initialTouched?: Record<string, boolean>;
+    validateOnChange?: boolean;
+    validateOnInitialRender?: boolean;
+    validation?: (values: T) => Record<string, string> | Promise<Record<string, string>> | undefined | void;
+    onValuesChangeDeferred?: (values: T, controller: FormexController<T>) => void;
+    onSubmit?: (values: T, controller: FormexController<T>) => void | Promise<void>;
+    onReset?: (controller: FormexController<T>) => void | Promise<void>;
+    debugId?: string;
+}): FormexController<T>;

package/dist/formex/src/utils.d.ts

@@ -0,0 +1,16 @@
+/** @private is the value an empty array? */
+export declare const isEmptyArray: (value?: unknown) => boolean;
+/** @private is the given object a Function? */
+export declare const isFunction: (obj: unknown) => obj is Function;
+/** @private is the given object an Object? */
+export declare const isObject: (obj: unknown) => obj is Record<string, unknown>;
+/** @private is the given object an integer? */
+export declare const isInteger: (obj: unknown) => boolean;
+/** @private is the given object a NaN? */
+export declare const isNaN: (obj: unknown) => boolean;
+/**
+ * Deeply get a value from an object via its path.
+ */
+export declare function getIn(obj: any, key: string | string[], def?: unknown, p?: number): any;
+export declare function setIn(obj: any, path: string, value: unknown): any;
+export declare function clone(value: unknown): unknown;