@panneau/core 4.0.11 → 4.0.15

package/dist/index.d.ts

@@ -0,0 +1,502 @@
+import EventEmitter from 'wolfy87-eventemitter';
+import { Tracking as Tracking$1 } from '@folklore/tracking';
+import { ReactNode } from 'react';
+import { MessageDescriptor } from 'react-intl';
+
+declare class ComponentsManager {
+    components: Record<string, unknown>;
+    constructor(components?: Record<string, unknown>);
+    addComponent(name: string, component: unknown, namespace?: string | null): this;
+    addComponents(components: Record<string, unknown>, namespace?: string | null): this;
+    merge(manager: ComponentsManager, namespace?: string | null): this;
+    addNamespace(namespace: string | null): this;
+    getComponent(name: string, namespace?: string | null): unknown;
+    getComponents(namespace?: string | null): Record<string, unknown> | null;
+    hasComponent(name: string, namespace?: string | null): boolean;
+}
+
+interface Definition$1 {
+    id: string;
+    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[];
+    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 {
+}
+
+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;
+}
+
+/**
+ * Core UI Types
+ */
+
+/**
+ * Internationalization message definition
+ */
+interface Message extends MessageDescriptor {
+    id: string;
+    defaultMessage?: string;
+}
+/**
+ * Label can be either a message object or any React node
+ */
+type Label = Message | ReactNode;
+/**
+ * HTTP status code (number or string)
+ */
+type StatusCode = number | string;
+/**
+ * Menu item definition
+ */
+interface MenuItem {
+    id?: number | string;
+    label?: Label;
+    url?: string;
+    external?: boolean;
+    active?: boolean;
+}
+/**
+ * Button definition
+ */
+interface Button {
+    id?: string;
+    label?: Label;
+    onClick?: () => void;
+    href?: string;
+    target?: string;
+    theme?: ButtonTheme;
+    size?: ButtonSize;
+    type?: ButtonType;
+    disabled?: boolean;
+    external?: boolean;
+}
+/**
+ * Button theme variants (Bootstrap 5)
+ */
+type ButtonTheme = 'primary' | 'secondary' | 'success' | 'danger' | 'warning' | 'info' | 'light' | 'dark' | null;
+/**
+ * Button size variants
+ */
+type ButtonSize = 'lg' | 'md' | 'sm' | null;
+/**
+ * Button type attribute
+ */
+type ButtonType = 'button' | 'submit';
+/**
+ * Dropdown alignment
+ */
+type DropdownAlign = 'start' | 'end';
+/**
+ * Form control size
+ */
+type ControlSize = 'lg' | 'sm' | null;
+/**
+ * Form status states
+ */
+type FormStatus = 'loading' | 'success' | 'error' | null;
+/**
+ * Form feedback states
+ */
+type Feedback = 'valid' | 'invalid' | 'loading' | null;
+/**
+ * Form error object
+ */
+interface FormError {
+    message?: string;
+}
+/**
+ * Toggle definition
+ */
+interface Toggle {
+    key?: string;
+    label?: string;
+}
+/**
+ * Breadcrumb definition
+ */
+interface Breadcrumb {
+    url?: string;
+}
+/**
+ * Font definition
+ */
+interface Font {
+    name: string;
+}
+/**
+ * Tracking variables
+ */
+type TrackingVariables = Record<string, unknown>;
+/**
+ * Trigger update identifier
+ */
+type TriggerUpdate = string;
+
+/**
+ * User definition
+ */
+interface User {
+    id?: number | string;
+    [key: string]: unknown;
+}
+
+/**
+ * Form Types
+ * TypeScript interfaces for form-related components
+ */
+
+/**
+ * Field option for select/radio inputs
+ */
+interface FieldOption {
+    value?: string;
+    label?: string;
+}
+/**
+ * Select option (more flexible than FieldOption)
+ */
+type SelectOption = string | number | {
+    value?: unknown;
+    label?: Label | string;
+} | Record<string, unknown>;
+/**
+ * Field definition
+ */
+interface Field {
+    name?: string;
+    type?: string;
+    component?: string;
+    label?: ReactNode;
+}
+/**
+ * Form definition
+ */
+interface Form {
+    title: ReactNode;
+    fields?: Field[];
+}
+/**
+ * Table column definition
+ */
+type TableColumn = string | {
+    id?: string;
+    component?: string;
+    path?: string;
+    field?: string;
+    columnClassName?: string;
+};
+
+/**
+ * Resource Types
+ * TypeScript interfaces for resources, items, users, media, and other entities
+ */
+
+interface Action {
+    id?: string;
+    component?: string;
+    label?: string | null;
+    icon?: string | null;
+    href?: string | null;
+    external?: boolean;
+    theme?: string;
+    target?: string;
+    onClick?: (() => void) | null;
+    endpoint?: string | null;
+    withConfirmation?: boolean;
+    [key: string]: unknown;
+}
+type ActionDefinition = string | Action;
+type ActionValue = Item | Item[] | null;
+interface ResourceIntlValues {
+    a_singular?: string;
+    a_plural?: string;
+    [key: string]: unknown;
+}
+/**
+ * Internationalization configuration
+ */
+interface ResourceIntl {
+    messages?: Record<string, string>;
+    values?: ResourceIntlValues;
+}
+/**
+ * Resource definition
+ */
+interface Resource {
+    id: string;
+    name: string;
+    intl?: ResourceIntl;
+    fields?: Field[];
+    forms?: Record<string, unknown>;
+    shows_in_navbar?: boolean;
+    settings?: Record<string, unknown>;
+}
+/**
+ * Generic item (base interface for data items)
+ */
+interface Item {
+    id: string;
+    [key: string]: unknown;
+}
+/**
+ * Media file definition
+ */
+interface Media {
+    id: string;
+    name: string;
+    type: string;
+    thumbnail_url?: string;
+    [key: string]: unknown;
+}
+/**
+ * Preview definition
+ */
+interface Preview {
+    id?: string;
+    [key: string]: unknown;
+}
+/**
+ * Modal definition
+ */
+interface Modal {
+    name?: string;
+    [key: string]: unknown;
+}
+/**
+ * Filter definition
+ */
+interface Filter {
+    id?: string;
+    component?: string;
+    [key: string]: unknown;
+}
+/**
+ * Uppy configuration
+ */
+interface Uppy {
+    tus?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+/**
+ * Uppy instance
+ */
+interface uppy {
+    [key: string]: unknown;
+}
+
+/**
+ * Panneau Definition Types
+ * TypeScript interfaces for main Panneau configuration and definitions
+ */
+
+/**
+ * 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;
+}
+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>;
+    values?: PanneauIntlValues;
+}
+/**
+ * Panneau definition (main configuration)
+ */
+interface PanneauDefinition {
+    name?: string;
+    resources?: Resource[];
+    routes?: Routes;
+    pages?: Record<string, Page>;
+    intl?: PanneauIntl;
+    theme?: PanneauTheme;
+    components?: PanneauComponents;
+    settings?: Record<string, unknown>;
+}
+/**
+ * Generic definition
+ */
+interface Definition {
+    name?: string;
+    [key: string]: unknown;
+}
+
+export { ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, FormsManager, MediasParser, Tracking };
+export type { Action, ActionDefinition, ActionValue, Breadcrumb, Button, ButtonSize, ButtonTheme, ButtonType, ControlSize, Definition, DropdownAlign, Feedback, Field, FieldOption, Filter, Font, Form, FormError, FormStatus, Item, Label, Media, MenuItem, Message, Modal, Page, PanneauComponents, PanneauDefinition, PanneauIntl, PanneauIntlValues, PanneauTheme, Preview, Resource, ResourceIntl, ResourceIntlValues, Routes, SelectOption, StatusCode, TableColumn, Toggle, TrackingVariables, TriggerUpdate, Uppy, User, uppy };