@open-tender/types 0.2.68 → 0.2.70

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/cjs/types/api/theme.d.ts +42 -18
  2. package/dist/esm/types/api/theme.d.ts +42 -18
  3. package/package.json +1 -1
package/dist/cjs/types/api/theme.d.ts CHANGED
@@ -1,3 +1,9 @@
1
+ export declare type ThemeFlexDirection = 'row' | 'row-reverse' | 'column' | 'column-reverse';
2
+ export declare type ThemeJustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
3
+ export declare type ThemeFontSmoothing = 'none' | 'auto' | 'antialiased' | 'subpixel-antialiased';
4
+ export declare type ThemeTextTransform = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
5
+ export declare type ThemeTextAlignment = 'left' | 'right' | 'center' | 'justify';
6
+ export declare type ThemeBackgroundSize = 'cover' | 'contain' | '100% auto' | 'auto 100%';
1
7
  export declare type ThemeAlertType = 'alert' | 'error' | 'success' | 'toast';
2
8
  export interface ThemeAlert extends Record<string, string> {
3
9
  bgColor: string;
@@ -70,7 +76,7 @@ export interface ThemeButtonSize extends Record<string, string | boolean> {
70
76
  family: string;
71
77
  fontMobile: string;
72
78
  fontSize: string;
73
- fontSmoothing: string;
79
+ fontSmoothing: ThemeFontSmoothing;
74
80
  fontStyle: string;
75
81
  letterSpacing: string;
76
82
  padding: string;
@@ -135,7 +141,7 @@ export interface ThemeCardItem extends ThemeCard {
135
141
  caloriesSizeMobile: string;
136
142
  imageAsImg: boolean;
137
143
  imageAspectRatio: number;
138
- imageBgSize: string;
144
+ imageBgSize: ThemeBackgroundSize;
139
145
  priceColor: string;
140
146
  priceSize: string;
141
147
  priceSizeMobile: string;
@@ -146,10 +152,6 @@ export interface ThemeCards extends Record<string, ThemeCard | ThemeCardItem> {
146
152
  menuItem: ThemeCardItem;
147
153
  modifier: ThemeCardItem;
148
154
  }
149
- export declare type ThemeTextAlignment = 'left' | 'right' | 'center' | 'justify';
150
- export declare type ThemeJustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
151
- export declare type ThemeFlexDirection = 'row' | 'row-reverse' | 'column' | 'column-reverse';
152
- export declare type ThemeTextTransform = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
153
155
  export declare type ThemeCategoryDisplayType = 'LIST' | 'CARDS' | 'SQUARES';
154
156
  export declare type ThemeCategoryLineType = 'none' | 'underline' | 'overline';
155
157
  export interface ThemeCategory extends Record<string, string | number | boolean> {
@@ -162,7 +164,7 @@ export interface ThemeCategory extends Record<string, string | number | boolean>
162
164
  gap: string;
163
165
  gapDouble: string;
164
166
  gapHalf: string;
165
- imageBgSize: string;
167
+ imageBgSize: ThemeBackgroundSize;
166
168
  imageBorderRadius: string;
167
169
  imagePadding: string;
168
170
  imageRatio: number;
@@ -209,7 +211,7 @@ export interface ThemeCount extends Record<string, string | boolean> {
209
211
  fontMobile: string;
210
212
  fontSize: string;
211
213
  fontSizeMobile: string;
212
- fontSmoothing: string;
214
+ fontSmoothing: ThemeFontSmoothing;
213
215
  fontStyle: string;
214
216
  hide: boolean;
215
217
  paddingBottom: string;
@@ -233,7 +235,7 @@ export interface ThemeFont extends Record<string, string | ThemeFontSizes | unde
233
235
  family: string;
234
236
  fontSize?: string;
235
237
  fontMobile: string;
236
- fontSmoothing: string;
238
+ fontSmoothing: ThemeFontSmoothing;
237
239
  fontStyle: string;
238
240
  letterSpacing: string;
239
241
  lineHeight: number;
@@ -285,7 +287,7 @@ export interface ThemeInputs extends Record<string, string | boolean | ThemeInpu
285
287
  fontMobile: string;
286
288
  fontSize: string;
287
289
  fontSizeMobile: string;
288
- fontSmoothing: string;
290
+ fontSmoothing: ThemeFontSmoothing;
289
291
  iconLeft: string;
290
292
  iconPadding: string;
291
293
  label: ThemeInputsLabel;
@@ -312,7 +314,7 @@ export interface ThemeInputs extends Record<string, string | boolean | ThemeInpu
312
314
  export interface ThemeItemStyles extends Record<string, string | number> {
313
315
  imageAsImg: number;
314
316
  imageAspectRatio: number;
315
- imageBgSize: string;
317
+ imageBgSize: ThemeBackgroundSize;
316
318
  imageHeight: string;
317
319
  imageMargin: string;
318
320
  imageMaxHeight: string;
@@ -408,11 +410,12 @@ export interface ThemeMenuItemsBox extends Record<string, string | number> {
408
410
  width: string;
409
411
  widthMobile: string;
410
412
  }
413
+ export declare type ThemeImagePosition = 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'HIDDEN';
411
414
  export interface ThemeMenuItemsImage extends Record<string, string | number | boolean> {
412
415
  asImg: boolean;
413
416
  aspectRatio: number;
414
417
  bgColor: string;
415
- bgSize: string;
418
+ bgSize: ThemeBackgroundSize;
416
419
  border: string;
417
420
  borderColor: string;
418
421
  borderMobile: string;
@@ -425,24 +428,46 @@ export interface ThemeMenuItemsImage extends Record<string, string | number | bo
425
428
  minWidthMobile: string;
426
429
  padding: string;
427
430
  paddingMobile: string;
428
- position: string;
431
+ position: ThemeImagePosition;
429
432
  }
433
+ export declare type ThemeMenuItemsContentDescription = 'SHOW' | 'HIDE' | 'SHORT';
434
+ export declare type ThemeMenuItemsContentLayout = 'PRICE_RIGHT' | 'PRICE_BELOW' | 'PRICE_LAST';
430
435
  export interface ThemeMenuItemsContent extends Record<string, string> {
436
+ description: ThemeMenuItemsContentDescription;
437
+ descriptionMobile: ThemeMenuItemsContentDescription;
438
+ layout: ThemeMenuItemsContentLayout;
439
+ layoutMobile: ThemeMenuItemsContentLayout;
431
440
  padding: string;
432
441
  paddingMobile: string;
433
442
  }
443
+ export declare type ThemeMenuItemsButtonsDisplay = 'SHOW' | 'HIDE' | 'MINIMAL';
444
+ export interface ThemeMenuItemsButtons extends Record<string, string | number[]> {
445
+ display: ThemeMenuItemsButtonsDisplay;
446
+ displayMobile: ThemeMenuItemsButtonsDisplay;
447
+ flexDirection: ThemeFlexDirection;
448
+ justifyContent: ThemeJustifyContent;
449
+ padding: number[];
450
+ paddingMobile: number[];
451
+ }
434
452
  export interface ThemeMenuItemsText extends Record<string, string | undefined> {
435
453
  color: string;
436
454
  colorHover: string;
437
455
  fontSize: string;
438
456
  fontSizeMobile: string;
439
457
  lineHeight?: string;
458
+ padding: string;
459
+ paddingMobile: string;
440
460
  }
441
- export interface ThemeMenuItemsTags extends ThemeMenuItemsText {
461
+ export interface ThemeMenuItemsTags extends Record<string, string | undefined> {
442
462
  displayType: 'IMAGE' | 'TEXT' | 'BOTH' | 'HIDDEN';
463
+ color: string;
464
+ colorHover: string;
465
+ fontSize: string;
466
+ fontSizeMobile: string;
443
467
  gap: string;
444
468
  gapMobile: string;
445
469
  letterSpacing: string;
470
+ lineHeight?: string;
446
471
  prefix: string;
447
472
  textTransform: ThemeTextTransform;
448
473
  width: string;
@@ -506,12 +531,11 @@ export interface ThemeTagsBox extends Record<string, string | number> {
506
531
  width: string;
507
532
  widthMobile: string;
508
533
  }
509
- export declare type ThemeTagsImagePosition = 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'HIDDEN';
510
534
  export interface ThemeTagsImage extends Record<string, string | number | boolean> {
511
535
  asImg: boolean;
512
536
  aspectRatio: number;
513
537
  bgColor: string;
514
- bgSize: string;
538
+ bgSize: ThemeBackgroundSize;
515
539
  border: string;
516
540
  borderColor: string;
517
541
  borderMobile: string;
@@ -524,7 +548,7 @@ export interface ThemeTagsImage extends Record<string, string | number | boolean
524
548
  minWidthMobile: string;
525
549
  padding: string;
526
550
  paddingMobile: string;
527
- position: ThemeTagsImagePosition;
551
+ position: ThemeImagePosition;
528
552
  }
529
553
  export interface ThemeTagsText extends Record<string, string> {
530
554
  color: string;
@@ -565,7 +589,7 @@ export interface ThemeModifiersBox extends Record<string, string | number> {
565
589
  export interface ThemeModifiersImage extends Record<string, string | boolean> {
566
590
  asImg: boolean;
567
591
  bgColor: string;
568
- bgSize: string;
592
+ bgSize: ThemeBackgroundSize;
569
593
  border: string;
570
594
  borderColor: string;
571
595
  borderRadius: string;
package/dist/esm/types/api/theme.d.ts CHANGED
@@ -1,3 +1,9 @@
1
+ export declare type ThemeFlexDirection = 'row' | 'row-reverse' | 'column' | 'column-reverse';
2
+ export declare type ThemeJustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
3
+ export declare type ThemeFontSmoothing = 'none' | 'auto' | 'antialiased' | 'subpixel-antialiased';
4
+ export declare type ThemeTextTransform = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
5
+ export declare type ThemeTextAlignment = 'left' | 'right' | 'center' | 'justify';
6
+ export declare type ThemeBackgroundSize = 'cover' | 'contain' | '100% auto' | 'auto 100%';
1
7
  export declare type ThemeAlertType = 'alert' | 'error' | 'success' | 'toast';
2
8
  export interface ThemeAlert extends Record<string, string> {
3
9
  bgColor: string;
@@ -70,7 +76,7 @@ export interface ThemeButtonSize extends Record<string, string | boolean> {
70
76
  family: string;
71
77
  fontMobile: string;
72
78
  fontSize: string;
73
- fontSmoothing: string;
79
+ fontSmoothing: ThemeFontSmoothing;
74
80
  fontStyle: string;
75
81
  letterSpacing: string;
76
82
  padding: string;
@@ -135,7 +141,7 @@ export interface ThemeCardItem extends ThemeCard {
135
141
  caloriesSizeMobile: string;
136
142
  imageAsImg: boolean;
137
143
  imageAspectRatio: number;
138
- imageBgSize: string;
144
+ imageBgSize: ThemeBackgroundSize;
139
145
  priceColor: string;
140
146
  priceSize: string;
141
147
  priceSizeMobile: string;
@@ -146,10 +152,6 @@ export interface ThemeCards extends Record<string, ThemeCard | ThemeCardItem> {
146
152
  menuItem: ThemeCardItem;
147
153
  modifier: ThemeCardItem;
148
154
  }
149
- export declare type ThemeTextAlignment = 'left' | 'right' | 'center' | 'justify';
150
- export declare type ThemeJustifyContent = 'flex-start' | 'flex-end' | 'center' | 'space-between' | 'space-around';
151
- export declare type ThemeFlexDirection = 'row' | 'row-reverse' | 'column' | 'column-reverse';
152
- export declare type ThemeTextTransform = 'none' | 'uppercase' | 'lowercase' | 'capitalize';
153
155
  export declare type ThemeCategoryDisplayType = 'LIST' | 'CARDS' | 'SQUARES';
154
156
  export declare type ThemeCategoryLineType = 'none' | 'underline' | 'overline';
155
157
  export interface ThemeCategory extends Record<string, string | number | boolean> {
@@ -162,7 +164,7 @@ export interface ThemeCategory extends Record<string, string | number | boolean>
162
164
  gap: string;
163
165
  gapDouble: string;
164
166
  gapHalf: string;
165
- imageBgSize: string;
167
+ imageBgSize: ThemeBackgroundSize;
166
168
  imageBorderRadius: string;
167
169
  imagePadding: string;
168
170
  imageRatio: number;
@@ -209,7 +211,7 @@ export interface ThemeCount extends Record<string, string | boolean> {
209
211
  fontMobile: string;
210
212
  fontSize: string;
211
213
  fontSizeMobile: string;
212
- fontSmoothing: string;
214
+ fontSmoothing: ThemeFontSmoothing;
213
215
  fontStyle: string;
214
216
  hide: boolean;
215
217
  paddingBottom: string;
@@ -233,7 +235,7 @@ export interface ThemeFont extends Record<string, string | ThemeFontSizes | unde
233
235
  family: string;
234
236
  fontSize?: string;
235
237
  fontMobile: string;
236
- fontSmoothing: string;
238
+ fontSmoothing: ThemeFontSmoothing;
237
239
  fontStyle: string;
238
240
  letterSpacing: string;
239
241
  lineHeight: number;
@@ -285,7 +287,7 @@ export interface ThemeInputs extends Record<string, string | boolean | ThemeInpu
285
287
  fontMobile: string;
286
288
  fontSize: string;
287
289
  fontSizeMobile: string;
288
- fontSmoothing: string;
290
+ fontSmoothing: ThemeFontSmoothing;
289
291
  iconLeft: string;
290
292
  iconPadding: string;
291
293
  label: ThemeInputsLabel;
@@ -312,7 +314,7 @@ export interface ThemeInputs extends Record<string, string | boolean | ThemeInpu
312
314
  export interface ThemeItemStyles extends Record<string, string | number> {
313
315
  imageAsImg: number;
314
316
  imageAspectRatio: number;
315
- imageBgSize: string;
317
+ imageBgSize: ThemeBackgroundSize;
316
318
  imageHeight: string;
317
319
  imageMargin: string;
318
320
  imageMaxHeight: string;
@@ -408,11 +410,12 @@ export interface ThemeMenuItemsBox extends Record<string, string | number> {
408
410
  width: string;
409
411
  widthMobile: string;
410
412
  }
413
+ export declare type ThemeImagePosition = 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'HIDDEN';
411
414
  export interface ThemeMenuItemsImage extends Record<string, string | number | boolean> {
412
415
  asImg: boolean;
413
416
  aspectRatio: number;
414
417
  bgColor: string;
415
- bgSize: string;
418
+ bgSize: ThemeBackgroundSize;
416
419
  border: string;
417
420
  borderColor: string;
418
421
  borderMobile: string;
@@ -425,24 +428,46 @@ export interface ThemeMenuItemsImage extends Record<string, string | number | bo
425
428
  minWidthMobile: string;
426
429
  padding: string;
427
430
  paddingMobile: string;
428
- position: string;
431
+ position: ThemeImagePosition;
429
432
  }
433
+ export declare type ThemeMenuItemsContentDescription = 'SHOW' | 'HIDE' | 'SHORT';
434
+ export declare type ThemeMenuItemsContentLayout = 'PRICE_RIGHT' | 'PRICE_BELOW' | 'PRICE_LAST';
430
435
  export interface ThemeMenuItemsContent extends Record<string, string> {
436
+ description: ThemeMenuItemsContentDescription;
437
+ descriptionMobile: ThemeMenuItemsContentDescription;
438
+ layout: ThemeMenuItemsContentLayout;
439
+ layoutMobile: ThemeMenuItemsContentLayout;
431
440
  padding: string;
432
441
  paddingMobile: string;
433
442
  }
443
+ export declare type ThemeMenuItemsButtonsDisplay = 'SHOW' | 'HIDE' | 'MINIMAL';
444
+ export interface ThemeMenuItemsButtons extends Record<string, string | number[]> {
445
+ display: ThemeMenuItemsButtonsDisplay;
446
+ displayMobile: ThemeMenuItemsButtonsDisplay;
447
+ flexDirection: ThemeFlexDirection;
448
+ justifyContent: ThemeJustifyContent;
449
+ padding: number[];
450
+ paddingMobile: number[];
451
+ }
434
452
  export interface ThemeMenuItemsText extends Record<string, string | undefined> {
435
453
  color: string;
436
454
  colorHover: string;
437
455
  fontSize: string;
438
456
  fontSizeMobile: string;
439
457
  lineHeight?: string;
458
+ padding: string;
459
+ paddingMobile: string;
440
460
  }
441
- export interface ThemeMenuItemsTags extends ThemeMenuItemsText {
461
+ export interface ThemeMenuItemsTags extends Record<string, string | undefined> {
442
462
  displayType: 'IMAGE' | 'TEXT' | 'BOTH' | 'HIDDEN';
463
+ color: string;
464
+ colorHover: string;
465
+ fontSize: string;
466
+ fontSizeMobile: string;
443
467
  gap: string;
444
468
  gapMobile: string;
445
469
  letterSpacing: string;
470
+ lineHeight?: string;
446
471
  prefix: string;
447
472
  textTransform: ThemeTextTransform;
448
473
  width: string;
@@ -506,12 +531,11 @@ export interface ThemeTagsBox extends Record<string, string | number> {
506
531
  width: string;
507
532
  widthMobile: string;
508
533
  }
509
- export declare type ThemeTagsImagePosition = 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'HIDDEN';
510
534
  export interface ThemeTagsImage extends Record<string, string | number | boolean> {
511
535
  asImg: boolean;
512
536
  aspectRatio: number;
513
537
  bgColor: string;
514
- bgSize: string;
538
+ bgSize: ThemeBackgroundSize;
515
539
  border: string;
516
540
  borderColor: string;
517
541
  borderMobile: string;
@@ -524,7 +548,7 @@ export interface ThemeTagsImage extends Record<string, string | number | boolean
524
548
  minWidthMobile: string;
525
549
  padding: string;
526
550
  paddingMobile: string;
527
- position: ThemeTagsImagePosition;
551
+ position: ThemeImagePosition;
528
552
  }
529
553
  export interface ThemeTagsText extends Record<string, string> {
530
554
  color: string;
@@ -565,7 +589,7 @@ export interface ThemeModifiersBox extends Record<string, string | number> {
565
589
  export interface ThemeModifiersImage extends Record<string, string | boolean> {
566
590
  asImg: boolean;
567
591
  bgColor: string;
568
- bgSize: string;
592
+ bgSize: ThemeBackgroundSize;
569
593
  border: string;
570
594
  borderColor: string;
571
595
  borderRadius: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-tender/types",
3
- "version": "0.2.68",
3
+ "version": "0.2.70",
4
4
  "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",