@panneau/core 4.1.0 → 4.1.1

package/dist/contexts.d.ts

@@ -162,6 +162,11 @@ interface ResourceIndex {
     fields?: Field[];
     [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;
@@ -169,6 +174,20 @@ 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;
 }
 /**
@@ -183,6 +202,7 @@ interface ResourceForms {
     create?: ResourceForm | null;
     edit?: ResourceForm | null;
     delete?: ResourceForm | null;
+    duplicate?: ResourceForm | null;
     modal?: ResourceForm | null;
     [key: string]: ResourceForm | null | undefined;
 }
@@ -258,6 +278,7 @@ interface PanneauIntl {
     locale?: string;
     locales?: string[];
     messages?: Record<string, string>;
+    /** @deprecated Not used: set the values of each resource in `resources[].intl.values` */
     values?: PanneauIntlValues;
 }
 interface PanneauPages extends ResourcePages {
@@ -276,9 +297,14 @@ interface PanneauMenus {
     guest?: PanneauMenuItem[] | null;
     [key: string]: PanneauMenuItem[] | null | undefined;
 }
+/**
+ * Links shown on the login page: `true` for the default url, or the url of the page
+ */
 interface PanneauAuth {
-    forgotPassword?: boolean;
-    register?: boolean;
+    /** "Forgot your password?" link (default url: /forgot-password) */
+    forgotPassword?: boolean | string;
+    /** "Create account" link (default url: /register) */
+    register?: boolean | string;
     [key: string]: unknown;
 }
 /**
@@ -291,6 +317,7 @@ interface PanneauDefinition {
     pages?: PanneauPages;
     intl?: PanneauIntl;
     theme?: PanneauTheme;
+    /** @deprecated Not used: give the custom components to the `components` prop of the container */
     components?: PanneauComponents;
     settings?: Record<string, unknown>;
     forms?: FormDefinition[];
@@ -604,7 +631,9 @@ declare function usePanneauColorScheme(): {
     text: 'light' | 'dark' | null;
     sidebarPosition?: string | null;
 };
+/** @deprecated The `components` key of the definition is not supported */
 declare function usePanneauComponents(): Record<string, unknown>;
+/** @deprecated The `components` key of the definition is not supported */
 declare function usePanneauComponent(namespace: string | null, name: string): string | null;
 declare function usePanneauAuth(): PanneauAuth;
 declare function usePanneauSettings(): Record<string, unknown>;

package/dist/contexts.js

@@ -1557,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
@@ -1564,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 {
@@ -1621,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);

package/dist/hooks.d.ts

@@ -137,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;
@@ -144,6 +149,20 @@ 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;
 }
 /**
@@ -158,6 +177,7 @@ interface ResourceForms {
     create?: ResourceForm | null;
     edit?: ResourceForm | null;
     delete?: ResourceForm | null;
+    duplicate?: ResourceForm | null;
     modal?: ResourceForm | null;
     [key: string]: ResourceForm | null | undefined;
 }

package/dist/index.d.ts

@@ -192,6 +192,20 @@ type SelectOption = string | number | {
     value?: unknown;
     label?: Label | string;
 } | Record<string, unknown>;
+/**
+ * Settings of a field in a resource (the `settings` key of the field)
+ */
+interface FieldSettings {
+    /** Not shown in the resource forms */
+    hiddenInForm?: boolean;
+    /** Only shown in the create form */
+    createOnly?: boolean;
+    /** Only shown in the edit form (and show page) */
+    updateOnly?: boolean;
+    /** Shown as a column of the index when the resource has no `index.columns` */
+    showInIndex?: boolean;
+    [key: string]: unknown;
+}
 /**
  * Field definition
  */
