@open-tender/types 0.4.14 → 0.4.16

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.
package/dist/.DS_Store ADDED
Binary file
@@ -15,6 +15,7 @@ export * from './employee';
15
15
  export * from './errorAlerts';
16
16
  export * from './favorite';
17
17
  export * from './giftCard';
18
+ export * from './itemTypes';
18
19
  export * from './kds';
19
20
  export * from './menu';
20
21
  export * from './menuPages';
@@ -25,6 +26,7 @@ export * from './order';
25
26
  export * from './orders';
26
27
  export * from './refund';
27
28
  export * from './revenueCenter';
29
+ export * from './selectOptions';
28
30
  export * from './settings';
29
31
  export * from './store';
30
32
  export * from './surcharges';
@@ -18,6 +18,7 @@ tslib_1.__exportStar(require("./employee"), exports);
18
18
  tslib_1.__exportStar(require("./errorAlerts"), exports);
19
19
  tslib_1.__exportStar(require("./favorite"), exports);
20
20
  tslib_1.__exportStar(require("./giftCard"), exports);
21
+ tslib_1.__exportStar(require("./itemTypes"), exports);
21
22
  tslib_1.__exportStar(require("./kds"), exports);
22
23
  tslib_1.__exportStar(require("./menu"), exports);
23
24
  tslib_1.__exportStar(require("./menuPages"), exports);
@@ -28,6 +29,7 @@ tslib_1.__exportStar(require("./order"), exports);
28
29
  tslib_1.__exportStar(require("./orders"), exports);
29
30
  tslib_1.__exportStar(require("./refund"), exports);
30
31
  tslib_1.__exportStar(require("./revenueCenter"), exports);
32
+ tslib_1.__exportStar(require("./selectOptions"), exports);
31
33
  tslib_1.__exportStar(require("./settings"), exports);
32
34
  tslib_1.__exportStar(require("./store"), exports);
33
35
  tslib_1.__exportStar(require("./surcharges"), exports);
@@ -0,0 +1,15 @@
1
+ import { PrepStatus } from './kds';
2
+ export interface ItemType {
3
+ default_prep_status: PrepStatus;
4
+ display_order: number;
5
+ is_default: boolean;
6
+ is_grouped: boolean;
7
+ is_hidden_assembly: boolean;
8
+ is_hidden_qa: boolean;
9
+ item_type_id: number;
10
+ items: number[];
11
+ name: string;
12
+ prep_time: number;
13
+ print_on_completed: boolean;
14
+ }
15
+ export declare type ItemTypes = ItemType[];
@@ -1,15 +1,15 @@
1
- import { Orders } from './order';
2
- export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
3
- export declare type PrepStatusMap = {
4
- [Property in PrepStatus]: PrepStatus;
5
- };
6
- export declare type TicketStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED';
1
+ import { OrderCart, OrderItem, Orders } from './order';
7
2
  export declare type KdsView = 'column' | 'grid' | 'list' | 'tiles';
8
3
  export declare type KdsFontSize = 'xsmall' | 'small' | 'medium' | 'large';
9
4
  export declare type KdsColorScheme = 'dark' | 'light';
10
5
  export declare type KdsPrepType = 'ASSEMBLY' | 'EXPO';
11
6
  export declare type KdsOrderType = 'CURRENT' | 'FUTURE' | 'COMPLETED' | 'INCOMPLETE';
12
7
  export declare type KdsAssemblyOptions = 'AUTO_PRINT' | 'PRINT_DONE' | 'MARK_DONE' | 'PRINT_AND_DONE' | null;
