@redneckz/wildless-cms-uni-blocks 0.2.85 → 0.2.86

package/src/components/ProductBlock/ProductBlockContent.ts

@@ -1,11 +1,16 @@
-import type { LinkContent } from '../../model/LinkContent';
-import type { BaseTileContent } from '../BaseTile/BaseTileContent';
+import type { LinkProps } from '../../model/LinkProps';
+import type { BaseTileCommonProps } from '../BaseTile/BaseTileProps';
 import type { Benefit } from '../BenefitsBlock/BenefitsBlockContent';
 
-export interface ProductBlockInnerContent extends BaseTileContent {
+export interface ProductBlockInnerCommonProps extends BaseTileCommonProps {
+  /** @title Преимущества */
   benefits?: Benefit[];
 }
 
-export interface ProductBlockContent extends ProductBlockInnerContent {
-  breadcrumbs?: LinkContent[];
+/**
+ * @title Продуктовый блок
+ */
+export interface ProductBlockContent extends ProductBlockInnerCommonProps {
+  /** @title Хлебные крошки */
+  breadcrumbs?: LinkProps[];
 }

package/src/components/ProductBlock/ProductBlockInner.tsx

@@ -1,13 +1,13 @@
 import { JSX } from '@redneckz/uni-jsx';
-import { BaseTile } from '../BaseTile/BaseTile';
-import type { Benefit } from '../BenefitsBlock/BenefitsBlockContent';
-import type { ProductBlockInnerContent } from './ProductBlockContent';
 import type { UniBlockProps } from '../../types';
 import { Icon } from '../../ui-kit/Icon/Icon';
 import { Img } from '../../ui-kit/Img';
 import { Title } from '../../ui-kit/Title/Title';
+import { BaseTile } from '../BaseTile/BaseTile';
+import type { Benefit } from '../BenefitsBlock/BenefitsBlockContent';
+import type { ProductBlockInnerCommonProps } from './ProductBlockContent';
 
-export interface ProductBlockInnerProps extends ProductBlockInnerContent, UniBlockProps {}
+export interface ProductBlockInnerProps extends ProductBlockInnerCommonProps, UniBlockProps {}
 
 export const ProductBlockInner = JSX<ProductBlockInnerProps>(
   ({ className, context, title, titleSize, description, benefits, buttons, image, items }) => {

package/src/components/ProductGallery/ProductGallery.example.json

@@ -0,0 +1,21 @@
+{
+  "slides": [
+    {
+      "nav": {
+        "title": "Заголовок",
+        "desc": "Описание"
+      },
+      "productBlock": {
+        "title": "Продуктовая галерея",
+        "image": {
+          "format": "webp",
+          "size": {
+            "width": 300
+          }
+        },
+        "description": "Описание",
+        "items": ["Элемент списка 1", "Элемент списка 2", "Элемент списка 3"]
+      }
+    }
+  ]
+}

package/src/components/ProductGallery/ProductGallery.tsx

@@ -1,8 +1,8 @@
 import { JSX } from '@redneckz/uni-jsx';
+import type { UniBlockProps } from '../../types';
+import type { ProductBlockInnerCommonProps } from '../ProductBlock/ProductBlockContent';
 import { ProductBlockInner } from '../ProductBlock/ProductBlockInner';
-import type { ProductBlockInnerContent } from '../ProductBlock/ProductBlockContent';
 import type { ProductGalleryContent } from './ProductGalleryContent';
-import type { UniBlockProps } from '../../types';
 
 export interface ProductGalleryProps extends ProductGalleryContent, UniBlockProps {}
 
@@ -38,7 +38,7 @@ export const ProductGallery = JSX<ProductGalleryProps>(
   },
 );
 
-function renderProductBlock(block: ProductBlockInnerContent, i: number, context) {
+function renderProductBlock(block: ProductBlockInnerCommonProps, i: number, context) {
   return (
     <section key={String(i)} className="flex grow-0 shrink-0 basis-full" role="listitem">
       <div className="p-10 flex grow">

package/src/components/ProductGallery/ProductGalleryContent.ts

@@ -1,16 +1,31 @@
-import type { ProductBlockInnerContent } from '../ProductBlock/ProductBlockContent';
+import type { ProductBlockInnerCommonProps } from '../ProductBlock/ProductBlockContent';
 
+/** @title Кнопка под слайдом */
 interface ProductGalleryNav {
+  /** @title Заголовок */
   title: string;
+  /** @title Описание */
   desc: string;
 }
 
+/**
+ * @title Слайд
+ */
 export interface ProductSlideContent {
   nav: ProductGalleryNav;
-  productBlock: ProductBlockInnerContent;
+  /** @title Содержимое слайда */
+  productBlock: ProductBlockInnerCommonProps;
 }
 
+/**
+ * @title Продуктовая галерея
+ */
 export interface ProductGalleryContent {
+  /**
+   * @title Задержка
+   * @hidden //! temporary not used
+   */
   duration?: number;
+  /** @title Слайды */
   slides?: ProductSlideContent[];
 }

package/src/components/ProductTile/ProductTile.example.json

@@ -0,0 +1,30 @@
+{
+  "title": "Продуктовая плитка",
+  "description": "Описание",
+  "image": {
+    "format": "webp",
+    "size": {
+      "width": 300
+    }
+  },
+  "benefits": [
+    {
+      "label": "Преимущество 1",
+      "description": "Описание"
+    },
+    {
+      "label": "Преимущество 2",
+      "description": "Описание"
+    },
+    {
+      "label": "Преимущество 3",
+      "description": "Описание"
+    }
+  ],
+  "buttons": [
+    {
+      "text": "Подробнее",
+      "version": "primary"
+    }
+  ]
+}

package/src/components/ProductTile/ProductTileContent.ts

@@ -1,6 +1,10 @@
-import type { BaseTileContent } from '../BaseTile/BaseTileContent';
+import type { BaseTileCommonProps } from '../BaseTile/BaseTileProps';
 import type { Benefit } from '../BenefitsBlock/BenefitsBlockContent';
 
-export interface ProductTileContent extends BaseTileContent {
+/**
+ * @title Продуктовая плитка
+ */
+export interface ProductTileContent extends BaseTileCommonProps {
+  /** @title Преимущества */
   benefits?: Benefit[];
 }

package/src/components/PromoTile/PromoTile.example.json

@@ -0,0 +1,13 @@
+{
+  "title": "Акции и спецпредложения",
+  "date": "2022-04-16",
+  "description": "Пенсионный кредит по специальной процентной ставке",
+  "buttons": [
+    {
+      "text": "Все акции",
+      "href": "/credits",
+      "version": "secondary"
+    }
+  ],
+  "version": "secondary"
+}

package/src/components/PromoTile/PromoTileContent.ts

@@ -1,5 +1,9 @@
-import type { BaseTileContent } from '../BaseTile/BaseTileContent';
+import type { BaseTileCommonProps } from '../BaseTile/BaseTileProps';
 
-export interface PromoTileContent extends BaseTileContent {
+/**
+ * @title Акции
+ */
+export interface PromoTileContent extends BaseTileCommonProps {
+  /** @title Дата публикации */
   date?: string;
 }

package/src/components/StepsBlock/StepsBlock.example.json

@@ -0,0 +1,17 @@
+{
+  "title": "Шаги",
+  "steps": [
+    {
+      "label": "Шаг №1",
+      "icon": "NewDocIcon"
+    },
+    {
+      "label": "Шаг №2",
+      "icon": "PassSendIcon"
+    },
+    {
+      "label": "Шаг №3",
+      "icon": "ActualBalanceIcon"
+    }
+  ]
+}

package/src/components/StepsBlock/StepsBlockContent.ts

@@ -1,12 +1,25 @@
 import type { IconName } from '../../ui-kit/Icon/IconProps';
 
+/**
+ * @title Шаг
+ */
 export interface Step {
+  /** @title Название */
   label: string;
+  /** @title Описание */
   description?: string;
   icon?: IconName;
 }
 
+/**
+ * @title Блок шаги
+ */
 export interface StepsBlockContent {
+  /** @title Заголовок */
   title?: string;
+  /**
+   * @title Шаги
+   * @maxItems 6
+   */
   steps?: Step[];
 }

package/src/components/TextBlock/TextBlock.example.json

@@ -0,0 +1,6 @@
+{
+  "title": "Заголовок",
+  "description": "Описание",
+  "blockVersion": "primary",
+  "iconVersion": "small"
+}

package/src/components/TextBlock/TextBlockContent.ts

@@ -1,10 +1,24 @@
 import type { Picture } from '../../model/Picture';
 
+/**
+ * @title Цвет плитки
+ * @enumNames ["Основная", "Второстепенная", "Второстепенная прозрачная"]
+ */
 export type TextBlockVersion = 'primary' | 'secondary' | 'secondary-light';
+
+/**
+ * @title Размер иконки
+ * @enumNames ["Нет", "Маленькая", "Большая"]
+ */
 export type TextBlockIconVersion = 'none' | 'small' | 'big';
 
+/**
+ * @title Текстовый блок
+ */
 export interface TextBlockContent {
+  /** @title Заголовок */
   title?: string;
+  /** @title Описание */
   description?: string;
   blockVersion?: TextBlockVersion;
   iconVersion?: TextBlockIconVersion;

package/src/components/Tile/Tile.example.json

@@ -0,0 +1,18 @@
+{
+  "title": "Плитка",
+  "titleSize": "M",
+  "description": "Описание",
+  "image": {
+    "format": "webp",
+    "size": {
+      "width": 300
+    }
+  },
+  "items": ["Пункт 1", "Пункт 2", "Пункт 3"],
+  "buttons": [
+    {
+      "text": "Подробнее",
+      "version": "primary"
+    }
+  ]
+}

package/src/components/Tile/TileContent.ts

@@ -1,3 +1,6 @@
-import type { BaseTileContent } from '../BaseTile/BaseTileContent';
+import type { BaseTileCommonProps } from '../BaseTile/BaseTileProps';
 
-export type TileContent = BaseTileContent;
+/**
+ * @title Плитка
+ */
+export type TileContent = BaseTileCommonProps;

package/src/hooks/useLink.ts

@@ -1,5 +1,5 @@
 import { HandlerDecorator, Router } from '../components/ContentPage/ContentPageContext';
-import type { LinkContent } from '../model/LinkContent';
+import type { LinkProps } from '../model/LinkProps';
 import { adjustHref, isURL } from '../utils/url';
 
 const defaultHandlerDecorator: HandlerDecorator = (handler, targetContent) => handler;
@@ -9,7 +9,7 @@ export function useLink(
     router,
     handlerDecorator = defaultHandlerDecorator,
   }: { router: Router; handlerDecorator?: HandlerDecorator },
-  link: Partial<LinkContent & { className: string }>,
+  link: Partial<LinkProps & { className: string }>,
 ) {
   const href = adjustHref(link.href, router);
   return {

package/src/index.ts

@@ -1,33 +1,26 @@
 export { setup } from '@redneckz/uni-jsx';
-
-export type { ProjectSettings } from './ProjectSettings';
-export { projectSettings } from './ProjectSettings';
-
-export { LikeAPI } from './api/LikeAPI';
 export { DaDataAPI } from './api/DaDataAPI';
-
-export type { SitemapContent } from './model/SitemapContent';
-
-export type { Img, ImgSource, Picture } from './model/Picture';
-export type { BlockDef, UniBlockProps, ContentPageMeta, ContentPageDef } from './types';
+export { LikeAPI } from './api/LikeAPI';
+export type { BlockContent } from './components/BlockContent';
+export { Blocks } from './components/Blocks';
+export { ContentPage } from './components/ContentPage/ContentPage';
+export type { BlockDecorator } from './components/ContentPage/ContentPage';
 export type {
-  ContentPageContext,
-  Router,
   AsyncDataHook,
+  ContentPageContext,
   GeolocationHook,
-  LikeService,
   HandlerDecorator,
+  LikeService,
+  Router,
   Search,
 } from './components/ContentPage/ContentPageContext';
-
 export { ContentPageHead } from './components/ContentPage/ContentPageHead';
-export type { BlockDecorator } from './components/ContentPage/ContentPage';
-export { ContentPage } from './components/ContentPage/ContentPage';
 export { toMobilePage } from './components/ContentPage/toMobilePage';
-
-export { Blocks } from './components/Blocks';
-export type { BlockContent } from './components/BlockContent';
 export { MobileBlocks } from './components/MobileBlocks';
-
-export * as url from './utils/url';
+export type { Img, ImgSource, Picture } from './model/Picture';
+export type { SitemapProps as SitemapContent } from './model/SitemapProps';
+export { projectSettings } from './ProjectSettings';
+export type { ProjectSettings } from './ProjectSettings';
+export type { BlockDef, ContentPageDef, ContentPageMeta, UniBlockProps } from './types';
 export { joinList } from './utils/joinList';
+export * as url from './utils/url';

package/src/mergeTopItems.ts

@@ -1,13 +1,13 @@
-import type { LinkContent } from './model/LinkContent';
+import type { LinkProps } from './model/LinkProps';
 
-const cmp = (a?: LinkContent) => (b?: LinkContent) => a?.href === b?.href;
+const cmp = (a?: LinkProps) => (b?: LinkProps) => a?.href === b?.href;
 
-const substitute = <L extends LinkContent>(items?: L[], substitution?: L[]): L[] =>
+const substitute = <L extends LinkProps>(items?: L[], substitution?: L[]): L[] =>
   (items || []).map((_) => substitution?.find(cmp(_)) || _);
 
-const subtract = <L extends LinkContent>(minuend?: L[], subtrahend?: L[]): L[] =>
+const subtract = <L extends LinkProps>(minuend?: L[], subtrahend?: L[]): L[] =>
   (minuend || []).filter((_) => !subtrahend?.find(cmp(_)));
 
-export function mergeTopItems<L extends LinkContent>(left?: L[], right?: L[]): L[] {
+export function mergeTopItems<L extends LinkProps>(left?: L[], right?: L[]): L[] {
   return substitute(left, right).concat(subtract(right, left));
 }

package/src/model/BlockVersion.ts

@@ -1 +1,5 @@
+/**
+ * @title Цвет плитки
+ * @enumNames ["Основная", "Второстепенная"]
+ */
 export type BlockVersion = 'primary' | 'secondary';

package/src/model/ButtonVersion.ts

@@ -1 +1,5 @@
+/**
+ * @title Цвет кнопки
+ * @enumNames ["Основная", "Второстепенная"]
+ */
 export type ButtonVersion = 'primary' | 'secondary';

package/src/model/LinkProps.ts

@@ -0,0 +1,22 @@
+/**
+ * @title Таргет (target)
+ * @enumNames [
+ *    "self (текущее окно или фрейм)",
+ *    "blank (новое окно)",
+ *    "parent (фрейм-родитель)",
+ *    "top (текущее окно)"
+ *  ]
+ */
+export type Target = '_blank' | '_self' | '_parent' | '_top';
+
+/**
+ * @title Ссылка
+ * @required ["text", "href"]
+ */
+export interface LinkProps {
+  /** @title Текст */
+  text?: string;
+  /** @title URL (href) */
+  href?: string;
+  target?: Target;
+}

package/src/model/Picture.ts

@@ -1,19 +1,30 @@
 export interface Img {
+  /** @title Картинка */
   src: string;
+  /** @title Альтернативный текст (alt) */
   alt?: string;
+  /** @title Текст подсказки (title) */
   title?: string;
 }
 
 export interface ImgSource {
+  /** @title Картинка */
   src: string;
+  /** @title Формат */
   format?: 'jpeg' | 'jpg' | 'png' | 'gif' | 'webp' | 'heif' | 'avif';
+  /** @hidden */
   options?: Record<string, any>;
+  /** @title Размер изображения */
   size?: {
+    /** @title Ширина */
     width?: number;
+    /** @title Высота */
     height?: number;
   };
 }
 
+/** @title Изображение */
 export interface Picture extends Img, ImgSource {
+  /** @title Другие форматы */
   sources?: ImgSource[];
 }

package/src/model/SitemapProps.ts

@@ -0,0 +1,15 @@
+import type { LinkProps } from './LinkProps';
+
+/**
+ * @title Ссылка
+ * @required ["text", "href"]
+ */
+export interface TopMenuItem extends LinkProps {
+  /** @hidden */
+  items?: LinkProps[];
+}
+
+export interface SitemapProps {
+  /** @title Дополнительное меню */
+  topItems?: TopMenuItem[];
+}

package/src/types.ts

@@ -2,13 +2,13 @@ import type { BlockContent } from './components/BlockContent';
 import type { ContentPageContext } from './components/ContentPage/ContentPageContext';
 import type { BlockVersion } from './model/BlockVersion';
 
-export type ColorPalette = 'pc' | 'bc' | 'eo';
+export type ColorPalette = 'pc' | 'bc' | 'eo' | 'eo2' | 'eo3' | 'eo4';
 
 export interface BlockDef {
   type: string;
   style?: string[];
-  version?: BlockVersion;
   content?: BlockContent;
+  version?: BlockVersion;
   blocks?: BlockDef[];
   mobile?: Pick<BlockDef, 'content' | 'style'> & {
     hidden?: boolean;

package/src/ui-kit/Breadcrumb.tsx

@@ -1,7 +1,7 @@
 import { JSX } from '@redneckz/uni-jsx';
-import type { LinkContent } from '../model/LinkContent';
+import type { LinkProps } from '../model/LinkProps';
 
-export interface BreadcrumbProps extends LinkContent {
+export interface BreadcrumbProps extends LinkProps {
   className?: string;
   onClick?: (ev: MouseEvent) => any;
 }

package/src/ui-kit/Button/Button.tsx

@@ -1,6 +1,6 @@
 import { JSX } from '@redneckz/uni-jsx';
 import type { ButtonVersion } from '../../model/ButtonVersion';
-import type { ButtonInnerProps, ButtonProps } from './ButtonProps';
+import type { ButtonProps, ButtonWithIconProps } from './ButtonProps';
 
 const buttonStyleMap: Record<ButtonVersion, string> = {
   primary: 'text-white bg-primary-main hover:bg-primary-hover active:bg-primary-active',
@@ -15,7 +15,11 @@ const buttonDisabledStyleMap: Record<ButtonVersion, string> = {
 
 const styleButton = 'inline-block text-center font-sans select-none';
 
-export const Button = JSX<ButtonProps>(
+export interface ButtonCommonProps extends ButtonProps, ButtonWithIconProps {}
+
+export type ButtonInner = Pick<ButtonCommonProps, 'text' | 'aboveText' | 'appendLeft' | 'rounded'>;
+
+export const Button = JSX<ButtonCommonProps>(
   ({
     className,
     text,
@@ -69,7 +73,7 @@ export const Button = JSX<ButtonProps>(
   },
 );
 
-export const ButtonInner = JSX<ButtonInnerProps>(({ text, aboveText, appendLeft, rounded }) => {
+export const ButtonInner = JSX<ButtonInner>(({ text, aboveText, appendLeft, rounded }) => {
   const withoutText = !text && !aboveText && Boolean(appendLeft);
 
   const buttonInnerClasses = `flex items-center justify-center ${

package/src/ui-kit/Button/ButtonProps.ts

@@ -1,24 +1,27 @@
 import type { ButtonVersion } from '../../model/ButtonVersion';
-import type { LinkContent } from '../../model/LinkContent';
-import { IconName } from '../Icon/IconProps';
+import type { LinkProps } from '../../model/LinkProps';
 
-export interface ButtonInnerProps {
-  text?: string;
-  aboveText?: string;
-  appendLeft?: any;
-  rounded?: boolean;
-}
-
-export interface ButtonProps extends LinkContent, ButtonInnerProps {
+/**
+ * @hidden
+ */
+export interface ButtonAdditionalProps {
   className?: string;
-  version?: ButtonVersion;
   disabled?: boolean;
   rel?: string;
   ariaLabel?: string;
-  /** @hidden */
   onClick?: (ev: MouseEvent) => any;
 }
 
+export interface ButtonProps extends ButtonAdditionalProps, LinkProps {
+  text?: string;
+  version?: ButtonVersion;
+}
+
 export interface ButtonWithIconProps extends ButtonProps {
-  icon?: IconName;
+  /** @hidden */
+  aboveText?: string;
+  /** @hidden */
+  appendLeft?: any;
+  /** @hidden */
+  rounded?: boolean;
 }

package/src/ui-kit/Icon/IconProps.ts

@@ -1,29 +1,60 @@
+/**
+ * Icons sorted by name
+ */
 export enum IconMap {
   'ActualBalanceIcon',
   'AppleIcon',
   'CalendarIcon',
   'ClockIcon',
   'ComfortableCompIcon',
+  'DocIcon',
   'DollarIcon',
   'EmptyWalletIcon',
   'EuroIcon',
+  'GlassIcon',
   'GridIcon',
   'LoupeIcon',
+  'MinusIcon',
   'NewDocIcon',
   'OkIcon',
   'PassSendIcon',
   'PercentageSquareIcon',
   'PlayMarketIcon',
+  'PlusIcon',
   'ProfileIcon',
   'SignDocsIcon',
   'TelegramIcon',
   'VKIcon',
-  'GlassIcon',
-  'DocIcon',
-  'PlusIcon',
-  'MinusIcon',
 }
 
+/**
+ * @title Иконка
+ * @enumNames [
+ *    "Деньги",
+ *    "Лого «Apple»",
+ *    "Календарь",
+ *    "Часы",
+ *    "Кресло",
+ *    "Документ",
+ *    "Доллар",
+ *    "Кошелек",
+ *    "Евро",
+ *    "Зеркало",
+ *    "Сетка",
+ *    "Лупа",
+ *    "Минус",
+ *    "Новый документ",
+ *    "Лого «Одноклассники»",
+ *    "Бизнес",
+ *    "Проценты",
+ *    "Лого «PlayMarket»",
+ *    "Плюс",
+ *    "Профиль",
+ *    "Подписанные документы",
+ *    "Лого «Telegram»",
+ *    "Лого «VK»"
+ *  ]
+ */
 export type IconName = keyof typeof IconMap;
 
 export interface IconProps {

package/src/ui-kit/TopItem/TopItem.tsx

@@ -1,7 +1,7 @@
 import { JSX } from '@redneckz/uni-jsx';
-import type { LinkContent } from '../../model/LinkContent';
+import type { LinkProps } from '../../model/LinkProps';
 
-export interface TopItemContent extends LinkContent {
+export interface TopItemContent extends LinkProps {
   active?: boolean;
 }
 

package/dist/components/BaseTile/BaseTileContent.d.ts

@@ -1,13 +0,0 @@
-import type { BlockVersion } from '../../model/BlockVersion';
-import type { Picture } from '../../model/Picture';
-import type { ButtonWithIconProps } from '../../ui-kit/Button/ButtonProps';
-import type { TitleSize } from '../../ui-kit/Title/TitleProps';
-export interface BaseTileContent {
-    title?: string;
-    titleSize?: TitleSize;
-    description?: string;
-    image?: Picture;
-    items?: string[];
-    buttons?: ButtonWithIconProps[];
-    version?: BlockVersion;
-}