@panneau/core 4.0.11 → 4.0.15

package/dist/contexts.d.ts

@@ -0,0 +1,450 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, ComponentType } from 'react';
+export { RoutesContext, RoutesProvider, useRoutes, useUrlGenerator } from '@folklore/routes';
+export { TrackingContext } from '@folklore/tracking';
+
+declare class ComponentsManager {
+    components: Record<string, unknown>;
+    constructor(components?: Record<string, unknown>);
+    addComponent(name: string, component: unknown, namespace?: string | null): this;
+    addComponents(components: Record<string, unknown>, namespace?: string | null): this;
+    merge(manager: ComponentsManager, namespace?: string | null): this;
+    addNamespace(namespace: string | null): this;
+    getComponent(name: string, namespace?: string | null): unknown;
+    getComponents(namespace?: string | null): Record<string, unknown> | null;
+    hasComponent(name: string, namespace?: string | null): boolean;
+}
+
+interface Definition$1 {
+    id: string;
+    component?: unknown;
+    [key: string]: unknown;
+}
+declare class DefinitionsManager {
+    definitions: Definition$1[];
+    constructor(definitions?: Definition$1[]);
+    addDefinition(definition: Definition$1 | Definition$1[]): this;
+    addDefinitions(definitions: Definition$1[]): this;
+    merge(manager: DefinitionsManager): this;
+    getDefinition(id: string | null): Definition$1 | null;
+    getDefinitions(): Definition$1[];
+    hasDefinition(id: string): boolean;
+    getComponent(id: string): unknown;
+    getComponents(): Record<string, unknown>;
+}
+
+declare class FieldsManager extends DefinitionsManager {
+}
+
+declare const MODALS_NAMESPACE = "modals";
+declare const FIELDS_NAMESPACE = "fields";
+declare const FORMS_NAMESPACE = "forms";
+declare const FILTERS_NAMESPACE = "filters";
+declare const LISTS_NAMESPACE = "lists";
+declare const DISPLAYS_NAMESPACE = "displays";
+declare const ACTIONS_NAMESPACE = "actions";
+declare const BUTTONS_NAMESPACE = "buttons";
+declare const PAGES_NAMESPACE = "pages";
+declare const PREVIEWS_NAMESPACE = "previews";
+declare const APP_NAMESPACE = "app";
+declare const ComponentsContext: react.Context<ComponentsManager>;
+/**
+ * Hooks
+ */
+declare function useComponentsManager(namespace?: string | null): ComponentsManager;
+declare function useComponents(namespace?: string | null, defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useComponent(name: unknown, defaultComponent?: unknown, namespace?: string | null): unknown;
+/**
+ * Fields hooks
+ */
+declare function useFieldsComponentsManager(): ComponentsManager;
+declare function useFieldsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useFieldComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Forms hooks
+ */
+declare function useFormsComponentsManager(): ComponentsManager;
+declare function useFormsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useFormComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Modals hooks
+ */
+declare function useModalsComponentsManager(): ComponentsManager;
+declare function useModalsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useModalComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Filters hooks
+ */
+declare function useFiltersComponentsManager(): ComponentsManager;
+declare function useFiltersComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useFilterComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Lists hooks
+ */
+declare function useListsComponentsManager(): ComponentsManager;
+declare function useListsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useListComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Displays hooks
+ */
+declare function useDisplaysComponentsManager(): ComponentsManager;
+declare function useDisplaysComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useDisplayComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Actions hooks
+ */
+declare function useActionsComponentsManager(): ComponentsManager;
+declare function useActionsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useActionComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Buttons hooks
+ */
+declare function useButtonsComponentsManager(): ComponentsManager;
+declare function useButtonsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useButtonComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Pages hooks
+ */
+declare function usePagesComponentsManager(): ComponentsManager;
+declare function usePagesComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function usePageComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Previews hooks
+ */
+declare function usePreviewsComponentsManager(): ComponentsManager;
+declare function usePreviewsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function usePreviewComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * App hooks
+ */
+declare function useAppComponentsManager(): ComponentsManager;
+declare function useAppComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
+declare function useAppComponent(name: unknown, defaultComponent?: unknown): unknown;
+/**
+ * Provider
+ */
+interface ComponentsProviderProps {
+    children: ReactNode;
+    namespace?: string | null;
+    manager?: ComponentsManager | null;
+    components?: Record<string, unknown>;
+}
+declare function ComponentsProvider({ components, manager, namespace, children, }: ComponentsProviderProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Core UI Types
+ */
+
+/**
+ * Font definition
+ */
+interface Font {
+    name: string;
+}
+/**
+ * Tracking variables
+ */
+type TrackingVariables = Record<string, unknown>;
+
+/**
+ * Form Types
+ * TypeScript interfaces for form-related components
+ */
+
+/**
+ * Field definition
+ */
+interface Field {
+    name?: string;
+    type?: string;
+    component?: string;
+    label?: ReactNode;
+}
+
+/**
+ * Resource Types
+ * TypeScript interfaces for resources, items, users, media, and other entities
+ */
+
+interface ResourceIntlValues {
+    a_singular?: string;
+    a_plural?: string;
+    [key: string]: unknown;
+}
+/**
+ * Internationalization configuration
+ */
+interface ResourceIntl {
+    messages?: Record<string, string>;
+    values?: ResourceIntlValues;
+}
+/**
+ * Resource definition
+ */
+interface Resource {
+    id: string;
+    name: string;
+    intl?: ResourceIntl;
+    fields?: Field[];
+    forms?: Record<string, unknown>;
+    shows_in_navbar?: boolean;
+    settings?: Record<string, unknown>;
+}
+
+/**
+ * Panneau Definition Types
+ * TypeScript interfaces for main Panneau configuration and definitions
+ */
+
+/**
+ * Panneau route configuration
+ */
+interface Routes {
+    'resources.index': string;
+    'resources.create': string;
+    'resources.store': string;
+    'resources.show': string;
+    'resources.edit': string;
+    'resources.update': string;
+    'resources.delete': string;
+    'resources.destroy': string;
+    'resources.duplicate': string;
+    'resources.clone': string;
+    'resources.restore': string;
+    [key: string]: string;
+}
+/**
+ * Page definition
+ */
+interface Page {
+    component: string;
+    [key: string]: unknown;
+}
+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>;
+    values?: PanneauIntlValues;
+}
+/**
+ * Panneau definition (main configuration)
+ */
+interface PanneauDefinition {
+    name?: string;
+    resources?: Resource[];
+    routes?: Routes;
+    pages?: Record<string, Page>;
+    intl?: PanneauIntl;
+    theme?: PanneauTheme;
+    components?: PanneauComponents;
+    settings?: Record<string, unknown>;
+}
+/**
+ * Generic definition
+ */
+interface Definition {
+    name?: string;
+    [key: string]: unknown;
+}
+
+declare function useDefinitionContext(): Definition | null;
+declare function useDefinition(): Definition | null;
+interface DefinitionProviderProps {
+    definition: Definition;
+    children: ReactNode;
+}
+declare function DefinitionProvider({ definition, children }: DefinitionProviderProps): react_jsx_runtime.JSX.Element;
+
+declare const FieldsContext: react.Context<FieldsManager>;
+declare function useFieldsManager(): FieldsManager | null;
+declare function useField(id: string): Field | null;
+declare function useFields(): Field[];
+interface FieldsProviderProps {
+    fields?: Field[] | null;
+    manager?: FieldsManager | null;
+    children: ReactNode;
+}
+declare function FieldsProvider({ fields, manager, children }: FieldsProviderProps): react_jsx_runtime.JSX.Element;
+
+interface FontsContextValue {
+    systemFonts: Font[] | null;
+    googleFonts: Font[] | null;
+    customFonts: Font[] | null;
+    setGoogleFonts?: ((fonts: Font[]) => void) | null;
+}
+declare const FontsContext: react.Context<FontsContextValue>;
+declare function useGoogleFonts({ disabled, setFonts, }?: {
+    disabled?: boolean;
+    setFonts?: ((fonts: Font[]) => void) | null;
+}): Font[] | null;
+declare function useFonts({ withoutGoogleFonts, }?: {
+    withoutGoogleFonts?: boolean;
+}): FontsContextValue;
+interface FontsProviderProps {
+    children: ReactNode;
+    systemFonts?: (Font | string)[] | null;
+    customFonts?: (Font | string)[] | null;
+}
+declare function FontsProvider({ systemFonts, customFonts, children, }: FontsProviderProps): react_jsx_runtime.JSX.Element;
+
+interface FormContextValue {
+    value: Record<string, unknown>;
+    setValue: (value: Record<string, unknown>) => void;
+}
+declare function useFormContext(): FormContextValue | null;
+declare function useFormValue(): Record<string, unknown>;
+declare function useFormSetValue(): (value: Record<string, unknown>) => void;
+interface FormProviderProps {
+    value: Record<string, unknown>;
+    setValue: (value: Record<string, unknown>) => void;
+    children: ReactNode;
+}
+declare function FormProvider({ value, setValue, children }: FormProviderProps): react_jsx_runtime.JSX.Element;
+
+declare const GoogleApiClientContext: react.Context<any>;
+declare function useGoogleApiClient(): any | null;
+declare function withGoogleApiClient(WrappedComponent: ComponentType<any>): {
+    (props: any): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+interface GoogleApiClientProviderProps {
+    children: ReactNode;
+}
+declare function GoogleApiClientProvider({ children }: GoogleApiClientProviderProps): react_jsx_runtime.JSX.Element;
+
+interface GoogleKeysContextValue {
+    apiKey: string | null;
+}
+declare const GoogleKeysContext: react.Context<GoogleKeysContextValue>;
+declare function useGoogleKeys(): GoogleKeysContextValue;
+interface GoogleKeysProviderProps {
+    children: ReactNode;
+    apiKey?: string | null;
+}
+declare function GoogleKeysProvider({ children, apiKey }: GoogleKeysProviderProps): react_jsx_runtime.JSX.Element;
+
+declare const GoogleMapsClientContext: react.Context<any>;
+declare function useGoogleMapsClient(): any | null;
+declare function withGoogleMapsClient(WrappedComponent: ComponentType<any>): {
+    (props: any): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+interface GoogleMapsClientProviderProps {
+    children: ReactNode;
+    locale?: string;
+    libraries?: string[] | null;
+}
+declare function GoogleMapsClientProvider({ children, locale, libraries, }: GoogleMapsClientProviderProps): react_jsx_runtime.JSX.Element;
+
+interface LocalesContextValue {
+    locales: string[];
+}
+declare const LocalesContext: react.Context<LocalesContextValue>;
+declare function useLocalesContext(): LocalesContextValue;
+declare function useLocales(): string[];
+declare function useOtherLocales(): string[];
+interface LocalesProviderProps {
+    locales?: string[];
+    children: ReactNode;
+}
+declare function LocalesProvider({ locales, children }: LocalesProviderProps): react_jsx_runtime.JSX.Element;
+
+interface ModalData {
+    id: string;
+    onClose?: (() => void) | null;
+    [key: string]: unknown;
+}
+interface ModalContextValue {
+    modals: ModalData[];
+    container: unknown | null;
+    setContainer: (container: unknown) => void;
+    register: (id: string, data?: Record<string, unknown> | null) => void;
+    unregister: (id?: string | null, data?: Record<string, unknown> | null) => void;
+    closeLastModal: () => void;
+    getModalById: (modalId: string) => ModalData | null;
+}
+declare const ModalContext: react.Context<ModalContextValue>;
+declare function useModal(): ModalContextValue;
+interface ModalProviderProps {
+    children: ReactNode;
+    container?: unknown | null;
+}
+declare function ModalProvider({ children, container: initialContainer }: ModalProviderProps): react_jsx_runtime.JSX.Element;
+
+interface PanelData {
+    id: string;
+    [key: string]: unknown;
+}
+interface PanelsContextValue {
+    panels: PanelData[];
+    container: unknown | null;
+    setContainer: (container: unknown) => void;
+    register: (id: string, data?: Record<string, unknown> | null) => void;
+    unregister: (id: string) => void;
+}
+declare const PanelsContext: react.Context<PanelsContextValue>;
+declare function usePanels(): PanelsContextValue;
+declare function withPanels(WrappedComponent: ComponentType<any>): {
+    (props: any): react_jsx_runtime.JSX.Element;
+    displayName: string;
+};
+interface PanelsProviderProps {
+    children: ReactNode;
+    container?: unknown | null;
+}
+declare function PanelsProvider({ children, container: initialContainer }: PanelsProviderProps): react_jsx_runtime.JSX.Element;
+
+declare function usePanneau(): PanneauDefinition | null;
+declare function usePanneauResources(): Resource[];
+declare function usePanneauResource(id: string): Resource | null;
+declare function usePanneauColorScheme(): {
+    theme: string;
+    background: string | null;
+    text: string | null;
+    sidebarPosition?: string | null;
+};
+declare function usePanneauComponents(): Record<string, unknown>;
+declare function usePanneauComponent(namespace: string | null, name: string): string | null;
+declare function usePanneauAuth(): Record<string, unknown>;
+declare function usePanneauSettings(): Record<string, unknown>;
+interface PanneauProviderProps {
+    definition: PanneauDefinition;
+    children: ReactNode;
+}
+declare function PanneauProvider({ definition, children }: PanneauProviderProps): react_jsx_runtime.JSX.Element;
+
+declare function useResource(): Resource | null;
+interface ResourceProviderProps {
+    resource: Resource;
+    children: ReactNode;
+}
+declare function ResourceProvider({ resource, children }: ResourceProviderProps): react_jsx_runtime.JSX.Element;
+
+declare function useRoutePush(): (route: string | {
+    pathname?: string | null;
+    search?: string | null;
+}, data?: unknown, ...args: unknown[]) => void;
+declare function useRouteBack(): () => void;
+
+declare function useTracking(): any;
+interface TrackingProviderProps {
+    children: ReactNode;
+    variables?: TrackingVariables | null;
+}
+declare function TrackingProvider({ variables, children }: TrackingProviderProps): react_jsx_runtime.JSX.Element;
+
+export { ACTIONS_NAMESPACE, APP_NAMESPACE, BUTTONS_NAMESPACE, ComponentsContext, ComponentsProvider, DISPLAYS_NAMESPACE, DefinitionProvider, FIELDS_NAMESPACE, FILTERS_NAMESPACE, FORMS_NAMESPACE, FieldsContext, FieldsProvider, FontsContext, FontsProvider, FormProvider, GoogleApiClientContext, GoogleApiClientProvider, GoogleKeysContext, GoogleKeysProvider, GoogleMapsClientContext, GoogleMapsClientProvider, LISTS_NAMESPACE, LocalesContext, LocalesProvider, MODALS_NAMESPACE, ModalContext, ModalProvider, PAGES_NAMESPACE, PREVIEWS_NAMESPACE, PanelsContext, PanelsProvider, PanneauProvider, ResourceProvider, TrackingProvider, useActionComponent, useActionsComponents, useActionsComponentsManager, useAppComponent, useAppComponents, useAppComponentsManager, useButtonComponent, useButtonsComponents, useButtonsComponentsManager, useComponent, useComponents, useComponentsManager, useDefinition, useDefinitionContext, useDisplayComponent, useDisplaysComponents, useDisplaysComponentsManager, useField, useFieldComponent, useFields, useFieldsComponents, useFieldsComponentsManager, useFieldsManager, useFilterComponent, useFiltersComponents, useFiltersComponentsManager, useFonts, useFormComponent, useFormContext, useFormSetValue, useFormValue, useFormsComponents, useFormsComponentsManager, useGoogleApiClient, useGoogleFonts, useGoogleKeys, useGoogleMapsClient, useListComponent, useListsComponents, useListsComponentsManager, useLocales, useLocalesContext, useModal, useModalComponent, useModalsComponents, useModalsComponentsManager, useOtherLocales, usePageComponent, usePagesComponents, usePagesComponentsManager, usePanels, usePanneau, usePanneauAuth, usePanneauColorScheme, usePanneauComponent, usePanneauComponents, usePanneauResource, usePanneauResources, usePanneauSettings, usePreviewComponent, usePreviewsComponents, usePreviewsComponentsManager, useResource, useRouteBack, useRoutePush, useTracking, withGoogleApiClient, withGoogleMapsClient, withPanels };