@panneau/core 4.1.1 → 5.0.0-alpha.1

package/dist/hooks.d.ts

@@ -1,512 +0,0 @@
-import { Dayjs } from 'dayjs';
-import { ReactNode, ComponentProps, ElementType, SyntheticEvent, RefObject } from 'react';
-import { MessageDescriptor, FormattedMessage } from 'react-intl';
-
-interface UseAnimationFrameOptions {
-    disabled?: boolean;
-}
-declare function useAnimationFrame(onFrame: (progress: number) => void, { disabled }?: UseAnimationFrameOptions): void;
-
-interface UseFormattedDateOptions {
-    format?: Intl.DateTimeFormatOptions | null;
-    showToday?: boolean;
-}
-interface UseFormattedTimeOptions {
-    format?: Intl.DateTimeFormatOptions | null;
-    showNow?: boolean;
-    timeGap?: number;
-}
-declare function useFormattedDate({ format, showToday, }?: UseFormattedDateOptions): (date: string | Date | Dayjs) => string;
-declare function useFormattedTime({ format, showNow, timeGap, }?: UseFormattedTimeOptions): (date: string | Date | Dayjs) => string;
-
-declare const useDocumentEvent: (event: string, callback: (...args: unknown[]) => void, enabled?: boolean) => 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;
-/**
- * Form control size
- */
-type ControlSize = 'lg' | 'sm' | null;
-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
- */
-
-/**
- * Field definition
- */
-interface Field$1 {
-    name?: string;
-    type?: string;
-    label?: Label;
-    component?: string;
-    size?: ControlSize;
-    [key: string]: unknown;
-}
-/**
- * Form definition
- */
-interface Form {
-    title?: ReactNode;
-    fields?: Field$1[];
-    method?: string | null;
-    action?: string | null;
-    submitButtonLabel?: Label | null;
-    [key: string]: unknown;
-}
-
-/**
- * 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$1 | 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$1[];
-    [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$1 {
-    id?: string;
-    name?: string;
-    fields?: Field$1[];
-    settings?: {
-        canCreate?: boolean;
-        [key: string]: unknown;
-    };
-}
-interface Resource {
-    id: string;
-    name: string;
-    intl?: ResourceIntl;
-    fields?: Field$1[];
-    index?: ResourceIndex;
-    forms?: ResourceForms;
-    settings?: Record<string, unknown>;
-    extraRoutes?: RouteDefinition[];
-    pages?: ResourcePages;
-    types?: ResourceType$1[];
-}
-/**
- * Filter definition
- */
-interface Filter {
-    id?: string;
-    component?: string;
-    [key: string]: unknown;
-}
-
-type FieldInput = string | Field$1;
-interface FieldErrors {
-    [key: string]: string[] | FieldErrors;
-}
-interface FieldValue {
-    [key: string]: unknown;
-}
-interface ProcessedField extends Field$1 {
-    name: string | null;
-    component: string | null;
-    value: unknown;
-    errors: string[] | null;
-    onChange: (fieldValue: unknown) => void;
-    fields?: ProcessedField[] | null;
-}
-interface RequestState {
-    success: boolean;
-    loading: boolean;
-    error: boolean;
-}
-interface UseFormOptions<T extends FieldValue = FieldValue> {
-    fields?: FieldInput[];
-    action?: string | null;
-    postForm?: ((action: string, data: Record<string, unknown>) => Promise<unknown>) | null;
-    initialErrors?: FieldErrors | null;
-    errors?: FieldErrors | null;
-    setErrors?: ((errors: FieldErrors | null) => void) | null;
-    initialGeneralError?: string | null;
-    generalError?: string | null;
-    setGeneralError?: ((error: string | null) => void) | null;
-    initialValue?: T | null;
-    value?: T | null;
-    setValue?: ((value: T) => void) | null;
-    withoutDefault?: boolean;
-    withoutPropagation?: boolean;
-    onComplete?: ((response: unknown) => void) | null;
-    onError?: ((error: Error) => void) | null;
-    locales?: string[];
-}
-interface UseFormReturn<T extends FieldValue = FieldValue> extends RequestState {
-    value: T | null;
-    setValue: (value: T) => void;
-    csrfToken: string | null;
-    submit: (submitValue?: T | null) => void;
-    onSubmit: (e: SyntheticEvent) => void;
-    status: 'loading' | 'success' | 'error' | null;
-    response: unknown;
-    fields: ProcessedField[];
-    errors: FieldErrors | null;
-    generalError: string | null;
-}
-declare function useForm<T extends FieldValue = FieldValue>(opts?: UseFormOptions<T>): UseFormReturn<T>;
-
-interface UseIsVisibleOptions {
-    rootMargin?: string;
-    threshold?: number;
-    persist?: boolean;
-}
-interface UseIsVisibleResult {
-    ref: RefObject<Element>;
-    visible: boolean;
-}
-declare function useIsVisible({ rootMargin, threshold, persist, }?: UseIsVisibleOptions): UseIsVisibleResult;
-
-declare const KEYCODES: {
-    ARROW_LEFT: number;
-    ARROW_UP: number;
-    ARROW_RIGHT: number;
-    ARROW_DOWN: number;
-    ESCAPE: number;
-    SPACE: number;
-};
-interface UseKeyboardKeysOptions {
-    eventName?: string;
-}
-declare function useKeyboardKeys(keys?: Record<number, (e: KeyboardEvent) => void>, { eventName }?: UseKeyboardKeysOptions): void;
-
-interface FontConfig {
-    type?: 'google' | 'custom' | 'system';
-    name: string;
-}
-declare function useLoadedFonts(fonts: (string | FontConfig)[]): {
-    loaded: boolean;
-};
-
-interface UseMediaApiOptions {
-    url?: string | null;
-    initialMuted?: boolean;
-    onTimeUpdate?: ((time: number) => void) | null;
-    onProgressStep?: ((step: number) => void) | null;
-    onDurationChanged?: ((duration: number) => void) | null;
-    onVolumeChanged?: ((muted: boolean, volume: number) => void) | null;
-    onPlay?: ((opts: {
-        initial: boolean;
-    }) => void) | null;
-    onPause?: ((opts: {
-        midway: boolean;
-    }) => void) | null;
-    onEnded?: (() => void) | null;
-    onSeeked?: ((time: number) => void) | null;
-    onLoadStart?: (() => void) | null;
-    onCanPlayThough?: (() => void) | null;
-}
-interface UseMediaApiReturn {
-    ref: RefObject<HTMLMediaElement>;
-    play: () => void;
-    pause: () => void;
-    togglePlay: () => void;
-    stop: () => void;
-    seek: (time: number) => void;
-    mute: () => void;
-    unMute: () => void;
-    toggleMute: () => void;
-    muted: boolean;
-    currentTime: number | null;
-    duration: number | null;
-    playing: boolean;
-    paused: boolean;
-    ready: boolean;
-}
-declare function useMediaApi({ url, initialMuted, onTimeUpdate, onProgressStep, onDurationChanged, onVolumeChanged, onPlay, onPause, onEnded, onSeeked, onLoadStart, onCanPlayThough, }?: UseMediaApiOptions): UseMediaApiReturn;
-
-interface Manager {
-    getDefinition: (type: string) => Record<string, unknown> | null;
-}
-interface MediasParserOptions {
-    fieldsManager: Manager;
-    screensManager?: Manager | null;
-}
-interface Media$1 {
-    id?: string | null;
-    [key: string]: unknown;
-}
-interface Field {
-    id?: string | null;
-    name?: string | null;
-    type?: string | null;
-    media?: boolean;
-    fields?: Field[];
-    itemsField?: Field | null;
-    settings?: Field[];
-    [key: string]: unknown;
-}
-interface Screen$1 {
-    type: string;
-    [key: string]: unknown;
-}
-interface Story$1 {
-    theme?: Story$1 | null;
-    components?: Screen$1[];
-    medias?: Record<string, Media$1> | null;
-    [key: string]: unknown;
-}
-declare class MediasParser {
-    fieldsManager: Manager;
-    screensManager: Manager | null;
-    constructor({ fieldsManager, screensManager }: MediasParserOptions);
-    toPath(story: Story$1 | null): Story$1 | null;
-    fromPath(story: Story$1 | null, defaultMedias?: Record<string, Media$1> | null): Story$1 | null;
-    getMediaFieldsPattern(fields: Field[], namePrefix?: string | null): RegExp[];
-    static fieldIsMedia({ media }: Field): boolean;
-    static fieldIsFontFamily({ id }: Field): boolean;
-    static replacePathsWithMedias(data: unknown, medias: Record<string, Media$1>, patterns: RegExp[], keyPrefix?: string | null): unknown;
-    static getMediaPath({ id }: Media$1): string | null;
-    static replaceMediasWithPaths(data: unknown, patterns: RegExp[], medias?: Record<string, Media$1> | null, keyPrefix?: string | null): {
-        data: unknown;
-        medias: Record<string, Media$1> | null;
-    };
-}
-
-type Story = Parameters<MediasParser['toPath']>[0];
-interface UseMediasParserReturn {
-    toPath: (story: Story) => Story;
-    fromPath: (story: Story) => Story;
-    parser: MediasParser;
-}
-declare function useMediasParser(): UseMediasParserReturn;
-
-type ObserverConstructor<T> = (new (callback: (entries: T[]) => void, options?: Record<string, unknown>) => {
-    observe: (element: Element) => void;
-    unobserve?: (element: Element) => void;
-    disconnect: () => void;
-}) | null;
-interface ObserverWrapper<T> {
-    subscribe: (element: Element, callback: (entry: T) => void) => void;
-    unsubscribe: (element: Element, callback?: ((entry: T) => void) | null) => void;
-    observer: InstanceType<NonNullable<ObserverConstructor<T>>>;
-}
-interface ObserverOptions {
-    root?: Element | null;
-    rootMargin?: string | null;
-    threshold?: number | number[] | null;
-    disabled?: boolean;
-}
-declare function getObserver<T>(Observer: ObserverConstructor<T>, options?: ObserverOptions): ObserverWrapper<T>;
-interface UseObserverReturn<T> {
-    ref: RefObject<Element>;
-    entry: T;
-}
-declare function useObserver<T>(Observer: ObserverConstructor<T>, opts?: ObserverOptions, initialEntry?: T): UseObserverReturn<T>;
-interface IntersectionObserverEntry {
-    target: Element | null;
-    time: number | null;
-    isVisible?: boolean;
-    isIntersecting: boolean;
-    intersectionRatio: number;
-    intersectionRect: DOMRectReadOnly | null;
-    boundingClientRect: DOMRectReadOnly | null;
-    rootBounds: DOMRectReadOnly | null;
-}
-interface UseIntersectionObserverOptions {
-    root?: Element | null;
-    rootMargin?: string;
-    threshold?: number | number[];
-    disabled?: boolean;
-}
-declare function useIntersectionObserver({ root, rootMargin, threshold, disabled, }?: UseIntersectionObserverOptions): UseObserverReturn<IntersectionObserverEntry>;
-/**
- * Resize Observer
- */
-interface ResizeObserverEntry {
-    target: Element | null;
-    contentRect: DOMRectReadOnly | null;
-    contentBoxSize: ReadonlyArray<ResizeObserverSize> | null;
-    borderBoxSize: ReadonlyArray<ResizeObserverSize> | null;
-}
-interface UseResizeObserverOptions {
-    disabled?: boolean;
-}
-declare function useResizeObserver({ disabled, }?: UseResizeObserverOptions): UseObserverReturn<ResizeObserverEntry>;
-
-interface ResourceType {
-    id?: string | null;
-    name?: string | null;
-}
-interface ResourceWithTypes extends Resource {
-    types?: ResourceType[];
-    settings?: {
-        hideTypeNames?: boolean;
-    };
-}
-declare function useResourceTypeName(resource: ResourceWithTypes | null, type?: string | null): string | null;
-
-declare function useResourceUrlGenerator(): (routeResourceId: string | Resource, routeName?: string, params?: Record<string, unknown> | null) => string | null;
-declare function useResourceUrlGenerator(resourceId: string | Resource): (routeName?: string, params?: Record<string, unknown> | null) => string | null;
-
-interface QueryParams {
-    page?: number;
-    count?: number;
-    [key: string]: unknown;
-}
-interface UseQueryReturn {
-    query: QueryParams | null;
-    onPageChange: (newPage: number) => void;
-    onQueryChange: (newQuery: QueryParams | null) => void;
-    onQueryReset: () => void;
-}
-declare function useQuery(initialBaseQuery?: QueryParams | null, paginated?: boolean): UseQueryReturn;
-
-interface Screen {
-    name: string;
-    mediaQuery?: string | null;
-}
-interface Media {
-    type: string;
-    width: string;
-    height: string;
-}
-interface UseScreenSizeOptions {
-    width?: number | null;
-    height?: number | null;
-    landscape?: boolean;
-    screens?: Screen[];
-    mediaType?: string;
-    media?: Media | null;
-}
-interface ScreenSize {
-    screen: string | null;
-    screens: string[];
-    width: number | null;
-    height: number | null;
-    landscape: boolean;
-}
-interface UseScreenSizeFromElementOptions extends Omit<UseScreenSizeOptions, 'landscape'> {
-    withoutMaxSize?: boolean;
-}
-interface UseScreenSizeFromElementReturn {
-    ref: RefObject<Element>;
-    screenSize: ScreenSize;
-}
-declare function useScreenSizeFromElement({ width, height, ...opts }?: UseScreenSizeFromElementOptions): UseScreenSizeFromElementReturn;
-declare function useScreenSizeFromWindow(opts?: UseScreenSizeOptions): ScreenSize;
-
-declare const useWindowEvent: (event: string, callback: (...args: unknown[]) => void, enabled?: boolean) => void;
-
-export { KEYCODES, getObserver, useAnimationFrame, useDocumentEvent, useForm, useFormattedDate, useFormattedTime, useIntersectionObserver, useIsVisible, useKeyboardKeys, useLoadedFonts, useMediaApi, useMediasParser, useObserver, useQuery, useResizeObserver, useResourceTypeName, useResourceUrlGenerator, useScreenSizeFromElement, useScreenSizeFromWindow, useWindowEvent };