@panneau/core 3.0.300 → 4.0.0

package/es/types/core.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Core UI Types
+ * TypeScript interfaces corresponding to PanneauPropTypes
+ */
+import { ReactNode } from 'react';
+
+/**
+ * Internationalization message definition
+ */
+export interface Message {
+    id: string;
+    defaultMessage?: string;
+}
+
+/**
+ * Label can be either a message object or any React node
+ */
+export type Label = Message | ReactNode;
+
+/**
+ * HTTP status code (number or string)
+ */
+export type StatusCode = number | string;
+
+/**
+ * Menu item definition
+ */
+export interface MenuItem {
+    id?: number | string;
+    label?: Label;
+    url?: string;
+    external?: boolean;
+    active?: boolean;
+}
+
+/**
+ * Button definition
+ */
+export 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)
+ */
+export type ButtonTheme =
+    | 'primary'
+    | 'secondary'
+    | 'success'
+    | 'danger'
+    | 'warning'
+    | 'info'
+    | 'light'
+    | 'dark'
+    | null;
+
+/**
+ * Button size variants
+ */
+export type ButtonSize = 'lg' | 'md' | 'sm' | null;
+
+/**
+ * Button type attribute
+ */
+export type ButtonType = 'button' | 'submit';
+
+/**
+ * Dropdown alignment
+ */
+export type DropdownAlign = 'start' | 'end';
+
+/**
+ * Form control size
+ */
+export type ControlSize = 'lg' | 'sm' | null;
+
+/**
+ * Form status states
+ */
+export type FormStatus = 'loading' | 'success' | 'error' | null;
+
+/**
+ * Form feedback states
+ */
+export type Feedback = 'valid' | 'invalid' | 'loading' | null;
+
+/**
+ * Form error object
+ */
+export interface FormError {
+    message?: string;
+}
+
+/**
+ * Toggle definition
+ */
+export interface Toggle {
+    key?: string;
+    label?: string;
+}
+
+/**
+ * Breadcrumb definition
+ */
+export interface Breadcrumb {
+    url?: string;
+}
+
+/**
+ * Font definition
+ */
+export interface Font {
+    // Properties to be defined based on requirements
+}
+
+/**
+ * Tracking variables
+ */
+export type TrackingVariables = Record<string, unknown>;
+
+/**
+ * Trigger update identifier
+ */
+export type TriggerUpdate = string;

package/es/types/form.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Form Types
+ * TypeScript interfaces for form-related components
+ */
+import { ReactNode } from 'react';
+
+import { Label } from './core';
+
+/**
+ * Field option for select/radio inputs
+ */
+export interface FieldOption {
+    value?: string;
+    label?: string;
+}
+
+/**
+ * Select option (more flexible than FieldOption)
+ */
+export type SelectOption =
+    | string
+    | number
+    | {
+          value?: unknown;
+          label?: Label | string;
+      }
+    | Record<string, unknown>;
+
+/**
+ * Field definition
+ */
+export interface Field {
+    name?: string; // Not required on localized fields
+    type?: string;
+    component?: string;
+    label?: ReactNode;
+}
+
+/**
+ * Form definition
+ */
+export interface Form {
+    title: ReactNode;
+    fields?: Field[];
+}
+
+/**
+ * Table column definition
+ */
+export type TableColumn =
+    | string
+    | {
+          id?: string;
+          component?: string;
+          path?: string;
+          field?: string;
+          columnClassName?: string;
+      };

package/es/types/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Panneau TypeScript Type Definitions
+ *
+ * This module exports TypeScript interfaces corresponding to the PanneauPropTypes
+ * defined in packages/core/src/lib/PropTypes.js
+ *
+ * @module @panneau/core/types
+ */
+
+// Core UI Types
+export type {
+    Message,
+    Label,
+    StatusCode,
+    MenuItem,
+    Button,
+    ButtonTheme,
+    ButtonSize,
+    ButtonType,
+    DropdownAlign,
+    ControlSize,
+    FormStatus,
+    Feedback,
+    FormError,
+    Toggle,
+    Breadcrumb,
+    Font,
+    TrackingVariables,
+    TriggerUpdate,
+} from './core';
+
+// Form Types
+export type { FieldOption, SelectOption, Field, Form, TableColumn } from './form';
+
+// Resource Types
+export type { Intl, Resource, Item, User, Media, Preview, Modal, Filter, Uppy } from './resource';
+
+// Panneau Definition Types
+export type { Routes, Page, PanneauDefinition, Definition } from './panneau';

