@panneau/core 4.0.74 → 4.0.78

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ElementType, ReactNode, MouseEvent } from 'react';
 import EventEmitter from 'wolfy87-eventemitter';
-import { Tracking as Tracking$1 } from '@folklore/tracking';
 import { MessageDescriptor } from 'react-intl';
+import { Tracking as Tracking$1 } from '@folklore/tracking';
 
 declare class ComponentsManager {
     components: Record<string, ElementType>;
@@ -10,7 +10,7 @@ declare class ComponentsManager {
     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): ElementType | null;
+    getComponent(name: string | ElementType, namespace?: string | null): ElementType | null;
     getComponents(namespace?: string | null): Record<string, ElementType> | null;
     hasComponent(name: string, namespace?: string | null): boolean;
 }
@@ -20,14 +20,14 @@ interface Definition$1 {
     component?: unknown;
     [key: string]: unknown;
 }
-declare class DefinitionsManager {
-    definitions: Definition$1[];
-    constructor(definitions?: Definition$1[]);
-    addDefinition(definition: Definition$1 | Definition$1[]): this;
-    addDefinitions(definitions: Definition$1[]): this;
-    merge(manager: DefinitionsManager): this;
-    getDefinition(id: string | null): Definition$1 | null;
-    getDefinitions(): Definition$1[];
+declare class DefinitionsManager<T extends Definition$1 = Definition$1> {
+    definitions: T[];
+    constructor(definitions?: T[]);
+    addDefinition(definition: T | T[]): this;
+    addDefinitions(definitions: T[]): this;
+    merge(manager: DefinitionsManager<T>): this;
+    getDefinition(id: string | null): T | null;
+    getDefinitions(): T[];
     hasDefinition(id: string): boolean;
     getComponent(id: string): unknown;
     getComponents(): Record<string, unknown>;
@@ -45,140 +45,6 @@ declare class EventsManager extends EventEmitter {
     removeEventListener(event: string): void;
 }
 
-declare class FieldsManager extends DefinitionsManager {
-}
-
-interface Manager$1 {
-    getDefinition: (type: string) => Record<string, unknown> | null;
-}
-interface FontsParserOptions {
-    fieldsManager: Manager$1;
-    screensManager: Manager$1;
-}
-interface Font$1 {
-    name?: string;
-    type?: string;
-    [key: string]: unknown;
-}
-interface Field$2 {
-    id?: string | null;
-    name?: string | null;
-    type?: string | null;
-    fields?: Field$2[];
-    itemsField?: Field$2 | null;
-    settings?: Field$2[];
-    [key: string]: unknown;
-}
-interface Screen$2 {
-    type: string;
-    [key: string]: unknown;
-}
-interface Story$1 {
-    theme?: Story$1 | null;
-    components?: Screen$2[];
-    fonts?: Font$1[];
-    [key: string]: unknown;
-}
-declare class FontsParser {
-    fieldsManager: Manager$1;
-    screensManager: Manager$1;
-    constructor({ fieldsManager, screensManager }: FontsParserOptions);
-    parse(story: Story$1 | null): Story$1 | null;
-    getFieldsPattern(fields: Field$2[], namePrefix?: string | null): RegExp[];
-    static fieldIsFontFamily({ id }: Field$2): boolean;
-    static valueIsFont({ type }: Record<string, unknown>): boolean;
-    static extractFontsWithPaths(data: unknown, patterns: RegExp[], keyPrefix?: string | null): Font$1[];
-}
-
-declare class FormsManager extends ComponentsManager {
-}
-
-interface Manager {
-    getDefinition: (type: string) => Record<string, unknown> | null;
-}
-interface MediasParserOptions {
-    fieldsManager: Manager;
-    screensManager: Manager;
-}
-interface Media$2 {
-    id?: string | null;
-    [key: string]: unknown;
-}
-interface Field$1 {
-    id?: string | null;
-    name?: string | null;
-    type?: string | null;
-    media?: boolean;
-    fields?: Field$1[];
-    itemsField?: Field$1 | null;
-    settings?: Field$1[];
-    [key: string]: unknown;
-}
-interface Screen$1 {
-    type: string;
-    [key: string]: unknown;
-}
-interface Story {
-    theme?: Story | null;
-    components?: Screen$1[];
-    medias?: Record<string, Media$2> | null;
-    [key: string]: unknown;
-}
-declare class MediasParser {
-    fieldsManager: Manager;
-    screensManager: Manager;
-    constructor({ fieldsManager, screensManager }: MediasParserOptions);
-    toPath(story: Story | null): Story | null;
-    fromPath(story: Story | null, defaultMedias?: Record<string, Media$2> | null): Story | null;
-    getMediaFieldsPattern(fields: Field$1[], namePrefix?: string | null): RegExp[];
-    static fieldIsMedia({ media }: Field$1): boolean;
-    static fieldIsFontFamily({ id }: Field$1): boolean;
-    static replacePathsWithMedias(data: unknown, medias: Record<string, Media$2>, patterns: RegExp[], keyPrefix?: string | null): unknown;
-    static getMediaPath({ id }: Media$2): string | null;
-    static replaceMediasWithPaths(data: unknown, patterns: RegExp[], medias?: Record<string, Media$2> | null, keyPrefix?: string | null): {
-        data: unknown;
-        medias: Record<string, Media$2> | null;
-    };
-}
-
-interface TrackingOptions {
-    variables?: Record<string, unknown> | null;
-    [key: string]: unknown;
-}
-interface Screen {
-    id?: string | null;
-    type?: string | null;
-    [key: string]: unknown;
-}
-interface Media$1 {
-    id?: string | null;
-    name?: string | null;
-    duration?: number | null;
-    currentTime?: number | null;
-    [key: string]: unknown;
-}
-interface TrackingEventOptions {
-    value?: number | null;
-    [key: string]: unknown;
-}
-declare class Tracking extends Tracking$1 {
-    variables: Record<string, unknown> | null;
-    constructor(opts?: TrackingOptions);
-    setVariables(variables: Record<string, unknown> | null): void;
-    getVariables(): Record<string, unknown> | null;
-    trackScreenView(screen: Screen | null, screenIndex: number): void;
-    trackEvent(category: string, action: string, label: string, { value, ...opts }?: TrackingEventOptions): void;
-    trackMedia(type: string, media: Media$1 | null, action: string, { value, ...opts }?: TrackingEventOptions): void;
-}
-
-/**
- * User definition
- */
-interface User {
-    id?: number | string;
-    [key: string]: unknown;
-}
-
 /**
  * Core UI Types
  */
@@ -186,10 +52,7 @@ interface User {
 /**
  * Internationalization message definition
  */
-interface Message extends MessageDescriptor {
-    id: string;
-    defaultMessage?: string;
-}
+type Message = MessageDescriptor;
 /**
  * Label can be either a message object or any React node
  */
@@ -231,10 +94,14 @@ interface Button {
  * Button theme variants (Bootstrap 5)
  */
 type ButtonTheme = 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark' | null;
+/**
+ * Breakpoints size variants
+ */
+type BreakpointsSize = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | null;
 /**
  * Button size variants
  */
-type ButtonSize = 'lg' | 'md' | 'sm' | null;
+type ButtonSize = 'lg' | 'sm' | null;
 /**
  * Button type attribute
  */
@@ -247,6 +114,10 @@ type DropdownAlign = 'start' | 'end';
  * Form control size
  */
 type ControlSize = 'lg' | 'sm' | null;
+/**
+ * Dialog size
+ */
+type DialogSize = 'xl' | 'lg' | 'sm' | null;
 /**
  * Form status states
  */
@@ -277,7 +148,7 @@ interface Breadcrumb {
 /**
  * Font definition
  */
-interface Font {
+interface Font$1 {
     name: string;
 }
 /**
@@ -297,6 +168,23 @@ interface Item {
     id: string;
     [key: string]: unknown;
 }
+/**
+ * Generic definition
+ */
+interface Definition {
+    id: string;
+    component?: string | ElementType;
+    [key: string]: unknown;
+}
+interface RouteDefinition {
+    path?: string;
+    route?: string;
+    component: string | ElementType;
+    [key: string]: unknown;
+}
+interface PageDefinition {
+    component: string | ElementType;
+}
 
 /**
  * Form Types
@@ -320,18 +208,162 @@ type SelectOption = string | number | {
 /**
  * Field definition
  */
-interface Field {
+interface Field$2 {
     name?: string;
     type?: string;
-    component?: string | ElementType;
-    label?: ReactNode;
+    label?: Label;
+    component?: string;
+    size?: ControlSize;
+    [key: string]: unknown;
+}
+interface FieldDefinition extends Omit<Field$2, 'component'>, Definition {
 }
 /**
  * Form definition
  */
 interface Form {
-    title: ReactNode;
+    title?: ReactNode;
+    fields?: Field$2[];
+    method?: string | null;
+    action?: string | null;
+    submitButtonLabel?: Label | null;
+    [key: string]: unknown;
+}
+interface FormDefinition extends Form, Definition {
+}
+
+declare class FieldsManager extends DefinitionsManager<FieldDefinition> {
+}
+
+interface Manager$1 {
+    getDefinition: (type: string) => Record<string, unknown> | null;
+}
+interface FontsParserOptions {
+    fieldsManager: Manager$1;
+    screensManager: Manager$1;
+}
+interface Font {
+    name?: string;
+    type?: string;
+    [key: string]: unknown;
+}
+interface Field$1 {
+    id?: string | null;
+    name?: string | null;
+    type?: string | null;
+    fields?: Field$1[];
+    itemsField?: Field$1 | null;
+    settings?: Field$1[];
+    [key: string]: unknown;
+}
+interface Screen$2 {
+    type: string;
+    [key: string]: unknown;
+}
+interface Story$1 {
+    theme?: Story$1 | null;
+    components?: Screen$2[];
+    fonts?: Font[];
+    [key: string]: unknown;
+}
+declare class FontsParser {
+    fieldsManager: Manager$1;
+    screensManager: Manager$1;
+    constructor({ fieldsManager, screensManager }: FontsParserOptions);
+    parse(story: Story$1 | null): Story$1 | null;
+    getFieldsPattern(fields: Field$1[], namePrefix?: string | null): RegExp[];
+    static fieldIsFontFamily({ id }: Field$1): boolean;
+    static valueIsFont({ type }: Record<string, unknown>): boolean;
+    static extractFontsWithPaths(data: unknown, patterns: RegExp[], keyPrefix?: string | null): Font[];
+}
+
+declare class FormsManager extends DefinitionsManager<FormDefinition> {
+}
+
+interface Manager {
+    getDefinition: (type: string) => Record<string, unknown> | null;
+}
+interface MediasParserOptions {
+    fieldsManager: Manager;
+    screensManager: Manager;
+}
+interface Media$2 {
+    id?: string | null;
+    [key: string]: unknown;
+}
+interface Field {
+    id?: string | null;
+    name?: string | null;
+    type?: string | null;
+    media?: boolean;
     fields?: Field[];
+    itemsField?: Field | null;
+    settings?: Field[];
+    [key: string]: unknown;
+}
+interface Screen$1 {
+    type: string;
+    [key: string]: unknown;
+}
+interface Story {
+    theme?: Story | null;
+    components?: Screen$1[];
+    medias?: Record<string, Media$2> | null;
+    [key: string]: unknown;
+}
+declare class MediasParser {
+    fieldsManager: Manager;
+    screensManager: Manager;
+    constructor({ fieldsManager, screensManager }: MediasParserOptions);
+    toPath(story: Story | null): Story | null;
+    fromPath(story: Story | null, defaultMedias?: Record<string, Media$2> | null): Story | null;
+    getMediaFieldsPattern(fields: Field[], namePrefix?: string | null): RegExp[];
+    static fieldIsMedia({ media }: Field): boolean;
+    static fieldIsFontFamily({ id }: Field): boolean;
+    static replacePathsWithMedias(data: unknown, medias: Record<string, Media$2>, patterns: RegExp[], keyPrefix?: string | null): unknown;
+    static getMediaPath({ id }: Media$2): string | null;
+    static replaceMediasWithPaths(data: unknown, patterns: RegExp[], medias?: Record<string, Media$2> | null, keyPrefix?: string | null): {
+        data: unknown;
+        medias: Record<string, Media$2> | null;
+    };
+}
+
+interface TrackingOptions {
+    variables?: Record<string, unknown> | null;
+    [key: string]: unknown;
+}
+interface Screen {
+    id?: string | null;
+    type?: string | null;
+    [key: string]: unknown;
+}
+interface Media$1 {
+    id?: string | null;
+    name?: string | null;
+    duration?: number | null;
+    currentTime?: number | null;
+    [key: string]: unknown;
+}
+interface TrackingEventOptions {
+    value?: number | null;
+    [key: string]: unknown;
+}
+declare class Tracking extends Tracking$1 {
+    variables: Record<string, unknown> | null;
+    constructor(opts?: TrackingOptions);
+    setVariables(variables: Record<string, unknown> | null): void;
+    getVariables(): Record<string, unknown> | null;
+    trackScreenView(screen: Screen | null, screenIndex: number): void;
+    trackEvent(category: string, action: string, label: string, { value, ...opts }?: TrackingEventOptions): void;
+    trackMedia(type: string, media: Media$1 | null, action: string, { value, ...opts }?: TrackingEventOptions): void;
+}
+
+/**
+ * User definition
+ */
+interface User {
+    id?: number | string;
+    [key: string]: unknown;
 }
 
 type MediaType = 'audio' | 'image' | 'video' | 'document' | 'font';
@@ -383,7 +415,7 @@ interface Column extends Record<string, unknown> {
     path?: string;
     valueKey?: string;
     component?: string | ElementType | null;
-    field?: Field | string | null;
+    field?: Field$2 | string | null;
     actions?: ActionDefinition[] | null;
 }
 interface Action {
@@ -421,18 +453,36 @@ interface ResourceIndex {
     filters?: Filter[];
     columns?: TableColumn[];
     actions?: ActionDefinition[];
-    fields?: Field[];
+    fields?: Field$2[];
     [key: string]: unknown;
 }
+interface ResourcePages {
+    index?: PageDefinition;
+    show?: PageDefinition;
+    create?: PageDefinition;
+    edit?: PageDefinition;
+    delete?: PageDefinition;
+    duplicate?: PageDefinition;
+    [key: string]: PageDefinition | undefined;
+}
+interface ResourceForms {
+    default: FormDefinition | null;
+    create: FormDefinition | null;
+    edit: FormDefinition | null;
+    delete: FormDefinition | null;
+    modal: FormDefinition | null;
+    [key: string]: FormDefinition | null;
+}
 interface Resource {
     id: string;
     name: string;
     intl?: ResourceIntl;
-    fields?: Field[];
+    fields?: Field$2[];
     index?: ResourceIndex;
-    forms?: Record<string, Form>;
-    shows_in_navbar?: boolean;
+    forms?: ResourceForms;
     settings?: Record<string, unknown>;
+    extraRoutes?: RouteDefinition[];
+    pages?: ResourcePages;
 }
 interface ResourceItem extends Item {
     type?: string;
@@ -482,25 +532,18 @@ interface uppy {
  * Panneau route configuration
  */
 interface Routes {
-    'resources.index': string;
-    'resources.create': string;
-    'resources.store': string;
-    'resources.show': string;
-    'resources.edit': string;
-    'resources.update': string;
-    'resources.delete': string;
-    'resources.destroy': string;
-    'resources.duplicate': string;
-    'resources.clone': string;
-    'resources.restore': string;
-    [key: string]: string;
-}
-/**
- * Page definition
- */
-interface Page {
-    component: string;
-    [key: string]: unknown;
+    '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;
@@ -521,24 +564,26 @@ interface PanneauIntl {
     messages?: Record<string, string>;
     values?: PanneauIntlValues;
 }
-/**
- * Generic definition
- */
-interface Definition {
-    name?: string;
-    [key: string]: unknown;
+interface PanneauPages extends ResourcePages {
+    home?: PageDefinition;
+    login?: PageDefinition;
+    account?: PageDefinition;
+    error?: PageDefinition;
 }
 /**
  * Panneau definition (main configuration)
  */
-interface PanneauDefinition extends Definition {
+interface PanneauDefinition {
+    name?: string;
     resources?: Resource[];
     routes?: Routes;
-    pages?: Record<string, Page>;
+    pages?: PanneauPages;
     intl?: PanneauIntl;
     theme?: PanneauTheme;
     components?: PanneauComponents;
     settings?: Record<string, unknown>;
+    forms?: FormDefinition[];
+    fields?: FieldDefinition[];
 }
 /**
  * Tracking variables
@@ -546,4 +591,4 @@ interface PanneauDefinition extends Definition {
 type TrackingVariables = Record<string, unknown>;
 
 export { ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, FormsManager, MediasParser, Tracking };
-export type { Action, ActionDefinition, ActionValue, AudioMedia, Breadcrumb, Button, ButtonElement, ButtonSize, ButtonTheme, ButtonType, Column, ControlSize, Definition, DropdownAlign, Feedback, Field, FieldOption, Filter, Font, Form, FormError, FormStatus, ImageMedia, Item, Label, Media, MediaFile, MediaType, MenuItem, Message, Modal, Page, Pagination, PanneauComponents, PanneauDefinition, PanneauIntl, PanneauIntlValues, PanneauTheme, Preview, Resource, ResourceIndex, ResourceIntl, ResourceIntlValues, ResourceItem, 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, ControlSize, Definition, DialogSize, DropdownAlign, Feedback, Field$2 as Field, FieldDefinition, FieldOption, Filter, Font$1 as Font, Form, FormDefinition, FormError, FormStatus, ImageMedia, Item, Label, Media, MediaFile, MediaType, MenuItem, Message, Modal, PageDefinition, Pagination, PanneauComponents, PanneauDefinition, PanneauIntl, PanneauIntlValues, PanneauPages, PanneauTheme, Preview, Resource, ResourceForms, ResourceIndex, ResourceIntl, ResourceIntlValues, ResourceItem, ResourcePages, RouteDefinition, Routes, SelectOption, StatusCode, TableColumn, Toggle, TrackingVariables, TriggerUpdate, Uppy, User, VideoMedia, uppy };

package/dist/index.js

@@ -1,8 +1,9 @@
 import { flattenComponents, getComponentFromName } from '@panneau/core/utils';
+import { isObject } from 'lodash';
 import isArray from 'lodash-es/isArray';
 import uniqBy from 'lodash-es/uniqBy';
 import EventEmitter from 'wolfy87-eventemitter';
-import isObject from 'lodash-es/isObject';
+import isObject$1 from 'lodash-es/isObject';
 import uniq from 'lodash-es/uniq';
 import { Tracking as Tracking$1 } from '@folklore/tracking';
 
@@ -40,6 +41,9 @@ class ComponentsManager {
     return this;
   }
   getComponent(name, namespace = null) {
+    if (isObject(name)) {
+      return name;
+    }
     const components = this.getComponents(namespace);
     return getComponentFromName(name, components);
   }
@@ -240,9 +244,9 @@ class FontsParser {
       const value = data[key];
       let font = null;
       let subFonts = null;
-      if (patternMatch && isObject(value) && FontsParser.valueIsFont(value)) {
+      if (patternMatch && isObject$1(value) && FontsParser.valueIsFont(value)) {
         font = value;
-      } else if (isObject(value) || isArray(value)) {
+      } else if (isObject$1(value) || isArray(value)) {
         subFonts = FontsParser.extractFontsWithPaths(value, patterns, path);
       }
       return subFonts !== null || font !== null ? [...currentFonts, ...(subFonts || []), ...(font !== null ? [font] : [])] : currentFonts;
@@ -250,7 +254,7 @@ class FontsParser {
   }
 }
 
-class FormsManager extends ComponentsManager {}
+class FormsManager extends DefinitionsManager {}
 
 class MediasParser {
   constructor({
@@ -401,9 +405,9 @@ class MediasParser {
       const value = data[key];
       let newValue;
       if (patternMatch) {
-        newValue = isObject(value) ? value : medias[value] || null;
+        newValue = isObject$1(value) ? value : medias[value] || null;
       } else {
-        newValue = isObject(value) || isArray(value) ? MediasParser.replacePathsWithMedias(value, medias, patterns, path) : value;
+        newValue = isObject$1(value) || isArray(value) ? MediasParser.replacePathsWithMedias(value, medias, patterns, path) : value;
       }
       return dataIsArray ? [...newData, newValue] : {
         ...newData,
@@ -429,11 +433,11 @@ class MediasParser {
       let newValue;
       let media = null;
       let subMedias = null;
-      if (patternMatch && isObject(value)) {
+      if (patternMatch && isObject$1(value)) {
         const mediaPath = MediasParser.getMediaPath(value);
         newValue = mediaPath !== null ? mediaPath : value;
         media = mediaPath !== null ? value : null;
-      } else if (isObject(value) || isArray(value)) {
+      } else if (isObject$1(value) || isArray(value)) {
         const subReturn = MediasParser.replaceMediasWithPaths(value, patterns, medias, path);
         newValue = subReturn.data;
         subMedias = subReturn.medias;