@panneau/core 4.0.37 → 4.0.40-alpha.1

package/dist/contexts.d.ts

@@ -1,18 +1,18 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
-import { ReactNode, ComponentType } from 'react';
+import { ElementType, 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;
+    components: Record<string, ElementType>;
+    constructor(components?: Record<string, ElementType>);
+    addComponent(name: string, component: ElementType, namespace?: string | null): this;
+    addComponents(components: Record<string, ElementType>, 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;
+    getComponent(name: string, namespace?: string | null): ElementType | null;
+    getComponents(namespace?: string | null): Record<string, ElementType> | null;
     hasComponent(name: string, namespace?: string | null): boolean;
 }
 
@@ -53,74 +53,74 @@ 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;
+declare function useComponents(namespace?: string | null, defaultComponents?: Record<string, ElementType>): Record<string, ElementType>;
+declare function useComponent(name: string | ElementType | null, defaultComponent?: ElementType | null, namespace?: string | null): ElementType | null;
 /**
  * Fields hooks
  */
 declare function useFieldsComponentsManager(): ComponentsManager;
-declare function useFieldsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useFieldComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useFieldsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useFieldComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Forms hooks
  */
 declare function useFormsComponentsManager(): ComponentsManager;
-declare function useFormsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useFormComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useFormsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useFormComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Modals hooks
  */
 declare function useModalsComponentsManager(): ComponentsManager;
-declare function useModalsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useModalComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useModalsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useModalComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Filters hooks
  */
 declare function useFiltersComponentsManager(): ComponentsManager;
-declare function useFiltersComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useFilterComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useFiltersComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useFilterComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Lists hooks
  */
 declare function useListsComponentsManager(): ComponentsManager;
-declare function useListsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useListComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useListsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useListComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Displays hooks
  */
 declare function useDisplaysComponentsManager(): ComponentsManager;
-declare function useDisplaysComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useDisplayComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useDisplaysComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useDisplayComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Actions hooks
  */
 declare function useActionsComponentsManager(): ComponentsManager;
-declare function useActionsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useActionComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useActionsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useActionComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Buttons hooks
  */
 declare function useButtonsComponentsManager(): ComponentsManager;
-declare function useButtonsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useButtonComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useButtonsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useButtonComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Pages hooks
  */
 declare function usePagesComponentsManager(): ComponentsManager;
-declare function usePagesComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function usePageComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function usePagesComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function usePageComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Previews hooks
  */
 declare function usePreviewsComponentsManager(): ComponentsManager;
-declare function usePreviewsComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function usePreviewComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function usePreviewsComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function usePreviewComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * App hooks
  */
 declare function useAppComponentsManager(): ComponentsManager;
-declare function useAppComponents(defaultComponents?: Record<string, unknown>): Record<string, unknown>;
-declare function useAppComponent(name: unknown, defaultComponent?: unknown): unknown;
+declare function useAppComponents(defaultComponents?: {}): Record<string, ElementType>;
+declare function useAppComponent(name: any, defaultComponent?: any): ElementType;
 /**
  * Provider
  */
@@ -128,7 +128,7 @@ interface ComponentsProviderProps {
     children: ReactNode;
     namespace?: string | null;
     manager?: ComponentsManager | null;
-    components?: Record<string, unknown>;
+    components?: Record<string, ElementType>;
 }
 declare function ComponentsProvider({ components, manager, namespace, children, }: ComponentsProviderProps): react_jsx_runtime.JSX.Element;
 
@@ -161,12 +161,37 @@ interface Field {
     component?: string;
     label?: ReactNode;
 }
+/**
+ * Table column definition
+ */
+type TableColumn = string | {
+    id?: string;
+    component?: string;
+    path?: string;
+    field?: string;
+    columnClassName?: string;
+};
 
 /**
  * Resource Types
  * TypeScript interfaces for resources, items, users, media, and other entities
  */
 
+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;
+    withConfirmation?: boolean;
+    [key: string]: unknown;
+}
+type ActionDefinition = string | Action;
 interface ResourceIntlValues {
     a_singular?: string;
     a_plural?: string;
@@ -182,15 +207,31 @@ interface ResourceIntl {
 /**
  * Resource definition
  */
+interface ResourceIndex {
+    filters?: Filter[];
+    columns?: TableColumn[];
+    actions?: ActionDefinition[];
+    fields?: Field[];
+    [key: string]: unknown;
+}
 interface Resource {
     id: string;
     name: string;
     intl?: ResourceIntl;
     fields?: Field[];
+    index?: ResourceIndex;
     forms?: Record<string, unknown>;
     shows_in_navbar?: boolean;
     settings?: Record<string, unknown>;
 }
+/**
+ * Filter definition
+ */
+interface Filter {
+    id?: string;
+    component?: string;
+    [key: string]: unknown;
+}
 
 /**
  * Panneau Definition Types
@@ -365,7 +406,8 @@ declare function LocalesProvider({ locales, children }: LocalesProviderProps): r
 
 interface ModalData {
     id: string;
-    onClose?: (() => void) | null;
+    requestClose?: (() => void) | null;
+    withoutBackdrop?: boolean;
     [key: string]: unknown;
 }
 interface ModalContextValue {
@@ -374,6 +416,7 @@ interface ModalContextValue {
     setContainer: (container: unknown) => void;
     register: (id: string, data?: Record<string, unknown> | null) => void;
     unregister: (id?: string | null) => void;
+    closeModal: (id: string) => void;
     closeLastModal: () => void;
     getModalById: (modalId: string) => ModalData | null;
 }
@@ -410,7 +453,7 @@ declare function PanelsProvider({ children, container: initialContainer }: Panel
 
 declare function usePanneau(): PanneauDefinition | null;
 declare function usePanneauResources(): Resource[];
-declare function usePanneauResource(id: string): Resource | null;
+declare function usePanneauResource(id: Resource | string | null): Resource | null;
 declare function usePanneauColorScheme(): {
     theme: string;
     background: string | null;
@@ -448,3 +491,4 @@ interface TrackingProviderProps {
 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 };
+export type { ModalContextValue, ModalData };