8
+ export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
9
+ export declare type PrepStatusMap = {
10
+ [Property in PrepStatus]: PrepStatus;
11
+ };
12
+ export declare type TicketStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED';
13
13
  export interface PrepStation {
14
14
  prep_station_id: number;
15
15
  name: string;
@@ -50,3 +50,66 @@ export interface OrdersAndStationCounts {
50
50
  orders: Orders;
51
51
  stationCounts: KdsStationCounts | null;
52
52
  }
53
+ export interface OrderCounts {
54
+ current: Record<string, number> | null;
55
+ future: Record<string, number> | null;
56
+ qa: Record<string, number> | null;
57
+ }
58
+ export interface OrdersAndCounts {
59
+ orders: Orders;
60
+ counts: OrderCounts;
61
+ }
62
+ export interface OrderUpdate {
63
+ expected_at?: string;
64
+ prep_status?: PrepStatus;
65
+ }
66
+ export interface OrderBucket {
67
+ orders: Orders;
68
+ start: Date;
69
+ end: Date;
70
+ }
71
+ export declare type OrderBuckets = Array<OrderBucket>;
72
+ export interface OrderPrepTimes {
73
+ delayed: number;
74
+ requested: Date;
75
+ requestedTime: string;
76
+ expected: Date;
77
+ expectedDate: string;
78
+ expectedTime: string;
79
+ readyBy: Date;
80
+ readyTime: string;
81
+ dateStr: string;
82
+ status: string;
83
+ }
84
+ export interface TicketUpdate {
85
+ ticket_status: TicketStatus;
86
+ }
87
+ export interface TicketsUpdate {
88
+ ticket_status?: TicketStatus;
89
+ ticket_nos?: number[];
90
+ }
91
+ export declare type TicketStatusUpdate = 'done' | 'completed' | 'reset';
92
+ export interface Ticket {
93
+ item_nos: number[];
94
+ item_type_id: number;
95
+ item_type_name: string;
96
+ ticket_no: number;
97
+ ticket_status: TicketStatus;
98
+ items: OrderCart;
99
+ is_default: boolean;
100
+ is_grouped: boolean;
101
+ is_hidden_assembly: boolean;
102
+ is_hidden_qa: boolean;
103
+ print_on_completed: boolean;
104
+ }
105
+ export declare type TicketGroup = Ticket[];
106
+ export declare type TicketGroups = TicketGroup[];
107
+ export interface OrderKdsStatus {
108
+ NOT_DONE: boolean;
109
+ DONE: boolean;
110
+ COMPLETED: boolean;
111
+ }
112
+ export interface OrderItemCount {
113
+ item: OrderItem;
114
+ count: number;
115
+ }
@@ -0,0 +1,7 @@
1
+ export interface SelectOption {
2
+ name: string;
3
+ option_type: 'PAID_IN' | 'PAID_OUT';
4
+ position: number;
5
+ select_option_id: number;
6
+ }
7
+ export declare type SelectOptions = SelectOption[];
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -15,6 +15,7 @@ export * from './employee';
15
15
  export * from './errorAlerts';
16
16
  export * from './favorite';
17
17
  export * from './giftCard';
18
+ export * from './itemTypes';
18
19
  export * from './kds';
19
20
  export * from './menu';
20
21
  export * from './menuPages';
@@ -25,6 +26,7 @@ export * from './order';
25
26
  export * from './orders';
26
27
  export * from './refund';
27
28
  export * from './revenueCenter';
29
+ export * from './selectOptions';
28
30
  export * from './settings';
29
31
  export * from './store';
30
32
  export * from './surcharges';
@@ -15,6 +15,7 @@ export * from './employee';
15
15
  export * from './errorAlerts';
16
16
  export * from './favorite';
17
17
  export * from './giftCard';
18
+ export * from './itemTypes';
18
19
  export * from './kds';
19
20
  export * from './menu';
20
21
  export * from './menuPages';
@@ -25,6 +26,7 @@ export * from './order';
25
26
  export * from './orders';
26
27
  export * from './refund';
27
28
  export * from './revenueCenter';
29
+ export * from './selectOptions';
28
30
  export * from './settings';
29
31
  export * from './store';
30
32
  export * from './surcharges';
@@ -0,0 +1,15 @@
1
+ import { PrepStatus } from './kds';
2
+ export interface ItemType {
3
+ default_prep_status: PrepStatus;
4
+ display_order: number;
5
+ is_default: boolean;
6
+ is_grouped: boolean;
7
+ is_hidden_assembly: boolean;
8
+ is_hidden_qa: boolean;
9
+ item_type_id: number;
10
+ items: number[];
11
+ name: string;
12
+ prep_time: number;
13
+ print_on_completed: boolean;
14
+ }
15
+ export declare type ItemTypes = ItemType[];
@@ -1,15 +1,15 @@
1
- import { Orders } from './order';
2
- export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
3
- export declare type PrepStatusMap = {
4
- [Property in PrepStatus]: PrepStatus;
5
- };
6
- export declare type TicketStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED';
1
+ import { OrderCart, OrderItem, Orders } from './order';
7
2
  export declare type KdsView = 'column' | 'grid' | 'list' | 'tiles';
8
3
  export declare type KdsFontSize = 'xsmall' | 'small' | 'medium' | 'large';
9
4
  export declare type KdsColorScheme = 'dark' | 'light';
10
5
  export declare type KdsPrepType = 'ASSEMBLY' | 'EXPO';
11
6
  export declare type KdsOrderType = 'CURRENT' | 'FUTURE' | 'COMPLETED' | 'INCOMPLETE';
12
7
  export declare type KdsAssemblyOptions = 'AUTO_PRINT' | 'PRINT_DONE' | 'MARK_DONE' | 'PRINT_AND_DONE' | null;
8
+ export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED';
9
+ export declare type PrepStatusMap = {
10
+ [Property in PrepStatus]: PrepStatus;
11
+ };
12
+ export declare type TicketStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED';
13
13
  export interface PrepStation {
14
14
  prep_station_id: number;
15
15
  name: string;
@@ -50,3 +50,66 @@ export interface OrdersAndStationCounts {
50
50
  orders: Orders;
51
51
  stationCounts: KdsStationCounts | null;
52
52
  }
53
+ export interface OrderCounts {
54
+ current: Record<string, number> | null;
55
+ future: Record<string, number> | null;
56
+ qa: Record<string, number> | null;
57
+ }
58
+ export interface OrdersAndCounts {
59
+ orders: Orders;
60
+ counts: OrderCounts;
61
+ }
62
+ export interface OrderUpdate {
63
+ expected_at?: string;
64
+ prep_status?: PrepStatus;
65
+ }
66
+ export interface OrderBucket {
67
+ orders: Orders;
68
+ start: Date;
69
+ end: Date;
70
+ }
71
+ export declare type OrderBuckets = Array<OrderBucket>;
72
+ export interface OrderPrepTimes {
73
+ delayed: number;
74
+ requested: Date;
75
+ requestedTime: string;
76
+ expected: Date;
77
+ expectedDate: string;
78
+ expectedTime: string;
79
+ readyBy: Date;
80
+ readyTime: string;
81
+ dateStr: string;
82
+ status: string;
83
+ }
84
+ export interface TicketUpdate {
85
+ ticket_status: TicketStatus;
86
+ }
87
+ export interface TicketsUpdate {
88
+ ticket_status?: TicketStatus;
89
+ ticket_nos?: number[];
90
+ }
91
+ export declare type TicketStatusUpdate = 'done' | 'completed' | 'reset';
92
+ export interface Ticket {
93
+ item_nos: number[];
94
+ item_type_id: number;
95
+ item_type_name: string;
96
+ ticket_no: number;
97
+ ticket_status: TicketStatus;
98
+ items: OrderCart;
99
+ is_default: boolean;
100
+ is_grouped: boolean;
101
+ is_hidden_assembly: boolean;
102
+ is_hidden_qa: boolean;
103
+ print_on_completed: boolean;
104
+ }
105
+ export declare type TicketGroup = Ticket[];
106
+ export declare type TicketGroups = TicketGroup[];
107
+ export interface OrderKdsStatus {
108
+ NOT_DONE: boolean;
109
+ DONE: boolean;
110
+ COMPLETED: boolean;
111
+ }
112
+ export interface OrderItemCount {
113
+ item: OrderItem;
114
+ count: number;
115
+ }
@@ -0,0 +1,7 @@
1
+ export interface SelectOption {
2
+ name: string;
3
+ option_type: 'PAID_IN' | 'PAID_OUT';
4
+ position: number;
5
+ select_option_id: number;
6
+ }
7
+ export declare type SelectOptions = SelectOption[];
@@ -0,0 +1 @@
1
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-tender/types",
3
- "version": "0.4.14",
3
+ "version": "0.4.16",
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",
@@ -1,47 +0,0 @@
1
- import { IpAddress } from '../global';
2
- import { PrepStations, PrepStatus } from './kds';
3
- export interface Config {
4
- backup_printer_ip_address: IpAddress | null;
5
- backup_printer_use_beeper: boolean;
6
- brand_id: number;
7
- cardreader_id: string;
8
- has_cardreader: boolean;
9
- has_cardwriter: boolean;
10
- has_cashdrawer: boolean;
11
- has_pinpad: boolean;
12
- has_qrcode: boolean;
13
- has_timeclock: boolean;
14
- ip_address: IpAddress;
15
- name: string;
16
- pos_server_id: number;
17
- pos_terminal_id: number;
18
- prep_stations?: PrepStations | null;
19
- print_kds: boolean;
20
- print_receipt: 'never' | 'always' | 'prompt';
21
- printer: IpAddress;
22
- printer_use_beeper: boolean;
23
- scanner_id: string;
24
- server: IpAddress;
25
- terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
26
- }
27
- export interface ItemType {
28
- default_prep_status: PrepStatus;
29
- is_default: boolean;
30
- is_grouped: boolean;
31
- is_hidden_assembly: boolean;
32
- is_hidden_qa: boolean;
33
- item_type_id: number;
34
- items: number[];
35
- name: string;
36
- position: number;
37
- prep_time: number;
38
- print_on_completed: boolean;
39
- }
40
- export declare type ItemTypes = Array<ItemType>;
41
- export interface SelectOption {
42
- name: string;
43
- option_type: 'PAID_IN' | 'PAID_OUT';
44
- position: number;
45
- select_option_id: number;
46
- }
47
- export declare type SelectOptions = Array<SelectOption>;
@@ -1,47 +0,0 @@
1
- import { IpAddress } from '../global';
2
- import { PrepStations, PrepStatus } from './kds';
3
- export interface Config {
4
- backup_printer_ip_address: IpAddress | null;
5
- backup_printer_use_beeper: boolean;
6
- brand_id: number;
7
- cardreader_id: string;
8
- has_cardreader: boolean;
9
- has_cardwriter: boolean;
10
- has_cashdrawer: boolean;
11
- has_pinpad: boolean;
12
- has_qrcode: boolean;
13
- has_timeclock: boolean;
14
- ip_address: IpAddress;
15
- name: string;
16
- pos_server_id: number;
17
- pos_terminal_id: number;
18
- prep_stations?: PrepStations | null;
19
- print_kds: boolean;
20
- print_receipt: 'never' | 'always' | 'prompt';
21
- printer: IpAddress;
22
- printer_use_beeper: boolean;
23
- scanner_id: string;
24
- server: IpAddress;
25
- terminal_type: 'POS_TERMINAL' | 'KDS_TERMINAL' | 'KIOSK';
26
- }
27
- export interface ItemType {
28
- default_prep_status: PrepStatus;
29
- is_default: boolean;
30
- is_grouped: boolean;
31
- is_hidden_assembly: boolean;
32
- is_hidden_qa: boolean;
33
- item_type_id: number;
34
- items: number[];
35
- name: string;
36
- position: number;
37
- prep_time: number;
38
- print_on_completed: boolean;
39
- }
40
- export declare type ItemTypes = Array<ItemType>;
41
- export interface SelectOption {
42
- name: string;
43
- option_type: 'PAID_IN' | 'PAID_OUT';
44
- position: number;
45
- select_option_id: number;
46
- }
47
- export declare type SelectOptions = Array<SelectOption>;