@open-tender/types 0.1.8 → 0.1.9

package/dist/esm/types/api/theme.d.ts

@@ -0,0 +1,493 @@
+export interface ThemeAlert extends Record<string, string> {
+    bgColor: string;
+    color: string;
+}
+export interface ThemeColorsBase extends Record<string, string> {
+    alert: string;
+    allergens: string;
+    dark: string;
+    error: string;
+    light: string;
+    primary: string;
+    secondary: string;
+    success: string;
+    tertiary: string;
+    toast: string;
+}
+export interface ThemeBackgroundColors extends ThemeColorsBase {
+    highlight: string;
+}
+export interface ThemeBorder extends Record<string, string> {
+    color: string;
+    radius: string;
+    radiusSmall: string;
+    width: string;
+    widthApp: string;
+}
+export interface ThemeBoxShadow extends Record<string, string> {
+    appBig: string;
+    appSmall: string;
+    inset: string;
+    outer: string;
+}
+export interface ThemeBreakpoints extends Record<string, string> {
+    laptop: string;
+    mobile: string;
+    narrow: string;
+    tablet: string;
+}
+export interface ThemeColors extends ThemeColorsBase {
+    title: string;
+}
+export interface ThemeButtonColor extends Record<string, string> {
+    color: string;
+    bgColor: string;
+    borderColor: string;
+}
+export interface ThemeButtonLargeColor extends ThemeButtonColor {
+    iconColor: string;
+    subtitleColor: string;
+}
+export interface ThemeButtonColors extends Record<string, ThemeButtonColor | ThemeButtonLargeColor> {
+    cart: ThemeButtonColor;
+    cartHover: ThemeButtonColor;
+    header: ThemeButtonColor;
+    headerHover: ThemeButtonColor;
+    large: ThemeButtonLargeColor;
+    largeHover: ThemeButtonLargeColor;
+    light: ThemeButtonColor;
+    lightHover: ThemeButtonColor;
+    primary: ThemeButtonColor;
+    primaryHover: ThemeButtonColor;
+    secondary: ThemeButtonColor;
+    secondaryHover: ThemeButtonColor;
+}
+export interface ThemeButtonSize extends Record<string, string | boolean> {
+    borderRadius: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    family: string;
+    fontMobile: string;
+    fontSize: string;
+    fontSmoothing: string;
+    fontStyle: string;
+    letterSpacing: string;
+    padding: string;
+    textTransform: string;
+    weight: string;
+}
+export interface ThemeButtonLargeSize extends ThemeButtonSize {
+    minHeight: string;
+    minHeightMobile: string;
+    showButtonApp: boolean;
+    showSubtitle: boolean;
+    showSubtitleMobile: boolean;
+    subtitleFontMobile: string;
+    subtitleFontSize: string;
+    subtitleFontSizeMobile: string;
+    subtitleFontWeight: string;
+    subtitleMarginTop: string;
+    subtitleMarginTopMobile: string;
+    titleFontMobile: string;
+    titleFontSize: string;
+    titleFontSizeMobile: string;
+    titleFontWeight: string;
+    titleMarginLeft: string;
+    titleMarginLeftMobile: string;
+    titleMarginTop: string;
+    titleMarginTopMobile: string;
+}
+export interface ThemeButtonSizes extends Record<string, ThemeButtonSize | ThemeButtonLargeSize> {
+    big: ThemeButtonSize;
+    default: ThemeButtonSize;
+    header: ThemeButtonSize;
+    large: ThemeButtonLargeSize;
+    small: ThemeButtonSize;
+}
+export interface ThemeButtons extends Record<string, ThemeButtonColors | ThemeButtonSizes> {
+    colors: ThemeButtonColors;
+    sizes: ThemeButtonSizes;
+}
+export interface ThemeCard extends Record<string, string | boolean | number> {
+    bgColor: string;
+    borderColor: string;
+    borderRadius: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    boxShadow: string;
+    displayAsCard: boolean;
+    overrideFontColors: boolean;
+    padding: string;
+    paddingApp: string;
+    textColor: string;
+    textSize: string;
+    textSizeMobile: string;
+    titleColor: string;
+    titleSize: string;
+    titleSizeMobile: string;
+}
+export interface ThemeCardItem extends ThemeCard {
+    caloriesColor: string;
+    caloriesSize: string;
+    caloriesSizeMobile: string;
+    imageAsImg: boolean;
+    imageAspectRatio: number;
+    imageBgSize: string;
+    priceColor: string;
+    priceSize: string;
+    priceSizeMobile: string;
+}
+export interface ThemeCards extends Record<string, ThemeCard | ThemeCardItem> {
+    default: ThemeCard;
+    form: ThemeCard;
+    menuItem: ThemeCardItem;
+    modifier: ThemeCardItem;
+}
+export declare type ThemeTextAlignment = 'left' | 'right' | 'center' | 'justify';
+export declare type ThemeJustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
+export declare type ThemeCategoryDisplayType = 'LIST' | 'CARDS' | 'SQUARES';
+export declare type ThemeCategoryLineType = 'none' | 'underline' | 'overline';
+export interface ThemeCategory extends Record<string, string | number | boolean> {
+    backgroundColor: string;
+    backgroundColorHover: string;
+    borderRadius: string;
+    boxShadow: string;
+    containerMaxWidth: string;
+    displayType: ThemeCategoryDisplayType;
+    gap: string;
+    gapDouble: string;
+    gapHalf: string;
+    imageBgSize: string;
+    imageBorderRadius: string;
+    imagePadding: string;
+    imageRatio: number;
+    imageScale: number;
+    imageScaleHover: number;
+    justifyContent: ThemeJustifyContent;
+    lineHeight: string;
+    lineMargin: string;
+    lineType: ThemeCategoryLineType;
+    lineWidth: string;
+    maxWidth: string;
+    minWidth: string;
+    overlayColor: string;
+    overlayOpacity: number;
+    overlayOpacityHover: number;
+    paddingBottom: string;
+    paddingHorizontal: string;
+    paddingTop: string;
+    perRow: number;
+    showDescription: boolean;
+    subtitleColor: string;
+    subtitleColorHover: string;
+    subtitleSize: string;
+    textAlign: ThemeJustifyContent;
+    textAlignVertical: ThemeJustifyContent;
+    textAlignment: ThemeTextAlignment;
+    titleColor: string;
+    titleColorHover: string;
+    titleSize: string;
+    transition: string;
+    width: string;
+}
+export interface ThemeCategories extends Record<string, ThemeCategory> {
+    desktop: ThemeCategory;
+    mobile: ThemeCategory;
+}
+export interface ThemeCount extends Record<string, string | boolean> {
+    bgColor: string;
+    borderColor: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    color: string;
+    family: string;
+    fontMobile: string;
+    fontSize: string;
+    fontSizeMobile: string;
+    fontSmoothing: string;
+    fontStyle: string;
+    hide: boolean;
+    paddingBottom: string;
+    paddingTop: string;
+    weight: string;
+}
+export interface ThemeCounts extends Record<string, ThemeCount> {
+    alerts: ThemeCount;
+    quantity: ThemeCount;
+}
+export interface ThemeFavorite extends Record<string, string> {
+    iconSize: string;
+    size: string;
+}
+export declare type ThemeFontSize = 'big' | 'giga' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'main' | 'mega' | 'small' | 'tera' | 'xBig' | 'xSmall' | 'xxBig' | 'xxSmall';
+export declare type ThemeFontSizes = Record<string, string> & {
+    [keys in ThemeFontSize]: string;
+};
+export interface ThemeFont extends Record<string, string | ThemeFontSizes | undefined | number> {
+    color: string;
+    family: string;
+    fontSize?: string;
+    fontMobile: string;
+    fontSmoothing: string;
+    fontStyle: string;
+    letterSpacing: string;
+    lineHeight: number;
+    lineHeights?: ThemeFontSizes;
+    textTransform: string;
+    url?: string;
+    weight: string;
+}
+export interface ThemeFonts extends Record<string, ThemeFont | ThemeFontSizes | undefined> {
+    body: ThemeFont;
+    headings: ThemeFont;
+    headline: ThemeFont;
+    lineHeights?: ThemeFontSizes;
+    preface: ThemeFont;
+    sizes: ThemeFontSizes;
+    sizesMobile: ThemeFontSizes;
+}
+export interface ThemeHeader extends Record<string, string> {
+    primary: string;
+    primaryBorder: string;
+    stuck: string;
+    stuckBorder: string;
+}
+export interface ThemeIcons extends Record<string, number> {
+    strokeWidth: number;
+}
+export interface ThemeInputsLabel extends Record<string, string> {
+    fontSize: string;
+    fontSizeMobile: string;
+    left: string;
+    lineHeight: string;
+    offset: string;
+    padding: string;
+    top: string;
+}
+export interface ThemeInputs extends Record<string, string | boolean | ThemeInputsLabel> {
+    bgColor: string;
+    bgColorFocus: string;
+    borderColor: string;
+    borderColorFocus: string;
+    borderStyle: string;
+    borderWidth: string;
+    borderWidthApp: string;
+    bottomBorderOnly: boolean;
+    boxShadow: string;
+    color: string;
+    colorFocus: string;
+    family: string;
+    fontMobile: string;
+    fontSize: string;
+    fontSizeMobile: string;
+    fontSmoothing: string;
+    iconLeft: string;
+    iconPadding: string;
+    label: ThemeInputsLabel;
+    letterSpacing: string;
+    lineHeight: string;
+    padding: string;
+    paddingBottom: string;
+    paddingBottomActive: string;
+    paddingHorizontal: string;
+    paddingTop: string;
+    paddingTopActive: string;
+    paddingVertical: string;
+    placeholderColor: string;
+    radius: string;
+    selectPaddingBottom: string;
+    selectSize: string;
+    selectSizeMobile: string;
+    showIcon: boolean;
+    showLabel: boolean;
+    showOutline: boolean;
+    textTransform: string;
+    weight: string;
+}
+export interface ThemeItemStyles extends Record<string, string | number> {
+    imageAsImg: number;
+    imageAspectRatio: number;
+    imageBgSize: string;
+    imageHeight: string;
+    imageMargin: string;
+    imageMaxHeight: string;
+    imageMinHeight: string;
+    imagePadding: string;
+    imagePaddingAll: string;
+    maxWidth: string;
+    padding: string;
+}
+export interface ThemeItem extends Record<string, ThemeItemStyles> {
+    desktop: ThemeItemStyles;
+    mobile: ThemeItemStyles;
+}
+export interface ThemeItemsStyles extends Record<string, string> {
+    containerMaxWidth: string;
+    gap: string;
+    gapDouble: string;
+    gapHalf: string;
+    justifyContent: string;
+    marginBottom: string;
+    minWidth: string;
+    perRow: string;
+    width: string;
+}
+export interface ThemeItems extends Record<string, ThemeItemsStyles> {
+    desktop: ThemeItemsStyles;
+    mobile: ThemeItemsStyles;
+}
+export interface ThemeLayout extends Record<string, string> {
+    containerMaxWidth: string;
+    headerHeightApp: string;
+    headerHeightSite: string;
+    headerHeightSiteMobile: string;
+    margin: string;
+    marginMobile: string;
+    maxWidth: string;
+    navHeight: string;
+    navHeightApp: string;
+    navHeightMobile: string;
+    padding: string;
+    paddingMobile: string;
+}
+export interface ThemeLink extends Record<string, string> {
+    color: string;
+    hover: string;
+}
+export interface ThemeLinks extends Record<string, string | ThemeLink> {
+    customize: ThemeLink;
+    dark: ThemeLink;
+    light: ThemeLink;
+    primary: ThemeLink;
+    textDecoration: string;
+    transition: string;
+}
+export interface ThemeLogo extends Record<string, string> {
+    marginTop: string;
+    marginTopMobile: string;
+    width: string;
+    widthMobile: string;
+}
+export interface ThemeModifiersBox extends Record<string, string | number> {
+    border: string;
+    borderRadius: string;
+    boxShadow: string;
+    gap: string;
+    gapHalf: string;
+    layout: string;
+    margin: string;
+    minHeight: string;
+    minWidth: string;
+    padding: string;
+    perRow: number;
+    width: string;
+}
+export interface ThemeModifiersText extends Record<string, string> {
+    color: string;
+    fontSize: string;
+    hoverColor: string;
+    selectedColor: string;
+}
+export interface ThemeModifiersColors extends Record<string, string> {
+    bgColor: string;
+    borderColor: string;
+}
+export interface ThemeModifiersBox extends Record<string, string | number> {
+    border: string;
+    borderRadius: string;
+    boxShadow: string;
+    gap: string;
+    gapHalf: string;
+    layout: string;
+    margin: string;
+    minHeight: string;
+    minWidth: string;
+    padding: string;
+    perRow: number;
+    width: string;
+}
+export interface ThemeModifiersImage extends Record<string, string | boolean> {
+    asImg: boolean;
+    bgColor: string;
+    bgSize: string;
+    border: string;
+    borderColor: string;
+    borderRadius: string;
+    boxShadow: string;
+    height: string;
+    margin: string;
+    padding: string;
+    width: string;
+}
+export interface ThemeModifiersContent extends Record<string, string> {
+    padding: string;
+}
+export interface ThemeModifiers extends Record<string, ThemeModifiersText | ThemeModifiersColors | ThemeModifiersBox | ThemeModifiersImage | ThemeModifiersContent> {
+    box: ThemeModifiersBox;
+    calories: ThemeModifiersText;
+    colors: ThemeModifiersColors;
+    content: ThemeModifiersContent;
+    hoverColors: ThemeModifiersColors;
+    image: ThemeModifiersImage;
+    price: ThemeModifiersText;
+    selectedColors: ThemeModifiersColors;
+    text: ThemeModifiersText;
+    title: ThemeModifiersText;
+}
+export interface ThemeOverlay extends Record<string, string> {
+    alert: string;
+    dark: string;
+    light: string;
+    primary: string;
+    secondary: string;
+    tertiary: string;
+}
+export interface ThemeWelcomeStyles extends Record<string, string | boolean | number> {
+    buttonPaddingLeft: string;
+    buttonPaddingRight: string;
+    marginBottom: string;
+    marginTop: string;
+    showIcons: boolean;
+    subtitleLineHeight: number;
+    subtitleMarginTop: string;
+    subtitleSize: string;
+    textAlign: ThemeTextAlignment;
+    titleLineHeight: number;
+    titleMarginLeft: string;
+    titleSize: string;
+}
+export interface ThemeWelcome extends Record<string, ThemeWelcomeStyles> {
+    desktop: ThemeWelcomeStyles;
+    mobile: ThemeWelcomeStyles;
+}
+export interface Theme {
+    alert: ThemeAlert;
+    bgColors: ThemeBackgroundColors;
+    boldWeight: string;
+    border: ThemeBorder;
+    boxShadow: ThemeBoxShadow;
+    breakpoints: ThemeBreakpoints;
+    buttons: ThemeButtons;
+    cards: ThemeCards;
+    categories: ThemeCategories;
+    colors: ThemeColors;
+    counts: ThemeCounts;
+    error: ThemeAlert;
+    favorite: ThemeFavorite;
+    fonts: ThemeFonts;
+    header: ThemeHeader;
+    icons: ThemeIcons;
+    inputs: ThemeInputs;
+    item: ThemeItem;
+    items: ThemeItems;
+    layout: ThemeLayout;
+    lineHeight: string;
+    links: ThemeLinks;
+    logo: ThemeLogo;
+    logoFooter: ThemeLogo;
+    modifiers: ThemeModifiers;
+    overlay: ThemeOverlay;
+    success: ThemeAlert;
+    toast: ThemeAlert;
+    welcome: ThemeWelcome;
+}

