@faststore/api 1.2.23

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 (103) hide show
  1. package/CHANGELOG.md +333 -0
  2. package/README.md +115 -0
  3. package/dist/__generated__/schema.d.ts +281 -0
  4. package/dist/api.cjs.development.js +2226 -0
  5. package/dist/api.cjs.development.js.map +1 -0
  6. package/dist/api.cjs.production.min.js +2 -0
  7. package/dist/api.cjs.production.min.js.map +1 -0
  8. package/dist/api.esm.js +2217 -0
  9. package/dist/api.esm.js.map +1 -0
  10. package/dist/index.d.ts +136 -0
  11. package/dist/index.js +8 -0
  12. package/dist/platforms/vtex/clients/commerce/index.d.ts +29 -0
  13. package/dist/platforms/vtex/clients/commerce/types/Brand.d.ts +8 -0
  14. package/dist/platforms/vtex/clients/commerce/types/CategoryTree.d.ts +9 -0
  15. package/dist/platforms/vtex/clients/commerce/types/OrderForm.d.ts +347 -0
  16. package/dist/platforms/vtex/clients/commerce/types/Simulation.d.ts +154 -0
  17. package/dist/platforms/vtex/clients/fetch.d.ts +1 -0
  18. package/dist/platforms/vtex/clients/index.d.ts +32 -0
  19. package/dist/platforms/vtex/clients/search/index.d.ts +22 -0
  20. package/dist/platforms/vtex/clients/search/types/AttributeSearchResult.d.ts +56 -0
  21. package/dist/platforms/vtex/clients/search/types/ProductSearchResult.d.ts +199 -0
  22. package/dist/platforms/vtex/index.d.ts +144 -0
  23. package/dist/platforms/vtex/loaders/index.d.ts +7 -0
  24. package/dist/platforms/vtex/loaders/simulation.d.ts +5 -0
  25. package/dist/platforms/vtex/loaders/sku.d.ts +6 -0
  26. package/dist/platforms/vtex/resolvers/aggregateOffer.d.ts +7 -0
  27. package/dist/platforms/vtex/resolvers/aggregateRating.d.ts +2 -0
  28. package/dist/platforms/vtex/resolvers/collection.d.ts +8 -0
  29. package/dist/platforms/vtex/resolvers/facet.d.ts +5 -0
  30. package/dist/platforms/vtex/resolvers/facetValue.d.ts +5 -0
  31. package/dist/platforms/vtex/resolvers/mutation.d.ts +58 -0
  32. package/dist/platforms/vtex/resolvers/offer.d.ts +11 -0
  33. package/dist/platforms/vtex/resolvers/organization.d.ts +2 -0
  34. package/dist/platforms/vtex/resolvers/product.d.ts +5 -0
  35. package/dist/platforms/vtex/resolvers/productGroup.d.ts +3 -0
  36. package/dist/platforms/vtex/resolvers/query.d.ts +51 -0
  37. package/dist/platforms/vtex/resolvers/review.d.ts +2 -0
  38. package/dist/platforms/vtex/resolvers/searchResult.d.ts +5 -0
  39. package/dist/platforms/vtex/resolvers/seo.d.ts +7 -0
  40. package/dist/platforms/vtex/resolvers/validateCart.d.ts +71 -0
  41. package/dist/platforms/vtex/utils/enhanceSku.d.ts +5 -0
  42. package/dist/platforms/vtex/utils/facets.d.ts +12 -0
  43. package/dist/platforms/vtex/utils/slugify.d.ts +1 -0
  44. package/dist/platforms/vtex/utils/sort.d.ts +10 -0
  45. package/dist/typeDefs/index.d.ts +1 -0
  46. package/package.json +44 -0
  47. package/src/__generated__/schema.ts +324 -0
  48. package/src/index.ts +33 -0
  49. package/src/platforms/vtex/clients/commerce/index.ts +100 -0
  50. package/src/platforms/vtex/clients/commerce/types/Brand.ts +8 -0
  51. package/src/platforms/vtex/clients/commerce/types/CategoryTree.ts +9 -0
  52. package/src/platforms/vtex/clients/commerce/types/OrderForm.ts +371 -0
  53. package/src/platforms/vtex/clients/commerce/types/Simulation.ts +170 -0
  54. package/src/platforms/vtex/clients/fetch.ts +13 -0
  55. package/src/platforms/vtex/clients/index.ts +15 -0
  56. package/src/platforms/vtex/clients/search/index.ts +83 -0
  57. package/src/platforms/vtex/clients/search/types/AttributeSearchResult.ts +61 -0
  58. package/src/platforms/vtex/clients/search/types/ProductSearchResult.ts +223 -0
  59. package/src/platforms/vtex/index.ts +62 -0
  60. package/src/platforms/vtex/loaders/index.ts +16 -0
  61. package/src/platforms/vtex/loaders/simulation.ts +42 -0
  62. package/src/platforms/vtex/loaders/sku.ts +61 -0
  63. package/src/platforms/vtex/resolvers/aggregateOffer.ts +20 -0
  64. package/src/platforms/vtex/resolvers/aggregateRating.ts +7 -0
  65. package/src/platforms/vtex/resolvers/collection.ts +43 -0
  66. package/src/platforms/vtex/resolvers/facet.ts +11 -0
  67. package/src/platforms/vtex/resolvers/facetValue.ts +11 -0
  68. package/src/platforms/vtex/resolvers/mutation.ts +5 -0
  69. package/src/platforms/vtex/resolvers/offer.ts +26 -0
  70. package/src/platforms/vtex/resolvers/organization.ts +5 -0
  71. package/src/platforms/vtex/resolvers/product.ts +75 -0
  72. package/src/platforms/vtex/resolvers/productGroup.ts +9 -0
  73. package/src/platforms/vtex/resolvers/query.ts +115 -0
  74. package/src/platforms/vtex/resolvers/review.ts +11 -0
  75. package/src/platforms/vtex/resolvers/searchResult.ts +46 -0
  76. package/src/platforms/vtex/resolvers/seo.ts +10 -0
  77. package/src/platforms/vtex/resolvers/validateCart.ts +166 -0
  78. package/src/platforms/vtex/utils/enhanceSku.ts +8 -0
  79. package/src/platforms/vtex/utils/facets.ts +31 -0
  80. package/src/platforms/vtex/utils/slugify.ts +4 -0
  81. package/src/platforms/vtex/utils/sort.ts +10 -0
  82. package/src/typeDefs/aggregateOffer.graphql +10 -0
  83. package/src/typeDefs/aggregateRating.graphql +4 -0
  84. package/src/typeDefs/author.graphql +3 -0
  85. package/src/typeDefs/brand.graphql +3 -0
  86. package/src/typeDefs/breadcrumb.graphql +10 -0
  87. package/src/typeDefs/cart.graphql +13 -0
  88. package/src/typeDefs/collection.graphql +26 -0
  89. package/src/typeDefs/facet.graphql +14 -0
  90. package/src/typeDefs/image.graphql +9 -0
  91. package/src/typeDefs/index.ts +47 -0
  92. package/src/typeDefs/mutation.graphql +4 -0
  93. package/src/typeDefs/offer.graphql +21 -0
  94. package/src/typeDefs/order.graphql +9 -0
  95. package/src/typeDefs/organization.graphql +7 -0
  96. package/src/typeDefs/pageInfo.graphql +8 -0
  97. package/src/typeDefs/product.graphql +25 -0
  98. package/src/typeDefs/productGroup.graphql +5 -0
  99. package/src/typeDefs/query.graphql +64 -0
  100. package/src/typeDefs/review.graphql +9 -0
  101. package/src/typeDefs/seo.graphql +6 -0
  102. package/src/typeDefs/status.graphql +5 -0
  103. package/src/typings/schema.d.ts +7 -0
