/
payloads.ts
168 lines (139 loc) · 3.82 KB
/
payloads.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
import Configuration from '../configuration';
import Store from '../store';
namespace Payload {
export namespace History {
export interface State extends ProtoState {
method: Function;
request?: any;
}
export interface ProtoState {
url?: string;
route?: string;
shouldFetch?: boolean;
}
}
export namespace Fetch {
export interface Override {
request?: any;
buildAndParse?: boolean;
}
export interface MorePastPurchaseRefinements extends Navigation.Id, Override {}
export interface MoreRefinements extends Navigation.Id, Override {}
export interface MoreProducts extends More, Override {}
export interface AutocompleteSuggestions extends SimpleQuery, Override {}
export interface AutocompleteProducts extends Autocomplete.Products, Override {}
export interface CollectionCount extends Collection.Name, Override {}
export interface Details extends Id, Override {}
export interface PastPurchases extends Partial<SimpleQuery>, Override {}
export interface MorePastPurchases extends More, Override {}
}
export interface More {
amount: number;
forward: boolean;
}
export namespace Personalization {
export interface Biasing {
field: string;
value: string;
bias: Store.Personalization.SingleBias;
config?: Configuration.Personalization.RealTimeBiasing;
}
}
export interface Id {
id: string;
}
export namespace Component {
export interface Identifier extends Id {
tagName: string;
}
export interface State extends Identifier {
state: object;
}
}
export namespace Collection {
export interface Name {
collection: string;
}
export interface Count extends Name {
count: number;
}
}
export interface SimpleQuery {
query: string;
}
export interface Query {
corrected?: string;
related?: string[];
didYouMean?: string[];
rewrites?: string[];
original?: string;
}
// note: Isn't getting the right type in generated doc for some reason
export interface Search
extends Partial<SimpleQuery>,
Partial<Navigation.Refinement>,
Partial<Navigation.AddRefinement> {
/**
* only for refinements
* if true, replace refinements with the provided ones
* if false, add the provided refinements
*/
clear?: boolean | string;
}
export namespace Autocomplete {
export interface Products extends SimpleQuery {
refinements: Payload.Autocomplete.Refinement[];
}
export interface Suggestions {
suggestions: Store.Autocomplete.Suggestion[];
categoryValues: string[];
navigations: Store.Autocomplete.Navigation[];
}
export interface Refinement {
field: string;
value: string;
}
}
export namespace Navigation {
// tslint:disable-next-line no-shadowed-variable
export interface Id {
navigationId: string;
}
export interface Refinement extends Navigation.Id {
index: number;
}
export interface MultipleRefinements extends Navigation.Id {
indices: number[];
}
export interface AddRefinement extends Navigation.Id {
range?: boolean;
// used to add new value refinement
value?: string;
// used to add new range refinement
low?: number;
high?: number;
}
export interface MoreRefinements extends Navigation.Id {
refinements: Store.Refinement[];
selected: number[];
}
}
export interface Page {
previous: number;
next: number;
last: number;
from: number;
to: number;
current?: number;
}
export interface InfiniteScroll {
isFetchingForward?: boolean;
isFetchingBackward?: boolean;
}
export interface Sort {
labels?: string[];
options: Store.Sort[];
selected?: number;
}
}
export default Payload;