@panneau/core 4.0.78 → 4.1.0

package/dist/index.d.ts

@@ -1,49 +1,15 @@
-import { ElementType, ReactNode, MouseEvent } from 'react';
+import { ReactNode, MouseEvent, ElementType, ComponentProps } from 'react';
+import { MessageDescriptor, FormattedMessage } from 'react-intl';
 import EventEmitter from 'wolfy87-eventemitter';
-import { MessageDescriptor } from 'react-intl';
 import { Tracking as Tracking$1 } from '@folklore/tracking';
 
-declare class ComponentsManager {
-    components: Record<string, ElementType>;
-    constructor(components?: Record<string, ElementType>);
-    addComponent(name: string, component: ElementType, namespace?: string | null): this;
-    addComponents(components: Record<string, ElementType>, namespace?: string | null): this;
-    merge(manager: ComponentsManager, namespace?: string | null): this;
-    addNamespace(namespace: string | null): this;
-    getComponent(name: string | ElementType, namespace?: string | null): ElementType | null;
-    getComponents(namespace?: string | null): Record<string, ElementType> | null;
-    hasComponent(name: string, namespace?: string | null): boolean;
-}
-
-interface Definition$1 {
-    id: string;
-    component?: unknown;
+/**
+ * User definition
+ */
+interface User {
+    id?: number | string;
     [key: string]: unknown;
 }
-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>;
-}
-
-type EventCallback = (...args: unknown[]) => void;
-declare class EventsManager extends EventEmitter {
-    element: EventTarget;
-    events: Record<string, EventCallback[]>;
-    listeners: Record<string, EventListener>;
-    constructor(element: EventTarget);
-    subscribe(event: string, callback: EventCallback): void;
-    unsubscribe(event: string, callback: EventCallback): void;
-    addEventListener(event: string): void;
-    removeEventListener(event: string): void;
-}
 
 /**
  * Core UI Types
@@ -53,10 +19,22 @@ declare class EventsManager extends EventEmitter {
  * 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
  */
 type Label = Message | ReactNode;
+/**
+ * Map of components, can be nested by namespace (ex: { fields: { text: TextField } })
+ */
+interface ComponentsMap {
+    [name: string]: ElementType | ComponentsMap;
+}
 /**
  * HTTP status code (number or string)
  */
@@ -68,8 +46,16 @@ 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;
 }
 /**
  * Button definition
@@ -77,6 +63,7 @@ interface MenuItem {
 type ButtonElement = HTMLButtonElement | HTMLAnchorElement;
 interface Button {
     id?: string;
+    name?: string;
     label?: Label;
     onClick?: (e: MouseEvent<ButtonElement>, button?: Button, index?: number) => void;
     href?: string;
@@ -171,7 +158,7 @@ interface Item {
 /**
  * Generic definition
  */