@@ -0,0 +1,281 @@
1
+ export declare type Maybe<T> = T | null;
2
+ export declare type Exact<T extends {
3
+ [key: string]: unknown;
4
+ }> = {
5
+ [K in keyof T]: T[K];
6
+ };
7
+ export declare type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
8
+ [SubKey in K]?: Maybe<T[SubKey]>;
9
+ };
10
+ export declare type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
11
+ [SubKey in K]: Maybe<T[SubKey]>;
12
+ };
13
+ /** All built-in and custom scalars, mapped to their actual values */
14
+ export declare type Scalars = {
15
+ ID: string;
16
+ String: string;
17
+ Boolean: boolean;
18
+ Int: number;
19
+ Float: number;
20
+ };
21
+ export declare type IStoreCart = {
22
+ order: IStoreOrder;
23
+ };
24
+ export declare type IStoreImage = {
25
+ alternateName: Scalars['String'];
26
+ url: Scalars['String'];
27
+ };
28
+ export declare type IStoreOffer = {
29
+ itemOffered: IStoreProduct;
30
+ listPrice: Scalars['Float'];
31
+ price: Scalars['Float'];
32
+ quantity: Scalars['Int'];
33
+ seller: IStoreOrganization;
34
+ };
35
+ export declare type IStoreOrder = {
36
+ acceptedOffer: Array<IStoreOffer>;
37
+ orderNumber: Scalars['String'];
38
+ };
39
+ export declare type IStoreOrganization = {
40
+ identifier: Scalars['String'];
41
+ };
42
+ export declare type IStoreProduct = {
43
+ image: Array<IStoreImage>;
44
+ name: Scalars['String'];
45
+ sku: Scalars['String'];
46
+ };
47
+ export declare type IStoreSelectedFacet = {
48
+ key: Scalars['String'];
49
+ value: Scalars['String'];
50
+ };
51
+ export declare type Mutation = {
52
+ __typename?: 'Mutation';
53
+ validateCart?: Maybe<StoreCart>;
54
+ };
55
+ export declare type MutationValidateCartArgs = {
56
+ cart: IStoreCart;
57
+ };
58
+ export declare type Query = {
59
+ __typename?: 'Query';
60
+ allCollections: StoreCollectionConnection;
61
+ allProducts: StoreProductConnection;
62
+ product: StoreProduct;
63
+ search: StoreSearchResult;
64
+ };
65
+ export declare type QueryAllCollectionsArgs = {
66
+ after?: Maybe<Scalars['String']>;
67
+ first: Scalars['Int'];
68
+ };
69
+ export declare type QueryAllProductsArgs = {
70
+ after?: Maybe<Scalars['String']>;
71
+ first: Scalars['Int'];
72
+ };
73
+ export declare type QueryProductArgs = {
74
+ locator: Array<IStoreSelectedFacet>;
75
+ };
76
+ export declare type QuerySearchArgs = {
77
+ after?: Maybe<Scalars['String']>;
78
+ first: Scalars['Int'];
79
+ selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
80
+ sort?: Maybe<StoreSort>;
81
+ term?: Maybe<Scalars['String']>;
82
+ };
83
+ export declare type StoreAggregateOffer = {
84
+ __typename?: 'StoreAggregateOffer';
85
+ highPrice: Scalars['Float'];
86
+ lowPrice: Scalars['Float'];
87
+ offerCount: Scalars['Int'];
88
+ offers: Array<StoreOffer>;
89
+ priceCurrency: Scalars['String'];
90
+ };
91
+ export declare type StoreAggregateRating = {
92
+ __typename?: 'StoreAggregateRating';
93
+ ratingValue: Scalars['Float'];
94
+ reviewCount: Scalars['Int'];
95
+ };
96
+ export declare type StoreAuthor = {
97
+ __typename?: 'StoreAuthor';
98
+ name: Scalars['String'];
99
+ };
100
+ export declare type StoreBrand = {
101
+ __typename?: 'StoreBrand';
102
+ name: Scalars['String'];
103
+ };
104
+ export declare type StoreBreadcrumbList = {
105
+ __typename?: 'StoreBreadcrumbList';
106
+ itemListElement: Array<StoreListItem>;
107
+ numberOfItems: Scalars['Int'];
108
+ };
109
+ export declare type StoreCart = {
110
+ __typename?: 'StoreCart';
111
+ messages: Array<StoreCartMessage>;
112
+ order: StoreOrder;
113
+ };
114
+ export declare type StoreCartMessage = {
115
+ __typename?: 'StoreCartMessage';
116
+ status: StoreStatus;
117
+ text: Scalars['String'];
118
+ };
119
+ export declare type StoreCollection = {
120
+ __typename?: 'StoreCollection';
121
+ breadcrumbList: StoreBreadcrumbList;
122
+ id: Scalars['ID'];
123
+ meta: StoreCollectionMeta;
124
+ seo: StoreSeo;
125
+ slug: Scalars['String'];
126
+ type: StoreCollectionType;
127
+ };
128
+ export declare type StoreCollectionConnection = {
129
+ __typename?: 'StoreCollectionConnection';
130
+ edges: Array<StoreCollectionEdge>;
131
+ pageInfo: StorePageInfo;
132
+ };
133
+ export declare type StoreCollectionEdge = {
134
+ __typename?: 'StoreCollectionEdge';
135
+ cursor: Scalars['String'];
136
+ node: StoreCollection;
137
+ };
138
+ export declare type StoreCollectionFacet = {
139
+ __typename?: 'StoreCollectionFacet';
140
+ key: Scalars['String'];
141
+ value: Scalars['String'];
142
+ };
143
+ export declare type StoreCollectionMeta = {
144
+ __typename?: 'StoreCollectionMeta';
145
+ selectedFacets: Array<StoreCollectionFacet>;
146
+ };
147
+ export declare const enum StoreCollectionType {
148
+ Brand = "Brand",
149
+ Category = "Category",
150
+ Cluster = "Cluster",
151
+ Department = "Department"
152
+ }
153
+ export declare type StoreFacet = {
154
+ __typename?: 'StoreFacet';
155
+ key: Scalars['String'];
156
+ label: Scalars['String'];
157
+ type: StoreFacetType;
158
+ values: Array<StoreFacetValue>;
159
+ };
160
+ export declare const enum StoreFacetType {
161
+ Boolean = "BOOLEAN",
162
+ Range = "RANGE"
163
+ }
164
+ export declare type StoreFacetValue = {
165
+ __typename?: 'StoreFacetValue';
166
+ label: Scalars['String'];
167
+ quantity: Scalars['Int'];
168
+ selected: Scalars['Boolean'];
169
+ value: Scalars['String'];
170
+ };
171
+ export declare type StoreImage = {
172
+ __typename?: 'StoreImage';
173
+ alternateName: Scalars['String'];
174
+ url: Scalars['String'];
175
+ };
176
+ export declare type StoreListItem = {
177
+ __typename?: 'StoreListItem';
178
+ item: Scalars['String'];
179
+ name: Scalars['String'];
180
+ position: Scalars['Int'];
181
+ };
182
+ export declare type StoreOffer = {
183
+ __typename?: 'StoreOffer';
184
+ availability: Scalars['String'];
185
+ itemCondition: Scalars['String'];
186
+ itemOffered: StoreProduct;
187
+ listPrice: Scalars['Float'];
188
+ price: Scalars['Float'];
189
+ priceCurrency: Scalars['String'];
190
+ priceValidUntil: Scalars['String'];
191
+ quantity: Scalars['Int'];
192
+ seller: StoreOrganization;
193
+ sellingPrice: Scalars['Float'];
194
+ };
195
+ export declare type StoreOrder = {
196
+ __typename?: 'StoreOrder';
197
+ acceptedOffer: Array<StoreOffer>;
198
+ orderNumber: Scalars['String'];
199
+ };
200
+ export declare type StoreOrganization = {
201
+ __typename?: 'StoreOrganization';
202
+ identifier: Scalars['String'];
203
+ };
204
+ export declare type StorePageInfo = {
205
+ __typename?: 'StorePageInfo';
206
+ endCursor: Scalars['String'];
207
+ hasNextPage: Scalars['Boolean'];
208
+ hasPreviousPage: Scalars['Boolean'];
209
+ startCursor: Scalars['String'];
210
+ totalCount: Scalars['Int'];
211
+ };
212
+ export declare type StoreProduct = {
213
+ __typename?: 'StoreProduct';
214
+ aggregateRating: StoreAggregateRating;
215
+ brand: StoreBrand;
216
+ breadcrumbList: StoreBreadcrumbList;
217
+ description: Scalars['String'];
218
+ gtin: Scalars['String'];
219
+ image: Array<StoreImage>;
220
+ isVariantOf: StoreProductGroup;
221
+ name: Scalars['String'];
222
+ offers: StoreAggregateOffer;
223
+ productID: Scalars['String'];
224
+ review: Array<StoreReview>;
225
+ seo: StoreSeo;
226
+ sku: Scalars['String'];
227
+ slug: Scalars['String'];
228
+ };
229
+ export declare type StoreProductConnection = {
230
+ __typename?: 'StoreProductConnection';
231
+ edges: Array<StoreProductEdge>;
232
+ pageInfo: StorePageInfo;
233
+ };
234
+ export declare type StoreProductEdge = {
235
+ __typename?: 'StoreProductEdge';
236
+ cursor: Scalars['String'];
237
+ node: StoreProduct;
238
+ };
239
+ export declare type StoreProductGroup = {
240
+ __typename?: 'StoreProductGroup';
241
+ hasVariant: Array<StoreProduct>;
242
+ name: Scalars['String'];
243
+ productGroupID: Scalars['String'];
244
+ };
245
+ export declare type StoreReview = {
246
+ __typename?: 'StoreReview';
247
+ author: StoreAuthor;
248
+ reviewRating: StoreReviewRating;
249
+ };
250
+ export declare type StoreReviewRating = {
251
+ __typename?: 'StoreReviewRating';
252
+ bestRating: Scalars['Float'];
253
+ ratingValue: Scalars['Float'];
254
+ };
255
+ export declare type StoreSearchResult = {
256
+ __typename?: 'StoreSearchResult';
257
+ facets: Array<StoreFacet>;
258
+ products: StoreProductConnection;
259
+ };
260
+ export declare type StoreSeo = {
261
+ __typename?: 'StoreSeo';
262
+ canonical: Scalars['String'];
263
+ description: Scalars['String'];
264
+ title: Scalars['String'];
265
+ titleTemplate: Scalars['String'];
266
+ };
267
+ export declare const enum StoreSort {
268
+ DiscountDesc = "discount_desc",
269
+ NameAsc = "name_asc",
270
+ NameDesc = "name_desc",
271
+ OrdersDesc = "orders_desc",
272
+ PriceAsc = "price_asc",
273
+ PriceDesc = "price_desc",
274
+ ReleaseDesc = "release_desc",
275
+ ScoreDesc = "score_desc"
276
+ }
277
+ export declare const enum StoreStatus {
278
+ Error = "ERROR",
279
+ Info = "INFO",
280
+ Warning = "WARNING"
281
+ }