@panneau/core 4.1.1 → 5.0.0-alpha.0

package/dist/utils.d.ts

@@ -1,457 +0,0 @@
-export { kebabCase as dashCase, pascalCase, snakeCase } from 'change-case';
-import { ElementType, ComponentProps, ReactNode, MouseEvent, ReactElement, ForwardedRef } from 'react';
-import { FormattedMessage, MessageDescriptor } from 'react-intl';
-
-interface CheckClickableOptions {
-    maxParentDistance?: number;
-    tags?: string[];
-}
-interface ElementLike {
-    tagName?: string | null;
-    parentNode?: ElementLike | null;
-    dataset?: Record<string, unknown>;
-}
-declare function checkClickable(el: ElementLike | null, options?: CheckClickableOptions, parentDistance?: number): boolean;
-
-declare function convertStyleToString(style: Record<string, unknown> | null): string;
-
-declare function createNullableOnChange<T = unknown>(onChange?: ((value: T | null) => void) | null): (newValue: T) => void;
-
-interface EventsManager {
-    subscribe: (event: string, callback: (...args: unknown[]) => void) => void;
-    unsubscribe: (event: string, callback: (...args: unknown[]) => void) => void;
-}
-declare function createUseEvent(eventsManager: EventsManager | null): (event: string, callback: (...args: unknown[]) => void, enabled?: boolean) => void;
-
-/*! clipboard-copy. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
-declare function copyToClipboard(text: string): Promise<void>;
-
-/**
- * Core UI Types
- */
-
-/**
- * Internationalization message definition
- */
-type Message = MessageDescriptor;
-/**
- * Values that can be interpolated in an internationalization message
- * (the `values` prop of FormattedMessage)
- */
-type MessageValues = NonNullable<ComponentProps<typeof FormattedMessage>['values']>;
-type MessageValue = MessageValues[string];
-/**
- * Label can be either a message object or any React node
- */
-type Label = Message | ReactNode;
-/**
- * Map of components, can be nested by namespace (ex: { fields: { text: TextField } })
- */
-interface ComponentsMap {
-    [name: string]: ElementType | ComponentsMap;
-}
-/**
- * Menu item definition
- */
-interface MenuItem {
-    id?: number | string;
-    label?: Label;
-    url?: string;
-    href?: string | null;
-    external?: boolean;
-    active?: boolean;
-    type?: string;
-    component?: string;
-    className?: string | null;
-    linkClassName?: string | null;
-    onClick?: ((e: MouseEvent) => void) | null;
-    items?: MenuItem[] | null;
-    dropdown?: MenuItem[] | null;
-}
-/**
- * Form control size
- */
-type ControlSize = 'lg' | 'sm' | null;
-/**
- * Generic item (base interface for data items)
- */
-interface Item {
-    id: string;
-    [key: string]: unknown;
-}
-/**
- * Generic definition
- */
-interface Definition {
-    id: string;
-    component?: string | ElementType;
-    [key: string]: unknown;
-}
-interface RouteDefinition {
-    path?: string;
-    route?: string;
-    component: string | ElementType;
-    [key: string]: unknown;
-}
-interface PageDefinition {
-    component: string | ElementType;
-}
-
-/**
- * Form Types
- * TypeScript interfaces for form-related components
- */
-
-/**
- * Select option (more flexible than FieldOption)
- */
-type SelectOption = string | number | {
-    value?: unknown;
-    label?: Label | string;
-} | Record<string, unknown>;
-/**
- * Field definition
- */
-interface Field {
-    name?: string;
-    type?: string;
-    label?: Label;
-    component?: string;
-    size?: ControlSize;
-    [key: string]: unknown;
-}
-interface FieldDefinition$1 extends Omit<Field, 'component'>, Definition {
-}
-/**
- * Form definition
- */
-interface Form {
-    title?: ReactNode;
-    fields?: Field[];
-    method?: string | null;
-    action?: string | null;
-    submitButtonLabel?: Label | null;
-    [key: string]: unknown;
-}
-interface FormDefinition extends Form, Definition {
-}
-
-/**
- * Resource Types
- * TypeScript interfaces for resources, items, users, media, and other entities
- */
-
-/**
- * Table column definition
- */
-type TableColumn = string | Column;
-interface Column extends Record<string, unknown> {
-    id?: string | null;
-    name?: string | null;
-    label?: unknown;
-    path?: string;
-    valueKey?: string;
-    component?: string | ElementType | null;
-    field?: Field | string | null;
-    actions?: ActionDefinition[] | null;
-}
-interface Action {
-    id?: string;
-    component?: string;
-    label?: string | null;
-    icon?: string | null;
-    href?: string | null;
-    external?: boolean;
-    theme?: string;
-    target?: string;
-    onClick?: (() => void) | null;
-    endpoint?: string | null;
-    withoutConfirmation?: boolean;
-    [key: string]: unknown;
-}
-type ActionDefinition = string | Action;
-interface ResourceIntlValues {
-    a_singular?: string;
-    a_plural?: string;
-    [key: string]: MessageValue;
-}
-/**
- * Internationalization configuration
- */
-interface ResourceIntl {
-    messages?: Record<string, string>;
-    values?: ResourceIntlValues;
-}
-/**
- * Resource definition
- */
-interface ResourceIndex {
-    filters?: Filter[];
-    columns?: TableColumn[];
-    actions?: ActionDefinition[];
-    fields?: Field[];
-    [key: string]: unknown;
-}
-/**
- * Overrides of the built-in resource pages, ex: `{ show: { component: 'my-page' } }`.
- * Used on a resource (`resource.pages`) and on the panneau definition (`definition.pages`),
- * the resource taking precedence.
- */
-interface ResourcePages {
-    index?: PageDefinition;
-    show?: PageDefinition;
-    create?: PageDefinition;
-    edit?: PageDefinition;
-    delete?: PageDefinition;
-    duplicate?: PageDefinition;
-    /** @deprecated Legacy resource keys, use `index`, `show`, `create`, etc. */
-    resourceIndexPage?: PageDefinition;
-    resourceShowPage?: PageDefinition;
-    resourceCreatePage?: PageDefinition;
-    resourceEditPage?: PageDefinition;
-    resourceDeletePage?: PageDefinition;
-    resourceDuplicatePage?: PageDefinition;
-    /** @deprecated Legacy panneau keys, use `index`, `show`, `create`, etc. */
-    indexPage?: PageDefinition;
-    showPage?: PageDefinition;
-    createPage?: PageDefinition;
-    editPage?: PageDefinition;
-    deletePage?: PageDefinition;
-    duplicatePage?: PageDefinition;
-    [key: string]: PageDefinition | undefined;
-}
-/**
- * Form definition of a resource (the id is optional, the form is identified by its key)
- */
-interface ResourceForm extends Form {
-    id?: string;
-    component?: string | ElementType;
-}
-interface ResourceForms {
-    default?: ResourceForm | null;
-    create?: ResourceForm | null;
-    edit?: ResourceForm | null;
-    delete?: ResourceForm | null;
-    duplicate?: ResourceForm | null;
-    modal?: ResourceForm | null;
-    [key: string]: ResourceForm | null | undefined;
-}
-/**
- * Resource type (sub-type of a resource, ex: page types)
- */
-interface ResourceType {
-    id?: string;
-    name?: string;
-    fields?: Field[];
-    settings?: {
-        canCreate?: boolean;
-        [key: string]: unknown;
-    };
-}
-interface Resource {
-    id: string;
-    name: string;
-    intl?: ResourceIntl;
-    fields?: Field[];
-    index?: ResourceIndex;
-    forms?: ResourceForms;
-    settings?: Record<string, unknown>;
-    extraRoutes?: RouteDefinition[];
-    pages?: ResourcePages;
-    types?: ResourceType[];
-}
-/**
- * Filter definition
- */
-interface Filter {
-    id?: string;
-    component?: string;
-    [key: string]: unknown;
-}
-
-/**
- * Panneau Definition Types
- * TypeScript interfaces for main Panneau configuration and definitions
- */
-
-/**
- * Panneau route configuration
- */
-interface Routes {
-    'resources.index'?: RouteDefinition | string;
-    'resources.create'?: RouteDefinition | string;
-    'resources.store'?: RouteDefinition | string;
-    'resources.show'?: RouteDefinition | string;
-    'resources.edit'?: RouteDefinition | string;
-    'resources.update'?: RouteDefinition | string;
-    'resources.delete'?: RouteDefinition | string;
-    'resources.destroy'?: RouteDefinition | string;
-    'resources.duplicate'?: RouteDefinition | string;
-    'resources.clone'?: RouteDefinition | string;
-    'resources.restore'?: RouteDefinition | string;
-    [key: string]: RouteDefinition | string;
-}
-interface PanneauTheme {
-    colorScheme?: string | null;
-    [key: string]: unknown;
-}
-interface PanneauComponents {
-    [key: string]: string | {
-        component: string;
-        [key: string]: unknown;
-    };
-}
-interface PanneauIntlValues {
-    [key: string]: string;
-}
-interface PanneauIntl {
-    locale?: string;
-    locales?: string[];
-    messages?: Record<string, string>;
-    /** @deprecated Not used: set the values of each resource in `resources[].intl.values` */
-    values?: PanneauIntlValues;
-}
-interface PanneauPages extends ResourcePages {
-    home?: PageDefinition;
-    login?: PageDefinition;
-    account?: PageDefinition;
-    error?: PageDefinition;
-}
-/**
- * Menu item in a Panneau menu: a menu item definition or a special item id
- * (ex: 'resources', 'account', 'separator')
- */
-type PanneauMenuItem = MenuItem | string;
-interface PanneauMenus {
-    main?: PanneauMenuItem[] | null;
-    guest?: PanneauMenuItem[] | null;
-    [key: string]: PanneauMenuItem[] | null | undefined;
-}
-/**
- * Links shown on the login page: `true` for the default url, or the url of the page
- */
-interface PanneauAuth {
-    /** "Forgot your password?" link (default url: /forgot-password) */
-    forgotPassword?: boolean | string;
-    /** "Create account" link (default url: /register) */
-    register?: boolean | string;
-    [key: string]: unknown;
-}
-/**
- * Panneau definition (main configuration)
- */
-interface PanneauDefinition {
-    name?: string;
-    resources?: Resource[];
-    routes?: Routes;
-    pages?: PanneauPages;
-    intl?: PanneauIntl;
-    theme?: PanneauTheme;
-    /** @deprecated Not used: give the custom components to the `components` prop of the container */
-    components?: PanneauComponents;
-    settings?: Record<string, unknown>;
-    forms?: FormDefinition[];
-    fields?: FieldDefinition$1[];
-    menus?: PanneauMenus;
-    auth?: PanneauAuth;
-}
-
-declare function flattenComponents(components: ComponentsMap | null, prefix?: string | null): Record<string, ElementType> | null;
-
-declare function formatDuration(timeInSeconds: number | string): string;
-
-declare function getColumnsWithFields(resource: Resource, columns: TableColumn[] | null): Column[];
-
-interface ComponentResult {
-    name: string | ElementType | null;
-    props: Record<string, unknown> | null;
-}
-declare function getComponent(component: string | {
-    component: string | ElementType;
-    [key: string]: unknown;
-}): ComponentResult;
-
-declare function getComponentFromName(name?: string | ElementType | null, components?: Record<string, ElementType> | null, defaultComponent?: ElementType | string | null): ElementType | null;
-
-declare function getDefinitionFromId<T extends Definition = Definition>(id?: string | null, items?: T[] | null, defaultObject?: T | null): T | null;
-
-/**
- * Returns a message for each key of the definition that is not supported anymore,
- * with the key to use instead. Without it, these keys would be silently ignored.
- */
-declare function getDefinitionWarnings(definition: PanneauDefinition | null): string[];
-
-interface ComponentWithName {
-    displayName?: string | null;
-    name?: string | null;
-}
-declare function getDisplayName({ displayName, name }: ComponentWithName): string;
-
-interface FieldWithSubFields$1 extends Field {
-    fields?: FieldWithSubFields$1[];
-}
-declare function getFieldByName(fields: FieldWithSubFields$1[], name: string | null): FieldWithSubFields$1 | null;
-
-interface FieldDefinition {
-    fields?: Field[] | null;
-    settings?: Field[] | null;
-    itemsField?: Field | null;
-}
-interface FieldManager {
-    getDefinition: (type: string) => FieldDefinition;
-}
-interface FieldWithSubFields extends Field {
-    type?: string | null;
-    fields?: Field[] | null;
-    field?: Field | null;
-    settings?: Field[] | null;
-    itemsField?: Field | null;
-    listItems?: boolean;
-}
-declare function getFieldFromPath(path: string | string[], fields: Field[], fieldManager: FieldManager): FieldWithSubFields | null;
-
-declare function getFileName(url?: string | null): string | null;
-
-declare function getPathValue(it: unknown, path: string | string[]): unknown;
-
-interface FormattedOption {
-    value: unknown;
-    label: string | ReactElement;
-}
-declare function getSelectOptions(options: SelectOption[]): FormattedOption[];
-
-declare function isMessage(message: unknown): message is Message;
-
-declare function loadPackage<T = unknown>(name: string, loader: () => Promise<T>): Promise<T>;
-
-declare function mergeRefs<T>(...refs: Array<ForwardedRef<T> | null | undefined>): (value: T | null) => void;
-
-/**
- * Parse a date-only value as a local date, ignoring its timezone.
- *
- * A date stored at midnight represents a calendar day, not an instant: converting it to the
- * browser timezone would show the previous day west of the server timezone (ex: a date saved as
- * 2026-10-01 00:00 UTC is 2026-09-30 20:00 in Montreal). Returns null when the value has a time,
- * so the caller can parse it as an instant.
- */
-declare function parseDateOnly(value: string | null | undefined): Date | null;
-
-declare function toggleSelectedItem(items: Item[] | null, item: Item, { multiple: multipleSelection }?: {
-    multiple?: boolean;
-}): Item[] | null;
-declare function selectItems(items: Item[] | null, itemsToSelect: Item[]): Item[] | null;
-declare function unselectItems(items: Item[] | null, itemsToUnselect: Item[]): Item[] | null;
-
-type Value = Record<string, unknown> | unknown[] | null;
-declare function setValue(value: Value, keyParts: string[], fieldValue: unknown): Value;
-
-declare function slug(str: string, separator?: string | null): string;
-
-interface FieldWithValidation extends Field {
-    type?: string;
-    fields?: FieldWithValidation[];
-    required?: boolean;
-}
-declare function validateFields(fields: FieldWithValidation[], value: Record<string, unknown> | null): boolean;
-
-export { checkClickable, convertStyleToString, copyToClipboard, createNullableOnChange, createUseEvent, flattenComponents, formatDuration, getColumnsWithFields, getComponent, getComponentFromName, getDefinitionFromId, getDefinitionWarnings, getDisplayName, getFieldByName, getFieldFromPath, getFileName, getPathValue, getSelectOptions, isMessage, loadPackage, mergeRefs, parseDateOnly, selectItems, setValue as setFieldValue, slug, toggleSelectedItem, unselectItems, validateFields };