@panneau/core 4.0.78 → 4.1.0

package/dist/hooks.d.ts

@@ -1,6 +1,6 @@
 import { Dayjs } from 'dayjs';
-import { ReactNode, ElementType, SubmitEvent, RefObject } from 'react';
-import { MessageDescriptor } from 'react-intl';
+import { ReactNode, ComponentProps, ElementType, SyntheticEvent, RefObject } from 'react';
+import { MessageDescriptor, FormattedMessage } from 'react-intl';
 
 interface UseAnimationFrameOptions {
     disabled?: boolean;
@@ -29,6 +29,12 @@ declare const useDocumentEvent: (event: string, callback: (...args: unknown[]) =
  * 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
  */
@@ -37,14 +43,6 @@ type Label = Message | ReactNode;
  * Form control size
  */
 type ControlSize = 'lg' | 'sm' | null;
-/**
- * Generic definition
- */
-interface Definition {
-    id: string;
-    component?: string | ElementType;
-    [key: string]: unknown;
-}
 interface RouteDefinition {
     path?: string;
     route?: string;
@@ -82,8 +80,6 @@ interface Form {
     submitButtonLabel?: Label | null;
     [key: string]: unknown;
 }
-interface FormDefinition extends Form, Definition {
-}
 
 /**
  * Resource Types
@@ -96,6 +92,7 @@ interface FormDefinition extends Form, Definition {
 type TableColumn = string | Column;
 interface Column extends Record<string, unknown> {
     id?: string | null;
+    name?: string | null;
     label?: unknown;
     path?: string;
     valueKey?: string;
@@ -121,7 +118,7 @@ type ActionDefinition = string | Action;
 interface ResourceIntlValues {
     a_singular?: string;
     a_plural?: string;
-    [key: string]: unknown;
+    [key: string]: MessageValue;
 }
 /**
  * Internationalization configuration
@@ -149,13 +146,32 @@ interface ResourcePages {
     duplicate?: 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: FormDefinition | null;
-    create: FormDefinition | null;
-    edit: FormDefinition | null;
-    delete: FormDefinition | null;
-    modal: FormDefinition | null;
-    [key: string]: FormDefinition | null;
+    default?: ResourceForm | null;
+    create?: ResourceForm | null;
+    edit?: ResourceForm | null;
+    delete?: 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;
@@ -167,6 +183,7 @@ interface Resource {
     settings?: Record<string, unknown>;
     extraRoutes?: RouteDefinition[];
     pages?: ResourcePages;
+    types?: ResourceType$1[];
 }
 /**
  * Filter definition
@@ -197,7 +214,7 @@ interface RequestState {
     loading: boolean;
     error: boolean;
 }
-interface UseFormOptions {
+interface UseFormOptions<T extends FieldValue = FieldValue> {
     fields?: FieldInput[];
     action?: string | null;
     postForm?: ((action: string, data: Record<string, unknown>) => Promise<unknown>) | null;
@@ -207,28 +224,28 @@ interface UseFormOptions {
     initialGeneralError?: string | null;
     generalError?: string | null;
     setGeneralError?: ((error: string | null) => void) | null;
-    initialValue?: FieldValue | null;
-    value?: FieldValue | null;
-    setValue?: ((value: FieldValue) => 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 extends RequestState {
-    value: FieldValue | null;
-    setValue: (value: FieldValue) => void;
+interface UseFormReturn<T extends FieldValue = FieldValue> extends RequestState {
+    value: T | null;
+    setValue: (value: T) => void;
     csrfToken: string | null;
-    submit: (submitValue?: FieldValue | null) => void;
-    onSubmit: (e: SubmitEvent) => void;
+    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(opts?: UseFormOptions): UseFormReturn;
+declare function useForm<T extends FieldValue = FieldValue>(opts?: UseFormOptions<T>): UseFormReturn<T>;
 
 interface UseIsVisibleOptions {
     rootMargin?: string;
@@ -236,7 +253,7 @@ interface UseIsVisibleOptions {
     persist?: boolean;
 }
 interface UseIsVisibleResult {
-    ref: RefObject<HTMLElement>;
+    ref: RefObject<Element>;
     visible: boolean;
 }
 declare function useIsVisible({ rootMargin, threshold, persist, }?: UseIsVisibleOptions): UseIsVisibleResult;
@@ -304,7 +321,7 @@ interface Manager {
 }
 interface MediasParserOptions {
     fieldsManager: Manager;
-    screensManager: Manager;
+    screensManager?: Manager | null;
 }
 interface Media$1 {
     id?: string | null;
@@ -324,18 +341,18 @@ interface Screen$1 {
     type: string;
     [key: string]: unknown;
 }
-interface Story {
-    theme?: Story | null;
+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;
+    screensManager: Manager | null;
     constructor({ fieldsManager, screensManager }: MediasParserOptions);
-    toPath(story: Story | null): Story | null;
-    fromPath(story: Story | null, defaultMedias?: Record<string, Media$1> | null): Story | null;
+    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;
@@ -347,9 +364,10 @@ declare class MediasParser {
     };
 }
 
+type Story = Parameters<MediasParser['toPath']>[0];
 interface UseMediasParserReturn {
-    toPath: (story: unknown) => string;
-    fromPath: (story: unknown) => unknown;
+    toPath: (story: Story) => Story;
+    fromPath: (story: Story) => Story;
     parser: MediasParser;
 }
 declare function useMediasParser(): UseMediasParserReturn;
@@ -362,7 +380,7 @@ type ObserverConstructor<T> = (new (callback: (entries: T[]) => void, options?:
 interface ObserverWrapper<T> {
     subscribe: (element: Element, callback: (entry: T) => void) => void;
     unsubscribe: (element: Element, callback?: ((entry: T) => void) | null) => void;
-    observer: ReturnType<NonNullable<ObserverConstructor<T>>>;
+    observer: InstanceType<NonNullable<ObserverConstructor<T>>>;
 }
 interface ObserverOptions {
     root?: Element | null;
@@ -379,7 +397,7 @@ declare function useObserver<T>(Observer: ObserverConstructor<T>, opts?: Observe
 interface IntersectionObserverEntry {
     target: Element | null;
     time: number | null;
-    isVisible: boolean;
+    isVisible?: boolean;
     isIntersecting: boolean;
     intersectionRatio: number;
     intersectionRect: DOMRectReadOnly | null;