@@ -311,6 +325,11 @@ interface ResourceIndex {
     fields?: Field$2[];
     [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;
@@ -318,6 +337,20 @@ 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;
 }
 /**
@@ -332,6 +365,7 @@ interface ResourceForms {
     create?: ResourceForm | null;
     edit?: ResourceForm | null;
     delete?: ResourceForm | null;
+    duplicate?: ResourceForm | null;
     modal?: ResourceForm | null;
     [key: string]: ResourceForm | null | undefined;
 }
@@ -437,6 +471,7 @@ interface PanneauIntl {
     locale?: string;
     locales?: string[];
     messages?: Record<string, string>;
+    /** @deprecated Not used: set the values of each resource in `resources[].intl.values` */
     values?: PanneauIntlValues;
 }
 interface PanneauPages extends ResourcePages {
@@ -455,9 +490,14 @@ interface PanneauMenus {
     guest?: PanneauMenuItem[] | null;
     [key: string]: PanneauMenuItem[] | null | undefined;
 }
+/**
+ * Links shown on the login page: `true` for the default url, or the url of the page
+ */
 interface PanneauAuth {
-    forgotPassword?: boolean;
-    register?: boolean;
+    /** "Forgot your password?" link (default url: /forgot-password) */
+    forgotPassword?: boolean | string;
+    /** "Create account" link (default url: /register) */
+    register?: boolean | string;
     [key: string]: unknown;
 }
 /**
@@ -470,6 +510,7 @@ interface PanneauDefinition {
     pages?: PanneauPages;
     intl?: PanneauIntl;
     theme?: PanneauTheme;
+    /** @deprecated Not used: give the custom components to the `components` prop of the container */
     components?: PanneauComponents;
     settings?: Record<string, unknown>;
     forms?: FormDefinition[];
@@ -648,4 +689,4 @@ declare class Tracking extends Tracking$1 {
 }
 
 export { ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, FormsManager, MediasParser, Tracking };
-export type { Action, ActionDefinition, ActionValue, AudioMedia, Breadcrumb, BreakpointsSize, Button, ButtonElement, ButtonSize, ButtonTheme, ButtonType, Column, ComponentsMap, ControlSize, Definition$1 as Definition, DialogSize, DropdownAlign, Feedback, Field$2 as Field, FieldDefinition, FieldOption, Filter, Font$1 as Font, Form, FormDefinition, FormError, FormStatus, ImageMedia, Item, Label, Media$2 as Media, MediaFile, MediaType, MenuItem, Message, MessageValue, MessageValues, Modal, PageDefinition, Pagination, PanneauAuth, PanneauComponents, PanneauDefinition, PanneauIntl, PanneauIntlValues, PanneauMenuItem, PanneauMenus, PanneauPages, PanneauTheme, Preview, Resource, ResourceForm, ResourceForms, ResourceIndex, ResourceIntl, ResourceIntlValues, ResourceItem, ResourcePages, ResourceType, RouteDefinition, Routes, SelectOption, StatusCode, TableColumn, Toggle, TrackingVariables, TriggerUpdate, Uppy, User, VideoMedia, uppy };
+export type { Action, ActionDefinition, ActionValue, AudioMedia, Breadcrumb, BreakpointsSize, Button, ButtonElement, ButtonSize, ButtonTheme, ButtonType, Column, ComponentsMap, ControlSize, Definition$1 as Definition, DialogSize, DropdownAlign, Feedback, Field$2 as Field, FieldDefinition, FieldOption, FieldSettings, Filter, Font$1 as Font, Form, FormDefinition, FormError, FormStatus, ImageMedia, Item, Label, Media$2 as Media, MediaFile, MediaType, MenuItem, Message, MessageValue, MessageValues, Modal, PageDefinition, Pagination, PanneauAuth, PanneauComponents, PanneauDefinition, PanneauIntl, PanneauIntlValues, PanneauMenuItem, PanneauMenus, PanneauPages, PanneauTheme, Preview, Resource, ResourceForm, ResourceForms, ResourceIndex, ResourceIntl, ResourceIntlValues, ResourceItem, ResourcePages, ResourceType, RouteDefinition, Routes, SelectOption, StatusCode, TableColumn, Toggle, TrackingVariables, TriggerUpdate, Uppy, User, VideoMedia, uppy };

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 export { kebabCase as dashCase, pascalCase, snakeCase } from 'change-case';
-import { ElementType, ComponentProps, ReactNode, ReactElement, ForwardedRef } from 'react';
+import { ElementType, ComponentProps, ReactNode, MouseEvent, ReactElement, ForwardedRef } from 'react';
 import { FormattedMessage, MessageDescriptor } from 'react-intl';
 
 interface CheckClickableOptions {
@@ -50,6 +50,24 @@ type Label = Message | ReactNode;
 interface ComponentsMap {
     [name: string]: ElementType | ComponentsMap;
 }
+/**
+ * Menu item definition
+ */
+interface MenuItem {
+    id?: number | string;
+    label?: Label;
+    url?: string;
+    href?: string | null;
+    external?: boolean;
+    active?: boolean;
+    type?: string;
+    component?: string;
+    className?: string | null;
+    linkClassName?: string | null;
+    onClick?: ((e: MouseEvent) => void) | null;
+    items?: MenuItem[] | null;
+    dropdown?: MenuItem[] | null;
+}
 /**
  * Form control size
  */
@@ -102,6 +120,8 @@ interface Field {
     size?: ControlSize;
     [key: string]: unknown;
 }
+interface FieldDefinition$1 extends Omit<Field, 'component'>, Definition {
+}
 /**
  * Form definition
  */
@@ -113,6 +133,8 @@ interface Form {
     submitButtonLabel?: Label | null;
     [key: string]: unknown;
 }
+interface FormDefinition extends Form, Definition {
+}
 
 /**
  * Resource Types
@@ -170,6 +192,11 @@ interface ResourceIndex {
     fields?: Field[];
     [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;
@@ -177,6 +204,20 @@ 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;
 }
 /**
@@ -191,6 +232,7 @@ interface ResourceForms {
     create?: ResourceForm | null;
     edit?: ResourceForm | null;
     delete?: ResourceForm | null;
+    duplicate?: ResourceForm | null;
     modal?: ResourceForm | null;
     [key: string]: ResourceForm | null | undefined;
 }
@@ -227,6 +269,93 @@ interface Filter {
     [key: string]: unknown;
 }
 
+/**
+ * Panneau Definition Types
+ * TypeScript interfaces for main Panneau configuration and definitions
+ */
+
+/**
+ * Panneau route configuration
+ */
+interface Routes {
+    'resources.index'?: RouteDefinition | string;
+    'resources.create'?: RouteDefinition | string;
+    'resources.store'?: RouteDefinition | string;
+    'resources.show'?: RouteDefinition | string;
+    'resources.edit'?: RouteDefinition | string;
+    'resources.update'?: RouteDefinition | string;
+    'resources.delete'?: RouteDefinition | string;
+    'resources.destroy'?: RouteDefinition | string;
+    'resources.duplicate'?: RouteDefinition | string;
+    'resources.clone'?: RouteDefinition | string;
+    'resources.restore'?: RouteDefinition | string;
+    [key: string]: RouteDefinition | string;
+}
+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>;
+    /** @deprecated Not used: set the values of each resource in `resources[].intl.values` */
+    values?: PanneauIntlValues;
+}
+interface PanneauPages extends ResourcePages {
+    home?: PageDefinition;
+    login?: PageDefinition;
+    account?: PageDefinition;
+    error?: PageDefinition;
+}
+/**
+ * Menu item in a Panneau menu: a menu item definition or a special item id
+ * (ex: 'resources', 'account', 'separator')
+ */
+type PanneauMenuItem = MenuItem | string;
+interface PanneauMenus {
+    main?: PanneauMenuItem[] | null;
+    guest?: PanneauMenuItem[] | null;
+    [key: string]: PanneauMenuItem[] | null | undefined;
+}
+/**
+ * Links shown on the login page: `true` for the default url, or the url of the page
+ */
+interface PanneauAuth {
+    /** "Forgot your password?" link (default url: /forgot-password) */
+    forgotPassword?: boolean | string;
+    /** "Create account" link (default url: /register) */
+    register?: boolean | string;
+    [key: string]: unknown;
+}
+/**
+ * Panneau definition (main configuration)
+ */
+interface PanneauDefinition {
+    name?: string;
+    resources?: Resource[];
+    routes?: Routes;
+    pages?: PanneauPages;
+    intl?: PanneauIntl;
+    theme?: PanneauTheme;
+    /** @deprecated Not used: give the custom components to the `components` prop of the container */
+    components?: PanneauComponents;
+    settings?: Record<string, unknown>;
+    forms?: FormDefinition[];
+    fields?: FieldDefinition$1[];
+    menus?: PanneauMenus;
+    auth?: PanneauAuth;
+}
+
 declare function flattenComponents(components: ComponentsMap | null, prefix?: string | null): Record<string, ElementType> | null;
 
 declare function formatDuration(timeInSeconds: number | string): string;
@@ -246,6 +375,12 @@ declare function getComponentFromName(name?: string | ElementType | null, compon
 
 declare function getDefinitionFromId<T extends Definition = Definition>(id?: string | null, items?: T[] | null, defaultObject?: T | null): T | null;
 
+/**
+ * Returns a message for each key of the definition that is not supported anymore,
+ * with the key to use instead. Without it, these keys would be silently ignored.
+ */
+declare function getDefinitionWarnings(definition: PanneauDefinition | null): string[];
+
 interface ComponentWithName {
     displayName?: string | null;
     name?: string | null;
@@ -319,4 +454,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, mergeRefs, parseDateOnly, selectItems, setValue as setFieldValue, slug, toggleSelectedItem, unselectItems, validateFields };
+export { checkClickable, convertStyleToString, copyToClipboard, createNullableOnChange, createUseEvent, flattenComponents, formatDuration, getColumnsWithFields, getComponent, getComponentFromName, getDefinitionFromId, getDefinitionWarnings, getDisplayName, getFieldByName, getFieldFromPath, getFileName, getPathValue, getSelectOptions, isMessage, loadPackage, mergeRefs, parseDateOnly, selectItems, setValue as setFieldValue, slug, toggleSelectedItem, unselectItems, validateFields };

package/dist/utils.js

@@ -262,6 +262,33 @@ function getDefinitionFromId(id = null, items = [], defaultObject = null) {
   return items.find(i => i.id === pascalId) || items.find(i => i.id === id) || defaultObject;
 }
 
+/**
+ * Returns a message for each key of the definition that is not supported anymore,
+ * with the key to use instead. Without it, these keys would be silently ignored.
+ */
+function getDefinitionWarnings(definition) {
+  if (!isObject(definition)) {
+    return [];
+  }
+  const {
+    components = null,
+    intl = null,
+    theme = null,
+    resources = []
+  } = definition;
+  const {
+    values = null
+  } = intl || {};
+  return [...(components !== null ? ['`components` is not supported: give the custom components to the `components` prop of the container.'] : []), ...(values !== null ? ['`intl.values` is not supported: set the values of each resource in `resources[].intl.values`.'] : []), ...Object.keys(theme || {}).filter(key => key !== 'colorScheme').map(key => `\`theme.${key}\` is not supported: only \`theme.colorScheme\` is.`), ...(resources || []).reduce((warnings, resource) => {
+    const {
+      id,
+      components: resourceComponents = null,
+      columns = null
+    } = resource;
+    return [...warnings, ...(resourceComponents !== null ? [`\`resources[${id}].components\` is not supported: use \`index.component\`, \`forms.default.component\` and \`pages\`.`] : []), ...(columns !== null ? [`\`resources[${id}].columns\` is not supported: use \`index.columns\`.`] : [])];
+  }, [])];
+}
+
 function getDisplayName({
   displayName = null,
   name = null
@@ -527,4 +554,4 @@ function validateFields(fields, value) {
   }, true);
 }
 
-export { checkClickable, convertStyleToString, copyToClipboard, createNullableOnChange, createUseEvent, flattenComponents, formatDuration, getColumnsWithFields, getComponent, getComponentFromName, getDefinitionFromId, getDisplayName, getFieldByName, getFieldFromPath, getFileName, getPathValue, getSelectOptions, isMessage, loadPackage, mergeRefs, parseDateOnly, selectItems, setValue as setFieldValue, slug, toggleSelectedItem, unselectItems, validateFields };
+export { checkClickable, convertStyleToString, copyToClipboard, createNullableOnChange, createUseEvent, flattenComponents, formatDuration, getColumnsWithFields, getComponent, getComponentFromName, getDefinitionFromId, getDefinitionWarnings, getDisplayName, getFieldByName, getFieldFromPath, getFileName, getPathValue, getSelectOptions, isMessage, loadPackage, mergeRefs, parseDateOnly, selectItems, setValue as setFieldValue, slug, toggleSelectedItem, unselectItems, validateFields };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@panneau/core",
-    "version": "4.1.0",
+    "version": "4.1.1",
     "description": "",
     "keywords": [
         "javascript"
@@ -96,5 +96,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "8a6accc1aab59368bf546c83b9433dfe94ccf767"
+    "gitHead": "28b394278cffa0c927989873dd4b3f184635ceff"
 }