@panneau/core 4.0.78 → 4.1.1

package/dist/contexts.js

@@ -37,7 +37,7 @@ function useComponentsManager(t0) {
   const manager = useContext(ComponentsContext);
   let t1;
   if ($[0] !== manager || $[1] !== namespace) {
-    t1 = namespace !== null ? new ComponentsManager(manager.getComponents(namespace)) : manager;
+    t1 = namespace !== null ? new ComponentsManager(manager?.getComponents(namespace) ?? {}) : manager;
     $[0] = manager;
     $[1] = namespace;
     $[2] = t1;
@@ -62,7 +62,7 @@ function useComponents(t0, t1) {
   const manager = useComponentsManager();
   let t3;
   if ($[2] !== defaultComponents || $[3] !== manager || $[4] !== namespace) {
-    t3 = manager.getComponents(namespace) || defaultComponents;
+    t3 = manager?.getComponents(namespace) || defaultComponents;
     $[2] = defaultComponents;
     $[3] = manager;
     $[4] = namespace;
@@ -85,7 +85,7 @@ function useComponent(name, t0, t1) {
     }
     let t3;
     if ($[0] !== defaultComponent || $[1] !== manager || $[2] !== name) {
-      t3 = manager.getComponent(name) || defaultComponent;
+      t3 = manager?.getComponent(name) || defaultComponent;
       $[0] = defaultComponent;
       $[1] = manager;
       $[2] = name;
@@ -482,7 +482,7 @@ function FieldsProvider(t0) {
   const previousManager = useFieldsManager() || null;
   let t3;
   if ($[0] !== fields || $[1] !== manager || $[2] !== previousManager) {
-    const newFields = uniqBy([...(fields || []), ...(manager !== null ? manager.getDefinitions() : []), ...(previousManager !== null ? previousManager.getDefinitions() : [])], _temp$2).reverse();
+    const newFields = uniqBy([...(fields || []), ...(manager !== null ? manager.getDefinitions() : []), ...(previousManager !== null ? previousManager.getDefinitions() : [])], _temp$3).reverse();
     t3 = new FieldsManager(newFields);
     $[0] = fields;
     $[1] = manager;
@@ -535,7 +535,7 @@ function FieldsProvider(t0) {
   }
   return t6;
 }
-function _temp$2(t0) {
+function _temp$3(t0) {
   const {
     id
   } = t0;
@@ -622,7 +622,7 @@ function useGoogleFonts(t0) {
           } = t6;
           const items = t7 === undefined ? [] : t7;
           if (!canceled) {
-            const newFonts = items.map(_temp$1);
+            const newFonts = items.map(_temp$2);
             if (setFonts !== null) {
               setFonts(newFonts);
             } else {
@@ -648,7 +648,7 @@ function useGoogleFonts(t0) {
   useEffect(t4, t5);
   return googleFonts;
 }
-function _temp$1(it) {
+function _temp$2(it) {
   return {
     type: "google",
     name: it.family,
@@ -890,7 +890,7 @@ function FormsProvider(t0) {
   const previousManager = useFormsManager() || null;
   let t3;
   if ($[0] !== forms || $[1] !== manager || $[2] !== previousManager) {
-    const newForms = uniqBy([...(forms || []), ...(manager !== null ? manager.getDefinitions() : []), ...(previousManager !== null ? previousManager.getDefinitions() : [])], _temp).reverse();
+    const newForms = uniqBy([...(forms || []), ...(manager !== null ? manager.getDefinitions() : []), ...(previousManager !== null ? previousManager.getDefinitions() : [])], _temp$1).reverse();
     t3 = new FormsManager(newForms);
     $[0] = forms;
     $[1] = manager;
@@ -943,7 +943,7 @@ function FormsProvider(t0) {
   }
   return t6;
 }
-function _temp(t0) {
+function _temp$1(t0) {
   const {
     id
   } = t0;
@@ -981,6 +981,9 @@ function withGoogleApiClient(WrappedComponent) {
   WithGoogleApiClientComponent.displayName = `WithGoogleApiClient(${getDisplayName(WrappedComponent)})`;
   return WithGoogleApiClientComponent;
 }
+
+// Minimal shape of the Google API (gapi) object used here, @folklore/services types it as unknown
+
 function GoogleApiClientProvider(t0) {
   const $ = c(6);
   const {
@@ -1039,7 +1042,7 @@ function withGoogleMapsClient(WrappedComponent) {
     if ($[0] !== props) {
       t0 = /*#__PURE__*/jsx(GoogleMapsClientContext.Consumer, {
         children: client => /*#__PURE__*/jsx(WrappedComponent, {
-          googleApiClient: client,
+          googleMapsClient: client,
           ...props
         })
       });
@@ -1342,7 +1345,7 @@ const PanelsContext = /*#__PURE__*/createContext({
   unregister: () => {}
 });
 function usePanels() {
-  return useContext(PanelsContext) || {};
+  return useContext(PanelsContext);
 }
 function withPanels(WrappedComponent) {
   function WithPanelsComponent(props) {
@@ -1554,6 +1557,8 @@ function usePanneauColorScheme() {
   return t3;
 }
 const DEFAULT_COMPONENTS = {};
+
+/** @deprecated The `components` key of the definition is not supported */
 function usePanneauComponents() {
   const {
     components: t0
@@ -1561,6 +1566,8 @@ function usePanneauComponents() {
   const components = t0 === undefined ? DEFAULT_COMPONENTS : t0;
   return components;
 }
+
+/** @deprecated The `components` key of the definition is not supported */
 function usePanneauComponent(namespace, name) {
   const $ = c(2);
   const {
@@ -1618,24 +1625,38 @@ function usePanneauSettings() {
   return settings;
 }
 function PanneauProvider(t0) {
-  const $ = c(3);
+  const $ = c(6);
   const {
     definition,
     children
   } = t0;
   let t1;
-  if ($[0] !== children || $[1] !== definition) {
-    t1 = /*#__PURE__*/jsx(PanneauContext, {
+  let t2;
+  if ($[0] !== definition) {
+    t1 = () => {
+    };
+    t2 = [definition];
+    $[0] = definition;
+    $[1] = t1;
+    $[2] = t2;
+  } else {
+    t1 = $[1];
+    t2 = $[2];
+  }
+  useEffect(t1, t2);
+  let t3;
+  if ($[3] !== children || $[4] !== definition) {
+    t3 = /*#__PURE__*/jsx(PanneauContext, {
       value: definition,
       children: children
     });
-    $[0] = children;
-    $[1] = definition;
-    $[2] = t1;
+    $[3] = children;
+    $[4] = definition;
+    $[5] = t3;
   } else {
-    t1 = $[2];
+    t3 = $[5];
   }
-  return t1;
+  return t3;
 }
 
 const ResourceContext = /*#__PURE__*/createContext(null);
@@ -1693,20 +1714,14 @@ function useRoutePush() {
   return push;
 }
 function useRouteBack() {
-  const $ = c(2);
-  useUrlGenerator();
-  const [, navigate] = useLocation();
-  let t0;
-  if ($[0] !== navigate) {
-    t0 = () => navigate(-1);
-    $[0] = navigate;
-    $[1] = t0;
-  } else {
-    t0 = $[1];
-  }
-  const back = t0;
+  const back = _temp;
   return back;
 }
+function _temp() {
+  if (typeof window !== "undefined") {
+    window.history.back();
+  }
+}
 
 function useTracking() {
   return useContext(TrackingContext);

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
@@ -140,6 +137,11 @@ interface ResourceIndex {
     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;
@@ -147,15 +149,49 @@ interface ResourcePages {
     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: 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;
+    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;
@@ -167,6 +203,7 @@ interface Resource {
     settings?: Record<string, unknown>;
     extraRoutes?: RouteDefinition[];
     pages?: ResourcePages;
+    types?: ResourceType$1[];
 }
 /**
  * Filter definition
@@ -197,7 +234,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 +244,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 +273,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 +341,7 @@ interface Manager {
 }
 interface MediasParserOptions {
     fieldsManager: Manager;
-    screensManager: Manager;
+    screensManager?: Manager | null;
 }
 interface Media$1 {
     id?: string | null;
@@ -324,18 +361,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 +384,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 +400,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 +417,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;