@panneau/core 4.0.38 → 4.0.40-alpha.3

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 export { kebabCase as dashCase, pascalCase, snakeCase } from 'change-case';
-import { ComponentType, ReactNode, ReactElement } from 'react';
+import { ElementType, ReactNode, ComponentType, ReactElement } from 'react';
 import { MessageDescriptor } from 'react-intl';
 
 interface CheckClickableOptions {
@@ -26,8 +26,8 @@ declare function createUseEvent(eventsManager: EventsManager | null): (event: st
 /*! clipboard-copy. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
 declare function copyToClipboard(text: string): Promise<void>;
 
-type ComponentMap = Record<string, ComponentType<unknown> | ComponentMap>;
-declare function flattenComponents(components: ComponentMap | null, prefix?: string | null): Record<string, ComponentType<unknown>> | null;
+type ComponentMap = Record<string, ElementType | Record<string, unknown>>;
+declare function flattenComponents(components: ComponentMap | null, prefix?: string | null): Record<string, ElementType> | null;
 
 declare function formatDuration(timeInSeconds: number | string): string;
 
@@ -84,6 +84,21 @@ type TableColumn = string | {
  * 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;
@@ -99,11 +114,19 @@ 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>;
@@ -115,6 +138,14 @@ interface Item {
     id: string;
     [key: string]: unknown;
 }
+/**
+ * Filter definition
+ */
+interface Filter {
+    id?: string;
+    component?: string;
+    [key: string]: unknown;
+}
 
 /**
  * Panneau Definition Types
@@ -189,8 +220,11 @@ declare function isMessage(message: unknown): message is Message;
 
 declare function loadPackage<T = unknown>(name: string, loader: () => Promise<T>): Promise<T>;
 
-declare function selectItem(item: Item, selectedItems: Item | Item[] | null, onSelectionChange: ((value: Item | Item[] | null) => void) | null, multipleSelection?: boolean): void;
-declare function selectPage(pageSelected: boolean, items: Item[] | null, selectedItems: Item[] | null, onSelectionChange: ((value: Item[]) => void) | null): void;
+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;
@@ -204,4 +238,4 @@ interface FieldWithValidation extends Field {
 }
 declare function validateFields(fields: FieldWithValidation[], value: Record<string, unknown> | null): boolean;
 
-export { checkClickable, convertStyleToString, copyToClipboard, createNullableOnChange, createUseEvent, flattenComponents, formatDuration, getColumnsWithFields, getComponent, getComponentFromName, getDefinitionFromId, getDisplayName, getFieldByName, getFieldFromPath, getFileName, getPathValue, getSelectOptions, isMessage, loadPackage, selectItem, selectPage, setValue as setFieldValue, slug, validateFields };
+export { checkClickable, convertStyleToString, copyToClipboard, createNullableOnChange, createUseEvent, flattenComponents, formatDuration, getColumnsWithFields, getComponent, getComponentFromName, getDefinitionFromId, getDisplayName, getFieldByName, getFieldFromPath, getFileName, getPathValue, getSelectOptions, isMessage, loadPackage, selectItems, setValue as setFieldValue, slug, toggleSelectedItem, unselectItems, validateFields };