package/dist/esm/types/api/theme.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/global.d.ts

@@ -50,3 +50,5 @@ export interface Image {
     url: string;
 }
 export declare type Images = Image[];
+export declare type OrderNotifications = 'ALL' | 'EMAIL' | 'NEW' | 'NONE' | 'SMS';
+export declare type Gender = 'MALE' | 'FEMALE' | 'DECLINED' | null;

package/dist/esm/types/index.d.ts

@@ -1,6 +1,6 @@
 export * from './api';
 export * from './datetimes';
 export * from './global';
+export * from './inputs';
 export * from './request';
-export * from './theme';
 export * from './errors';

package/dist/esm/types/index.js

@@ -1,6 +1,6 @@
 export * from './api';
 export * from './datetimes';
 export * from './global';
+export * from './inputs';
 export * from './request';
-export * from './theme';
 export * from './errors';

package/dist/esm/types/inputs.d.ts

@@ -0,0 +1,80 @@
+/// <reference types="react" />
+export interface Checkbox {
+    description?: string;
+    disabled?: boolean;
+    id?: string;
+    label?: string;
+    name: string;
+    on?: boolean;
+    onChange?: React.ChangeEventHandler<HTMLInputElement>;
+    required?: boolean;
+    showLabel?: boolean;
+    type: string;
+}
+export interface Input {
+    autoComplete?: string;
+    children?: JSX.Element;
+    disabled?: boolean;
+    error?: string;
+    icon?: JSX.Element;
+    label?: string;
+    max?: number;
+    min?: number;
+    name: string;
+    onChange?: React.ChangeEventHandler<HTMLInputElement> | undefined;
+    onBlur?: (evt: any) => void;
+    pattern?: string;
+    placeholder?: string;
+    readOnly?: boolean;
+    required?: boolean;
+    showLabel?: boolean;
+    style?: React.CSSProperties;
+    type: string;
+    value?: string | number;
+}
+export interface Select {
+    disabled?: boolean;
+    error: string;
+    label: string;
+    name: string;
+    onChange?: React.ChangeEventHandler<HTMLSelectElement>;
+    options: {
+        name: string;
+        value: string;
+        disabled?: boolean;
+    }[];
+    required?: boolean;
+    showLabel?: boolean;
+    type: string;
+    value?: string | number;
+}
+export interface Switch {
+    disabled?: boolean;
+    id?: string;
+    label: string;
+    name: string;
+    on?: boolean;
+    onChange?: React.ChangeEventHandler<HTMLInputElement>;
+    type: string;
+}
+export interface Textarea {
+    disabled?: boolean;
+    error?: string;
+    icon?: JSX.Element;
+    label: string;
+    name: string;
+    onChange?: React.ChangeEventHandler<HTMLTextAreaElement>;
+    placeholder?: string;
+    readOnly?: boolean;
+    required?: boolean;
+    showLabel?: boolean;
+    style?: React.CSSProperties;
+    type: string;
+    value?: string;
+}
+export declare type FormFieldType = Checkbox | Input | Select | Switch | Textarea;
+export declare const isCheckbox: (field: FormFieldType) => field is Checkbox;
+export declare const isSelect: (field: FormFieldType) => field is Select;
+export declare const isSwitch: (field: FormFieldType) => field is Switch;
+export declare const isTextarea: (field: FormFieldType) => field is Textarea;
+export declare const isInput: (field: FormFieldType) => field is Input;

package/dist/esm/types/inputs.js

@@ -0,0 +1,15 @@
+export const isCheckbox = (field) => {
+    return field.type === 'checkbox';
+};
+export const isSelect = (field) => {
+    return field.type === 'select';
+};
+export const isSwitch = (field) => {
+    return field.type === 'switch';
+};
+export const isTextarea = (field) => {
+    return field.type === 'textarea';
+};
+export const isInput = (field) => {
+    return !['checkbox', 'select', 'switch', 'textarea'].includes(field.type);
+};

package/dist/esm/types/themePos.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",