@panneau/core 4.0.11 → 4.0.15

package/{es → dist}/index.js

@@ -2,275 +2,24 @@ import _objectSpread from '@babel/runtime/helpers/objectSpread2';
 import _classCallCheck from '@babel/runtime/helpers/classCallCheck';
 import _createClass from '@babel/runtime/helpers/createClass';
 import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { pascalCase } from 'change-case';
-import ReactIs from 'react-is';
+import { getComponentFromName, flattenComponents } from '@panneau/core/utils';
 import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
-import isArray from 'lodash-es/isArray';
-import uniqBy from 'lodash-es/uniqBy';
+import isArray from 'lodash/isArray';
+import uniqBy from 'lodash/uniqBy';
 import _callSuper from '@babel/runtime/helpers/callSuper';
 import _inherits from '@babel/runtime/helpers/inherits';
 import EventEmitter from 'wolfy87-eventemitter';
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
-import isObject from 'lodash-es/isObject';
-import uniq from 'lodash-es/uniq';
+import isObject from 'lodash/isObject';
+import uniq from 'lodash/uniq';
 import { Tracking as Tracking$1 } from '@folklore/tracking';
-import PropTypes$1 from 'prop-types';
-
-var message = PropTypes$1.shape({
-  id: PropTypes$1.string.isRequired,
-  defaultMessage: PropTypes$1.string
-});
-var label = PropTypes$1.oneOfType([message, PropTypes$1.node]);
-var statusCode = PropTypes$1.oneOfType([PropTypes$1.number, PropTypes$1.string]);
-
-/**
- * Core
- */
-var menuItem = PropTypes$1.shape({
-  id: PropTypes$1.oneOfType([PropTypes$1.number, PropTypes$1.string]),
-  label: label,
-  url: PropTypes$1.string,
-  external: PropTypes$1.bool,
-  active: PropTypes$1.bool
-});
-var menuItems = PropTypes$1.arrayOf(menuItem);
-var button = PropTypes$1.shape({
-  id: PropTypes$1.string,
-  label: label,
-  onClick: PropTypes$1.func
-});
-var buttons = PropTypes$1.arrayOf(button);
-var buttonTheme = PropTypes$1.oneOf(['primary', 'secondary', 'success', 'danger', 'warning', 'info', 'light', 'dark', null]);
-var buttonSize = PropTypes$1.oneOf(['lg', 'md', 'sm', null]);
-var buttonType = PropTypes$1.oneOf(['button', 'submit']);
-var dropdownAlign = PropTypes$1.oneOf(['start', 'end']);
-var controlSize = PropTypes$1.oneOf(['lg', 'sm', null]);
-var formStatus = PropTypes$1.oneOf(['loading', 'success', 'error', null]);
-var fieldOption = PropTypes$1.shape({
-  value: PropTypes$1.string,
-  label: PropTypes$1.string
-});
-var fieldOptions = PropTypes$1.arrayOf(fieldOption);
-var toggle = PropTypes$1.shape({
-  key: PropTypes$1.string,
-  label: PropTypes$1.string
-});
-var toggles = PropTypes$1.arrayOf(toggle);
-var tableColumn = PropTypes$1.oneOfType([PropTypes$1.string, PropTypes$1.shape({
-  id: PropTypes$1.string,
-  component: PropTypes$1.string,
-  path: PropTypes$1.string,
-  field: PropTypes$1.string,
-  columnClassName: PropTypes$1.string
-})]);
-var tableColumns = PropTypes$1.arrayOf(tableColumn);
-
-/**
- * Panneau Definitions
- */
-var routes = PropTypes$1.shape({
-  'resources.index': PropTypes$1.string.isRequired,
-  'resources.create': PropTypes$1.string.isRequired,
-  'resources.store': PropTypes$1.string.isRequired,
-  'resources.show': PropTypes$1.string.isRequired,
-  'resources.edit': PropTypes$1.string.isRequired,
-  'resources.update': PropTypes$1.string.isRequired,
-  'resources.delete': PropTypes$1.string.isRequired,
-  'resources.destroy': PropTypes$1.string.isRequired,
-  'resources.duplicate': PropTypes$1.string.isRequired,
-  'resources.clone': PropTypes$1.string.isRequired,
-  'resources.restore': PropTypes$1.string.isRequired
-});
-var intl = PropTypes$1.shape({
-  locale: PropTypes$1.string,
-  messages: PropTypes$1.objectOf(PropTypes$1.string),
-  values: PropTypes$1.objectOf(PropTypes$1.string)
-});
-var page = PropTypes$1.shape({
-  component: PropTypes$1.string.isRequired
-});
-var pages = PropTypes$1.objectOf(page);
-var field = PropTypes$1.shape({
-  name: PropTypes$1.string,
-  // Not required on localized fields
-  type: PropTypes$1.string,
-  component: PropTypes$1.string,
-  label: PropTypes$1.node
-});
-var fields = PropTypes$1.arrayOf(field);
-var form = PropTypes$1.shape({
-  // type: PropTypes.string.isRequired,
-  title: PropTypes$1.isRequired,
-  fields: fields
-});
-var forms = PropTypes$1.arrayOf(form);
-var resource = PropTypes$1.shape({
-  id: PropTypes$1.string.isRequired,
-  name: PropTypes$1.string.isRequired,
-  intl: intl,
-  fields: fields,
-  forms: PropTypes$1.shape({}),
-  shows_in_navbar: PropTypes$1.bool
-});
-var resources = PropTypes$1.arrayOf(resource);
-var panneauDefinition = PropTypes$1.shape({
-  name: PropTypes$1.string,
-  resources: resources,
-  routes: routes,
-  pages: pages,
-  intl: intl
-  // intl,
-});
-var definition = PropTypes$1.shape({
-  name: PropTypes$1.string
-  // resources,
-  // routes,
-  // intl,
-});
-var item = PropTypes$1.shape({
-  id: PropTypes$1.string.isRequired
-});
-var items = PropTypes$1.arrayOf(item);
-var user = PropTypes$1.shape({
-  id: PropTypes$1.oneOfType([PropTypes$1.number, PropTypes$1.string])
-});
-var users = PropTypes$1.arrayOf(user);
-var selectOption = PropTypes$1.oneOfType([PropTypes$1.string, PropTypes$1.number, PropTypes$1.shape({
-  value: PropTypes$1.any,
-  // eslint-disable-line
-  label: label
-}), PropTypes$1.object]);
-var selectOptions = PropTypes$1.arrayOf(selectOption);
-var feedback = PropTypes$1.oneOf(['valid', 'invalid', 'loading', null]);
-var formError = PropTypes$1.shape({
-  message: PropTypes$1.string
-});
-var formErrors = PropTypes$1.arrayOf(formError);
-var uppy = PropTypes$1.shape({
-  tus: PropTypes$1.object
-}); // eslint-disable-line
-
-var triggerUpdate = PropTypes$1.string;
-var breadcrumb = PropTypes$1.shape({
-  url: PropTypes$1.string
-});
-var breadcrumbs = PropTypes$1.arrayOf(breadcrumb);
-var font = PropTypes$1.shape({
-  // url: PropTypes.string,
-});
-var fonts = PropTypes$1.arrayOf(font);
-var trackingVariables = PropTypes$1.shape({});
-var modal = PropTypes$1.shape({
-  name: PropTypes$1.string
-});
-var modals = PropTypes$1.arrayOf(modal);
-var filter = PropTypes$1.shape({
-  id: PropTypes$1.string,
-  component: PropTypes$1.string
-});
-var filters = PropTypes$1.arrayOf(filter);
-var media = PropTypes$1.shape({
-  id: PropTypes$1.string.isRequired,
-  name: PropTypes$1.string.isRequired,
-  type: PropTypes$1.string.isRequired,
-  thumbnail_url: PropTypes$1.string
-});
-var medias = PropTypes$1.arrayOf(media);
-var preview = PropTypes$1.shape({
-  id: PropTypes$1.string
-});
-var previews = PropTypes$1.arrayOf(preview);
-
-var PropTypes = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    breadcrumb: breadcrumb,
-    breadcrumbs: breadcrumbs,
-    button: button,
-    buttonSize: buttonSize,
-    buttonTheme: buttonTheme,
-    buttonType: buttonType,
-    buttons: buttons,
-    controlSize: controlSize,
-    definition: definition,
-    dropdownAlign: dropdownAlign,
-    feedback: feedback,
-    field: field,
-    fieldOption: fieldOption,
-    fieldOptions: fieldOptions,
-    fields: fields,
-    filter: filter,
-    filters: filters,
-    font: font,
-    fonts: fonts,
-    form: form,
-    formError: formError,
-    formErrors: formErrors,
-    formStatus: formStatus,
-    forms: forms,
-    intl: intl,
-    item: item,
-    items: items,
-    label: label,
-    media: media,
-    medias: medias,
-    menuItem: menuItem,
-    menuItems: menuItems,
-    message: message,
-    modal: modal,
-    modals: modals,
-    page: page,
-    pages: pages,
-    panneauDefinition: panneauDefinition,
-    preview: preview,
-    previews: previews,
-    resource: resource,
-    resources: resources,
-    routes: routes,
-    selectOption: selectOption,
-    selectOptions: selectOptions,
-    statusCode: statusCode,
-    tableColumn: tableColumn,
-    tableColumns: tableColumns,
-    toggle: toggle,
-    toggles: toggles,
-    trackingVariables: trackingVariables,
-    triggerUpdate: triggerUpdate,
-    uppy: uppy,
-    user: user,
-    users: users
-});
-
-var _flattenComponents = function flattenComponents(components) {
-  var prefix = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
-  if (components === null) {
-    return null;
-  }
-  return Object.keys(components).reduce(function (newMap, key) {
-    return ReactIs.isValidElementType(components[key]) ? _objectSpread(_objectSpread({}, newMap), {}, _defineProperty({}, prefix !== null ? "".concat(prefix, ".").concat(key) : key, components[key])) : _objectSpread(_objectSpread({}, newMap), _flattenComponents(components[key], key));
-  }, {});
-};
-
-var getComponentFromName = function getComponentFromName() {
-  var name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
-  var components = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var defaultComponent = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-  if (components === null || name === null) {
-    return defaultComponent;
-  }
-  var pascalName = pascalCase(name);
-  var component = components[pascalName] || components[name] || defaultComponent;
-  if (!component) {
-    console.warn('Could not find component from name', name, pascalName, components);
-  }
-  return component;
-};
 
 var ComponentsManager = /*#__PURE__*/function () {
   function ComponentsManager() {
     var components = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     _classCallCheck(this, ComponentsManager);
     _defineProperty(this, "components", void 0);
-    this.components = _flattenComponents(components);
+    this.components = flattenComponents(components);
   }
   return _createClass(ComponentsManager, [{
     key: "addComponent",
@@ -910,4 +659,4 @@ var Tracking = /*#__PURE__*/function (_BaseTracking) {
   }]);
 }(Tracking$1);
 
-export { ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, FormsManager, MediasParser, PropTypes, Tracking };
+export { ComponentsManager, DefinitionsManager, EventsManager, FieldsManager, FontsParser, FormsManager, MediasParser, Tracking };

package/dist/utils.d.ts

@@ -0,0 +1,207 @@
+export { kebabCase as dashCase, pascalCase, snakeCase } from 'change-case';
+import { ComponentType, ReactNode, ReactElement } from 'react';
+import { MessageDescriptor } from 'react-intl';
+
+interface CheckClickableOptions {
+    maxParentDistance?: number;
+    tags?: string[];
+}
+interface ElementLike {
+    tagName?: string | null;
+    parentNode?: ElementLike | null;
+    dataset?: Record<string, unknown>;
+}
+declare function checkClickable(el: ElementLike | null, options?: CheckClickableOptions, parentDistance?: number): boolean;
+
+declare function convertStyleToString(style: Record<string, unknown> | null): string;
+
+declare function createNullableOnChange<T = unknown>(onChange?: ((value: T | null) => void) | null): (newValue: T) => void;
+
+interface EventsManager {
+    subscribe: (event: string, callback: (...args: unknown[]) => void) => void;
+    unsubscribe: (event: string, callback: (...args: unknown[]) => void) => void;
+}
+declare function createUseEvent(eventsManager: EventsManager | null): (event: string, callback: (...args: unknown[]) => void, enabled?: boolean) => void;
+
+/*! clipboard-copy. MIT License. Feross Aboukhadijeh <https://feross.org/opensource> */
+declare function copyToClipboard(text: string): Promise<void>;
+
+type ComponentMap = Record<string, ComponentType<unknown> | ComponentMap>;
+declare function flattenComponents(components: ComponentMap | null, prefix?: string | null): Record<string, ComponentType<unknown>> | null;
+
+declare function formatDuration(timeInSeconds: number | string): string;
+
+/**
+ * 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;
+
+/**
+ * Form Types
+ * TypeScript interfaces for form-related components
+ */
+
+/**
+ * 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;
+}
+/**
+ * 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 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;
+}
+
+/**
+ * Panneau Definition Types
+ * TypeScript interfaces for main Panneau configuration and definitions
+ */
+
+/**
+ * Generic definition
+ */
+interface Definition {
+    name?: string;
+    [key: string]: unknown;
+}
+
+interface Column extends Record<string, unknown> {
+    id?: string | null;
+    label?: unknown;
+    valueKey?: string;
+    component?: string | null;
+    field?: Field | string | null;
+}
+declare function getColumnsWithFields(resource: Resource, columns: TableColumn[] | null): Column[];
+
+interface ComponentResult {
+    name: unknown;
+    props: Record<string, unknown> | null;
+}
+declare function getComponent(component: unknown): ComponentResult;
+
+declare function getComponentFromName<T = ComponentType<unknown> | 'string'>(name?: string | null, components?: Record<string, T> | null, defaultComponent?: T | null): T | null;
+
+declare function getDefinitionFromId<T extends Definition = Definition>(id?: string | null, items?: T[] | null, defaultObject?: T | null): T | null;
+
+interface ComponentWithName {
+    displayName?: string | null;
+    name?: string | null;
+}
+declare function getDisplayName({ displayName, name }: ComponentWithName): string;
+
+interface FieldWithSubFields$1 extends Field {
+    fields?: FieldWithSubFields$1[];
+}
+declare function getFieldByName(fields: FieldWithSubFields$1[], name: string | null): FieldWithSubFields$1 | null;
+
+interface FieldDefinition {
+    fields?: Field[] | null;
+    settings?: Field[] | null;
+    itemsField?: Field | null;
+}
+interface FieldManager {
+    getDefinition: (type: string) => FieldDefinition;
+}
+interface FieldWithSubFields extends Field {
+    type?: string | null;
+    fields?: Field[] | null;
+    field?: Field | null;
+    listItems?: boolean;
+}
+declare function getFieldFromPath(path: string | string[], fields: Field[], fieldManager: FieldManager): FieldWithSubFields | null;
+
+declare function getFileName(url?: string | null): string | null;
+
+declare function getPathValue(it: unknown, path: string | string[]): unknown;
+
+interface FormattedOption {
+    value: unknown;
+    label: string | ReactElement;
+}
+declare function getSelectOptions(options: SelectOption[]): FormattedOption[];
+
+declare function isMessage(message: unknown): message is Message;
+
+declare function loadPackage<T = unknown>(name: string, loader: () => Promise<T>): Promise<T>;
+
+declare function selectItem(item: Item, selectedItems: Item | Item[] | null, onSelectionChange: ((value: Item | Item[] | null) => void) | null, multipleSelection?: boolean): void;
+declare function selectPage(pageSelected: boolean, items: Item[] | null, selectedItems: Item[] | null, onSelectionChange: ((value: Item[]) => void) | null): void;
+
+type Value = Record<string, unknown> | unknown[] | null;
+declare function setValue(value: Value, keyParts: string[], fieldValue: unknown): Value;
+
+declare function slug(str: string, separator?: string | null): string;
+
+interface FieldWithValidation extends Field {
+    type?: string;
+    fields?: FieldWithValidation[];
+    required?: boolean;
+}
+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, selectItem, selectPage, setValue as setFieldValue, slug, validateFields };