-interface Definition {
+interface Definition$1 {
     id: string;
     component?: string | ElementType;
     [key: string]: unknown;
@@ -216,7 +203,7 @@ interface Field$2 {
     size?: ControlSize;
     [key: string]: unknown;
 }
-interface FieldDefinition extends Omit<Field$2, 'component'>, Definition {
+interface FieldDefinition extends Omit<Field$2, 'component'>, Definition$1 {
 }
 /**
  * Form definition
@@ -229,141 +216,7 @@ interface Form {
     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;
+interface FormDefinition extends Form, Definition$1 {
 }
 
 type MediaType = 'audio' | 'image' | 'video' | 'document' | 'font';
@@ -374,7 +227,7 @@ interface MediaFile {
 /**
  * Media file definition
  */
-interface Media extends Item {
+interface Media$2 extends Item {
     id: string;
     name: string;
     type: string;
@@ -382,21 +235,22 @@ interface Media extends Item {
     thumbnailUrl?: string;
     url?: string;
     provider?: string;
+    deletedAt?: string | null;
     [key: string]: unknown;
     files?: Record<string, MediaFile> | null;
 }
-interface VideoMedia extends Media {
+interface VideoMedia extends Media$2 {
     type: 'video';
     iframeUrl?: string;
     width?: number | null;
     height?: number | null;
     duration?: number | null;
 }
-interface AudioMedia extends Media {
+interface AudioMedia extends Media$2 {
     type: 'audio';
     duration?: number | null;
 }
-interface ImageMedia extends Media {
+interface ImageMedia extends Media$2 {
     type: 'image';
 }
 
@@ -411,6 +265,7 @@ interface ImageMedia extends Media {
 type TableColumn = string | Column;
 interface Column extends Record<string, unknown> {
     id?: string | null;
+    name?: string | null;
     label?: unknown;
     path?: string;
     valueKey?: string;
@@ -437,7 +292,7 @@ type ActionValue = Item | Item[] | null;
 interface ResourceIntlValues {
     a_singular?: string;
     a_plural?: string;
-    [key: string]: unknown;
+    [key: string]: MessageValue;
 }
 /**
  * Internationalization configuration
@@ -465,13 +320,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 {
+    id?: string;
+    name?: string;
+    fields?: Field$2[];
+    settings?: {
+        canCreate?: boolean;
+        [key: string]: unknown;
+    };
 }
 interface Resource {
     id: string;
@@ -483,6 +357,7 @@ interface Resource {
     settings?: Record<string, unknown>;
     extraRoutes?: RouteDefinition[];
     pages?: ResourcePages;
+    types?: ResourceType[];
 }
 interface ResourceItem extends Item {
     type?: string;
@@ -532,17 +407,17 @@ interface uppy {
  * 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;
+    '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 {
@@ -570,6 +445,21 @@ interface PanneauPages extends ResourcePages {
     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;
+}
+interface PanneauAuth {
+    forgotPassword?: boolean;
+    register?: boolean;
+    [key: string]: unknown;
+}
 /**
  * Panneau definition (main configuration)
  */
@@ -584,11 +474,178 @@ interface PanneauDefinition {
     settings?: Record<string, unknown>;
     forms?: FormDefinition[];
     fields?: FieldDefinition[];
+    menus?: PanneauMenus;
+    auth?: PanneauAuth;
 }
 /**
  * Tracking variables
  */
 type TrackingVariables = Record<string, unknown>;
 
+declare class ComponentsManager {
+    components: Record<string, ElementType>;
+    constructor(components?: ComponentsMap);
+    addComponent(name: string, component: ElementType, namespace?: string | null): this;
+    addComponents(components: Record<string, ElementType>, namespace?: string | null): this;
+    merge(manager: ComponentsManager, namespace?: string | null): this;
+    addNamespace(namespace: string | null): this;
+    getComponent(name: string | ElementType, namespace?: string | null): ElementType | null;
+    getComponents(namespace?: string | null): Record<string, ElementType> | null;
+    hasComponent(name: string, namespace?: string | null): boolean;
+}
+
+interface Definition {
+    id: string;
+    component?: unknown;
+    [key: string]: unknown;
+}
+declare class DefinitionsManager<T extends Definition = Definition> {
+    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>;
+}
+
+type EventCallback = (...args: unknown[]) => void;
+declare class EventsManager extends EventEmitter {
+    element: EventTarget;
+    events: Record<string, EventCallback[]>;
+    listeners: Record<string, EventListener>;
+    constructor(element: EventTarget);
+    subscribe(event: string, callback: EventCallback): void;
+    unsubscribe(event: string, callback: EventCallback): void;
+    addEventListener(event: string): void;
+    removeEventListener(event: string): void;
+}
+
+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 }: {
+        type?: 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 | null;
+}
+interface Media$1 {
+    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$1> | null;
+    [key: string]: unknown;
+}
+declare class MediasParser {
+    fieldsManager: 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;
+    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$1>, patterns: RegExp[], keyPrefix?: string | null): unknown;
+    static getMediaPath({ id }: Media$1): string | null;
+    static replaceMediasWithPaths(data: unknown, patterns: RegExp[], medias?: Record<string, Media$1> | null, keyPrefix?: string | null): {
+        data: unknown;
+        medias: Record<string, Media$1> | null;
+    };
+}
+
+interface Screen {
+    id?: string | null;
+    type?: string | null;
+    [key: string]: unknown;
+}
+interface Media {
+    id?: string | null;
+    name?: string | null;
+    duration?: number | null;
+    currentTime?: number | null;
+    [key: string]: unknown;
+}
+interface TrackingEventOptions {
+    value?: string | number | null;
+    [key: string]: unknown;
+}
+declare class Tracking extends Tracking$1 {
+    variables: Record<string, unknown> | null;
+    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 | null, options?: TrackingEventOptions | string | number | null): void;
+    trackMedia(type: string, media: Media | null, action: string, { value, ...opts }?: TrackingEventOptions): void;
+}
+
 export { ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, FormsManager, MediasParser, Tracking };
-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 };
+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 };