package/es/types/panneau.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Panneau Definition Types
+ * TypeScript interfaces for main Panneau configuration and definitions
+ */
+
+import { Intl, Resource } from './resource';
+
+/**
+ * Panneau route configuration
+ */
+export 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;
+}
+
+/**
+ * Page definition
+ */
+export interface Page {
+    component: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Panneau definition (main configuration)
+ */
+export interface PanneauDefinition {
+    name?: string;
+    resources?: Resource[];
+    routes?: Routes;
+    pages?: Record<string, Page>;
+    intl?: Intl;
+}
+
+/**
+ * Generic definition
+ */
+export interface Definition {
+    name?: string;
+    [key: string]: unknown;
+}

package/es/types/resource.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Resource Types
+ * TypeScript interfaces for resources, items, users, media, and other entities
+ */
+import { Field } from './form';
+
+/**
+ * Internationalization configuration
+ */
+export interface Intl {
+    locale?: string;
+    messages?: Record<string, string>;
+    values?: Record<string, string>;
+}
+
+/**
+ * Resource definition
+ */
+export interface Resource {
+    id: string;
+    name: string;
+    intl?: Intl;
+    fields?: Field[];
+    forms?: Record<string, unknown>;
+    shows_in_navbar?: boolean;
+}
+
+/**
+ * Generic item (base interface for data items)
+ */
+export interface Item {
+    id: string;
+    [key: string]: unknown;
+}
+
+/**
+ * User definition
+ */
+export interface User {
+    id?: number | string;
+    [key: string]: unknown;
+}
+
+/**
+ * Media file definition
+ */
+export interface Media {
+    id: string;
+    name: string;
+    type: string;
+    thumbnail_url?: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Preview definition
+ */
+export interface Preview {
+    id?: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Modal definition
+ */
+export interface Modal {
+    name?: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Filter definition
+ */
+export interface Filter {
+    id?: string;
+    component?: string;
+    [key: string]: unknown;
+}
+
+/**
+ * Uppy configuration
+ */
+export interface Uppy {
+    tus?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+
+/**
+ * Uppy instance
+ */
+export interface uppy {
+    [key: string]: unknown;
+}

package/es/utils.js

@@ -2,7 +2,7 @@ import isNumber from 'lodash-es/isNumber';
 import { snakeCase } from 'snake-case';
 import isObject from 'lodash-es/isObject';
 import { useEffect, isValidElement } from 'react';
-import _regeneratorRuntime from '@babel/runtime/helpers/regeneratorRuntime';
+import _regenerator from '@babel/runtime/helpers/regenerator';
 import _asyncToGenerator from '@babel/runtime/helpers/asyncToGenerator';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
 import _objectSpread from '@babel/runtime/helpers/objectSpread2';
@@ -47,7 +47,7 @@ function checkClickable(el) {
   //     return true;
   // }
 
-  if (tags.map(function (it) {
+  if (tagName && tags.map(function (it) {
     return it.toLowerCase();
   }).indexOf(tagName.toLowerCase()) !== -1) {
     return true;
@@ -110,20 +110,17 @@ function copyClipboardApi(_x) {
   return _copyClipboardApi.apply(this, arguments);
 }
 function _copyClipboardApi() {
-  _copyClipboardApi = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(text) {
-    return _regeneratorRuntime().wrap(function _callee$(_context) {
-      while (1) switch (_context.prev = _context.next) {
+  _copyClipboardApi = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(text) {
+    return _regenerator().w(function (_context) {
+      while (1) switch (_context.n) {
         case 0:
           if (navigator.clipboard) {
-            _context.next = 2;
+            _context.n = 1;
             break;
           }
           throw makeError();
-        case 2:
-          return _context.abrupt("return", navigator.clipboard.writeText(text));
-        case 3:
-        case "end":
-          return _context.stop();
+        case 1:
+          return _context.a(2, navigator.clipboard.writeText(text));
       }
     }, _callee);
   }));
@@ -133,10 +130,10 @@ function copyExecCommand(_x2) {
   return _copyExecCommand.apply(this, arguments);
 }
 function _copyExecCommand() {
-  _copyExecCommand = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee2(text) {
+  _copyExecCommand = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(text) {
     var span, selection, range, success;
-    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
+    return _regenerator().w(function (_context2) {
+      while (1) switch (_context2.n) {
         case 0:
           // Put the text to copy into a <span>
           span = document.createElement('span');
@@ -153,9 +150,9 @@ function _copyExecCommand() {
           // Make a selection object representing the range of text selected by the user
           selection = window.getSelection();
           range = window.document.createRange();
-          selection.removeAllRanges();
+          selection === null || selection === void 0 || selection.removeAllRanges();
           range.selectNode(span);
-          selection.addRange(range);
+          selection === null || selection === void 0 || selection.addRange(range);
 
           // Copy text to the clipboard
           success = false;
@@ -163,17 +160,16 @@ function _copyExecCommand() {
             success = window.document.execCommand('copy');
           } finally {
             // Cleanup
-            selection.removeAllRanges();
+            selection === null || selection === void 0 || selection.removeAllRanges();
             window.document.body.removeChild(span);
           }
           if (success) {
-            _context2.next = 15;
+            _context2.n = 1;
             break;
           }
           throw makeError();
-        case 15:
-        case "end":
-          return _context2.stop();
+        case 1:
+          return _context2.a(2);
       }
     }, _callee2);
   }));
@@ -183,34 +179,34 @@ function copyToClipboard(_x3) {
   return _copyToClipboard.apply(this, arguments);
 }
 function _copyToClipboard() {
-  _copyToClipboard = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee3(text) {
-    return _regeneratorRuntime().wrap(function _callee3$(_context3) {
-      while (1) switch (_context3.prev = _context3.next) {
+  _copyToClipboard = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(text) {
+    var _t, _t2;
+    return _regenerator().w(function (_context3) {
+      while (1) switch (_context3.p = _context3.n) {
         case 0:
-          _context3.prev = 0;
-          _context3.next = 3;
+          _context3.p = 0;
+          _context3.n = 1;
           return copyClipboardApi(text);
-        case 3:
-          _context3.next = 15;
+        case 1:
+          _context3.n = 6;
           break;
-        case 5:
-          _context3.prev = 5;
-          _context3.t0 = _context3["catch"](0);
-          _context3.prev = 7;
-          _context3.next = 10;
+        case 2:
+          _context3.p = 2;
+          _t = _context3.v;
+          _context3.p = 3;
+          _context3.n = 4;
           return copyExecCommand(text);
-        case 10:
-          _context3.next = 15;
+        case 4:
+          _context3.n = 6;
           break;
-        case 12:
-          _context3.prev = 12;
-          _context3.t1 = _context3["catch"](7);
-          throw _context3.t1 || _context3.t0 || makeError();
-        case 15:
-        case "end":
-          return _context3.stop();
+        case 5:
+          _context3.p = 5;
+          _t2 = _context3.v;
+          throw _t2 || _t || makeError();
+        case 6:
+          return _context3.a(2);
       }
-    }, _callee3, null, [[0, 5], [7, 12]]);
+    }, _callee3, null, [[3, 5], [0, 2]]);
   }));
   return _copyToClipboard.apply(this, arguments);
 }
@@ -226,7 +222,7 @@ var _flattenComponents = function flattenComponents(components) {
 };
 
 var formatDuration = function formatDuration(timeInSeconds) {
-  var numberOfSeconds = parseInt(timeInSeconds, 10); // don't forget the second param
+  var numberOfSeconds = parseInt(String(timeInSeconds), 10); // don't forget the second param
   var hours = Math.floor(numberOfSeconds / 3600);
   var minutes = Math.floor((numberOfSeconds - hours * 3600) / 60);
   var seconds = numberOfSeconds - hours * 3600 - minutes * 60;
@@ -251,7 +247,7 @@ var getComponent = function getComponent(component) {
     var props = _objectWithoutProperties(_ref, _excluded$1);
   return {
     name: component,
-    props: props
+    props: Object.keys(props).length > 0 ? props : null
   };
 };
 
@@ -261,12 +257,13 @@ var getColumnFromField = function getColumnFromField(field) {
     return null;
   }
   // eslint-disable-next-line camelcase
-  var name = field.name,
-    _field$components = field.components,
-    _field$components2 = _field$components === void 0 ? {} : _field$components,
-    _field$components2$di = _field$components2.display,
-    display = _field$components2$di === void 0 ? null : _field$components2$di,
-    label = field.label;
+  var _ref = field,
+    name = _ref.name,
+    _ref$components = _ref.components,
+    _ref$components2 = _ref$components === void 0 ? {} : _ref$components,
+    _ref$components2$disp = _ref$components2.display,
+    display = _ref$components2$disp === void 0 ? null : _ref$components2$disp,
+    label = _ref.label;
   var _getComponent = getComponent(display),
     _getComponent$name = _getComponent.name,
     componentName = _getComponent$name === void 0 ? null : _getComponent$name,
@@ -281,16 +278,17 @@ var getColumnFromField = function getColumnFromField(field) {
   });
 };
 var getColumnsWithFields = function getColumnsWithFields(resource, columns) {
-  var fields = resource.fields;
+  var _resource$fields = resource.fields,
+    fields = _resource$fields === void 0 ? [] : _resource$fields;
   var newColumns = columns !== null ? columns.map(function (column) {
-    var _ref = isString(column) ? {
+    var _ref2 = isString(column) ? {
         field: column
       } : column,
-      _ref$id = _ref.id,
-      colId = _ref$id === void 0 ? null : _ref$id,
-      _ref$field = _ref.field,
-      colField = _ref$field === void 0 ? null : _ref$field,
-      otherProps = _objectWithoutProperties(_ref, _excluded);
+      _ref2$id = _ref2.id,
+      colId = _ref2$id === void 0 ? null : _ref2$id,
+      _ref2$field = _ref2.field,
+      colField = _ref2$field === void 0 ? null : _ref2$field,
+      otherProps = _objectWithoutProperties(_ref2, _excluded);
     var fieldName = colField || colId;
     return _objectSpread(_objectSpread(_objectSpread({}, fieldName !== null ? getColumnFromField(fields.find(function (it) {
       return it.name === fieldName;
@@ -311,7 +309,6 @@ var getComponentFromName = function getComponentFromName() {
     return defaultComponent;
   }
   var pascalName = pascalCase(name);
-  // console.log(name, pascalName, components);
   var component = components[pascalName] || components[name] || defaultComponent;
   if (!component) {
     console.warn('Could not find component from name', name, pascalName, components);
@@ -379,7 +376,7 @@ var getFieldFromPath = function getFieldFromPath(path, fields, fieldManager) {
       itemsField = _ref$itemsField === void 0 ? null : _ref$itemsField;
     if (itemsField !== null && key.match(/^[0-9]+$/)) {
       return _objectSpread(_objectSpread({}, itemsField), {}, {
-        name: path.join('/'),
+        name: (isArray(path) ? path : [path]).join('/'),
         listItems: true
       });
     }
@@ -394,7 +391,8 @@ var getFileName = function getFileName() {
   if (url === null || typeof url.match === 'undefined') {
     return null;
   }
-  return url.match(/([^/]+)(\?.*)?$/)[1] || url;
+  var match = url.match(/([^/]+)(\?.*)?$/);
+  return match ? match[1] : url;
 };
 
 var getPathValue = function getPathValue(it, path) {
@@ -407,9 +405,10 @@ var getPathValue = function getPathValue(it, path) {
 var getSelectOptions = function getSelectOptions(options) {
   return options.map(function (it) {
     if (isObject(it)) {
-      var _it$label = it.label,
-        label = _it$label === void 0 ? null : _it$label,
-        value = it.value;
+      var _ref = it,
+        _ref$label = _ref.label,
+        label = _ref$label === void 0 ? null : _ref$label,
+        value = _ref.value;
       if (label === null) {
         return {
           value: value,
@@ -544,14 +543,19 @@ function selectPage(pageSelected, items, selectedItems, onSelectionChange) {
 
 var _setValue = function setValue(value, keyParts, fieldValue) {
   var key = keyParts.shift();
+  if (!key) {
+    return value;
+  }
   var isArray = key.match(/^[0-9]+$/) !== null;
   if (value !== null || fieldValue !== null) {
     if (isArray) {
       var index = parseInt(key, 10);
-      var newArrayValue = fieldValue !== null ? [].concat(_toConsumableArray(value.slice(0, index)), [keyParts.length > 0 ? _setValue(value !== null ? value[index] || null : null, keyParts, fieldValue) : fieldValue], _toConsumableArray(value.slice(index + 1))) : [].concat(_toConsumableArray(value.slice(0, index)), _toConsumableArray(value.slice(index + 1)));
+      var arrayValue = value;
+      var newArrayValue = fieldValue !== null ? [].concat(_toConsumableArray(arrayValue.slice(0, index)), [keyParts.length > 0 ? _setValue(arrayValue !== null ? arrayValue[index] || null : null, keyParts, fieldValue) : fieldValue], _toConsumableArray(arrayValue.slice(index + 1))) : [].concat(_toConsumableArray(arrayValue.slice(0, index)), _toConsumableArray(arrayValue.slice(index + 1)));
       return newArrayValue.length > 0 ? newArrayValue : null;
     }
-    return _objectSpread(_objectSpread({}, value), {}, _defineProperty({}, key, keyParts.length > 0 ? _setValue(value !== null ? value[key] || null : null, keyParts, fieldValue) : fieldValue));
+    var objectValue = value;
+    return _objectSpread(_objectSpread({}, objectValue), {}, _defineProperty({}, key, keyParts.length > 0 ? _setValue(objectValue !== null ? objectValue[key] || null : null, keyParts, fieldValue) : fieldValue));
   }
   return null;
 };
@@ -575,7 +579,7 @@ var _validateFields = function validateFields(fields, value) {
       if (field.type === 'fields' && field.fields) {
         return _validateFields(field.fields, value);
       }
-      var val = value && value[field.name] ? value[field.name] : false;
+      var val = value && field.name && value[field.name] ? value[field.name] : false;
       return !(field.required && !val);
     }
     return acc;