@blackfisk/blackfisk-vue-storefront-sdk 1.0.10 → 1.0.12

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 (61) hide show
  1. package/lib/index.cjs.js +176 -1
  2. package/lib/index.cjs.js.map +1 -1
  3. package/lib/index.es.js +176 -1
  4. package/lib/index.es.js.map +1 -1
  5. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/clearCart/index.d.ts +9 -0
  6. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/clearCart/index.d.ts.map +1 -0
  7. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getCart/index.d.ts +10 -0
  8. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getCart/index.d.ts.map +1 -0
  9. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts.map +1 -1
  10. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getSortableAttributes/index.d.ts +6 -0
  11. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getSortableAttributes/index.d.ts.map +1 -0
  12. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getStripePaymentIntent/index.d.ts +10 -0
  13. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getStripePaymentIntent/index.d.ts.map +1 -0
  14. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/loadShippingMethods/index.d.ts +6 -0
  15. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/loadShippingMethods/index.d.ts.map +1 -0
  16. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/proxyInstantsearch/index.d.ts.map +1 -1
  17. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/setShippingMethod/index.d.ts +10 -0
  18. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/setShippingMethod/index.d.ts.map +1 -0
  19. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/upsertCartItem/index.d.ts +12 -0
  20. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/upsertCartItem/index.d.ts.map +1 -0
  21. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts +14 -0
  22. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts.map +1 -1
  23. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts +84 -2
  24. package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts.map +1 -1
  25. package/lib/packages/api-client/src/api/clearCart/index.d.ts +9 -0
  26. package/lib/packages/api-client/src/api/clearCart/index.d.ts.map +1 -0
  27. package/lib/packages/api-client/src/api/getCart/index.d.ts +10 -0
  28. package/lib/packages/api-client/src/api/getCart/index.d.ts.map +1 -0
  29. package/lib/packages/api-client/src/api/getProductCollection/index.d.ts.map +1 -1
  30. package/lib/packages/api-client/src/api/getSortableAttributes/index.d.ts +6 -0
  31. package/lib/packages/api-client/src/api/getSortableAttributes/index.d.ts.map +1 -0
  32. package/lib/packages/api-client/src/api/getStripePaymentIntent/index.d.ts +10 -0
  33. package/lib/packages/api-client/src/api/getStripePaymentIntent/index.d.ts.map +1 -0
  34. package/lib/packages/api-client/src/api/loadShippingMethods/index.d.ts +6 -0
  35. package/lib/packages/api-client/src/api/loadShippingMethods/index.d.ts.map +1 -0
  36. package/lib/packages/api-client/src/api/proxyInstantsearch/index.d.ts.map +1 -1
  37. package/lib/packages/api-client/src/api/setShippingMethod/index.d.ts +10 -0
  38. package/lib/packages/api-client/src/api/setShippingMethod/index.d.ts.map +1 -0
  39. package/lib/packages/api-client/src/api/upsertCartItem/index.d.ts +12 -0
  40. package/lib/packages/api-client/src/api/upsertCartItem/index.d.ts.map +1 -0
  41. package/lib/packages/api-client/src/types/api/endpoints.d.ts +14 -0
  42. package/lib/packages/api-client/src/types/api/endpoints.d.ts.map +1 -1
  43. package/lib/packages/api-client/src/types/api/index.d.ts +84 -2
  44. package/lib/packages/api-client/src/types/api/index.d.ts.map +1 -1
  45. package/lib/packages/sdk/src/methods/clearCart/index.d.ts +22 -0
  46. package/lib/packages/sdk/src/methods/clearCart/index.d.ts.map +1 -0
  47. package/lib/packages/sdk/src/methods/getCart/index.d.ts +22 -0
  48. package/lib/packages/sdk/src/methods/getCart/index.d.ts.map +1 -0
  49. package/lib/packages/sdk/src/methods/getSortableAttributes/index.d.ts +22 -0
  50. package/lib/packages/sdk/src/methods/getSortableAttributes/index.d.ts.map +1 -0
  51. package/lib/packages/sdk/src/methods/getStripePaymentIntent/index.d.ts +22 -0
  52. package/lib/packages/sdk/src/methods/getStripePaymentIntent/index.d.ts.map +1 -0
  53. package/lib/packages/sdk/src/methods/index.d.ts +7 -0
  54. package/lib/packages/sdk/src/methods/index.d.ts.map +1 -1
  55. package/lib/packages/sdk/src/methods/loadShippingMethods/index.d.ts +22 -0
  56. package/lib/packages/sdk/src/methods/loadShippingMethods/index.d.ts.map +1 -0
  57. package/lib/packages/sdk/src/methods/setShippingMethod/index.d.ts +22 -0
  58. package/lib/packages/sdk/src/methods/setShippingMethod/index.d.ts.map +1 -0
  59. package/lib/packages/sdk/src/methods/upsertCartItem/index.d.ts +22 -0
  60. package/lib/packages/sdk/src/methods/upsertCartItem/index.d.ts.map +1 -0
  61. package/package.json +3 -3
package/lib/index.cjs.js CHANGED
@@ -139,13 +139,188 @@ async function getProductFacets(props) {
139
139
  return data;
140
140
  }
141
141
 
142
+ /**
143
+ * Method summary - General information about the SDK method, usually a single sentence.
144
+ *
145
+ * @remarks
146
+ * In this section, we have been adding detailed information such as:
147
+ * * what API middleware endpoint this method is calling,
148
+ * * what SAP OCC API endpoints are being called as a result of using this method,
149
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
150
+ * * simply everything what helps with understanding how it works.
151
+ *
152
+ * @param props
153
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
154
+ *
155
+ * @returns
156
+ * Human-friendly information what the SDK methods returns.
157
+ *
158
+ * @example
159
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
160
+ */
161
+ async function getCart(props) {
162
+ const { data } = await client.post('getCart', props);
163
+ return data;
164
+ }
165
+
166
+ /**
167
+ * Method summary - General information about the SDK method, usually a single sentence.
168
+ *
169
+ * @remarks
170
+ * In this section, we have been adding detailed information such as:
171
+ * * what API middleware endpoint this method is calling,
172
+ * * what SAP OCC API endpoints are being called as a result of using this method,
173
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
174
+ * * simply everything what helps with understanding how it works.
175
+ *
176
+ * @param props
177
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
178
+ *
179
+ * @returns
180
+ * Human-friendly information what the SDK methods returns.
181
+ *
182
+ * @example
183
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
184
+ */
185
+ async function upsertCartItem(props) {
186
+ const { data } = await client.post('upsertCartItem', props);
187
+ return data;
188
+ }
189
+
190
+ /**
191
+ * Method summary - General information about the SDK method, usually a single sentence.
192
+ *
193
+ * @remarks
194
+ * In this section, we have been adding detailed information such as:
195
+ * * what API middleware endpoint this method is calling,
196
+ * * what SAP OCC API endpoints are being called as a result of using this method,
197
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
198
+ * * simply everything what helps with understanding how it works.
199
+ *
200
+ * @param props
201
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
202
+ *
203
+ * @returns
204
+ * Human-friendly information what the SDK methods returns.
205
+ *
206
+ * @example
207
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
208
+ */
209
+ async function clearCart(props) {
210
+ const { data } = await client.post('clearCart', props);
211
+ return data;
212
+ }
213
+
214
+ /**
215
+ * Method summary - General information about the SDK method, usually a single sentence.
216
+ *
217
+ * @remarks
218
+ * In this section, we have been adding detailed information such as:
219
+ * * what API middleware endpoint this method is calling,
220
+ * * what SAP OCC API endpoints are being called as a result of using this method,
221
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
222
+ * * simply everything what helps with understanding how it works.
223
+ *
224
+ * @param props
225
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
226
+ *
227
+ * @returns
228
+ * Human-friendly information what the SDK methods returns.
229
+ *
230
+ * @example
231
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
232
+ */
233
+ async function loadShippingMethods(props) {
234
+ const { data } = await client.post('loadShippingMethods', props);
235
+ return data;
236
+ }
237
+
238
+ /**
239
+ * Method summary - General information about the SDK method, usually a single sentence.
240
+ *
241
+ * @remarks
242
+ * In this section, we have been adding detailed information such as:
243
+ * * what API middleware endpoint this method is calling,
244
+ * * what SAP OCC API endpoints are being called as a result of using this method,
245
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
246
+ * * simply everything what helps with understanding how it works.
247
+ *
248
+ * @param props
249
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
250
+ *
251
+ * @returns
252
+ * Human-friendly information what the SDK methods returns.
253
+ *
254
+ * @example
255
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
256
+ */
257
+ async function setShippingMethod(props) {
258
+ const { data } = await client.post('setShippingMethod', props);
259
+ return data;
260
+ }
261
+
262
+ /**
263
+ * Method summary - General information about the SDK method, usually a single sentence.
264
+ *
265
+ * @remarks
266
+ * In this section, we have been adding detailed information such as:
267
+ * * what API middleware endpoint this method is calling,
268
+ * * what SAP OCC API endpoints are being called as a result of using this method,
269
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
270
+ * * simply everything what helps with understanding how it works.
271
+ *
272
+ * @param props
273
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
274
+ *
275
+ * @returns
276
+ * Human-friendly information what the SDK methods returns.
277
+ *
278
+ * @example
279
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
280
+ */
281
+ async function getStripePaymentIntent(props) {
282
+ const { data } = await client.post('getStripePaymentIntent', props);
283
+ return data;
284
+ }
285
+
286
+ /**
287
+ * Method summary - General information about the SDK method, usually a single sentence.
288
+ *
289
+ * @remarks
290
+ * In this section, we have been adding detailed information such as:
291
+ * * what API middleware endpoint this method is calling,
292
+ * * what SAP OCC API endpoints are being called as a result of using this method,
293
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
294
+ * * simply everything what helps with understanding how it works.
295
+ *
296
+ * @param props
297
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
298
+ *
299
+ * @returns
300
+ * Human-friendly information what the SDK methods returns.
301
+ *
302
+ * @example
303
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
304
+ */
305
+ async function getSortableAttributes(props) {
306
+ const { data } = await client.post('getSortableAttributes', props);
307
+ return data;
308
+ }
309
+
142
310
  var methods = /*#__PURE__*/Object.freeze({
143
311
  __proto__: null,
144
312
  getProductCollection: getProductCollection,
145
313
  getProductListing: getProductListing,
146
314
  proxyInstantsearch: proxyInstantsearch,
147
315
  getCollection: getCollection,
148
- getProductFacets: getProductFacets
316
+ getProductFacets: getProductFacets,
317
+ getCart: getCart,
318
+ upsertCartItem: upsertCartItem,
319
+ clearCart: clearCart,
320
+ loadShippingMethods: loadShippingMethods,
321
+ setShippingMethod: setShippingMethod,
322
+ getStripePaymentIntent: getStripePaymentIntent,
323
+ getSortableAttributes: getSortableAttributes
149
324
  });
150
325
 
151
326
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":["../src/client/index.ts","../src/methods/getProductCollection/index.ts","../src/methods/getProductListing/index.ts","../src/methods/proxyInstantsearch/index.ts","../src/methods/getCollection/index.ts","../src/methods/getProductFacets/index.ts","../src/connector.ts","../src/index.ts"],"sourcesContent":["import axios from 'axios';\n\nexport const client = axios.create();","import { client } from '../../client';\nimport { getProductCollectionParams, getProductCollectionResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductCollection\n * * Blackfisk endpoint: /v2/vsf/productCollection\n * * Any authenticated client can make this call. A collectionId must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * \n * Optional -\n * * debug: boolean\n * * templateParams: object with the keys required to populate the template chain for the specified collection.\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })\n */\nexport async function getProductCollection(props: getProductCollectionParams) {\n const { data } = await client.post<getProductCollectionResponse>('getProductCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { getProductListingParams, getProductListingResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductListing\n * * Blackfisk endpoint: /v2/vsf/product/variations\n * * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * * [familyId || channelListingId]\n * \n * Optional -\n * * debug: boolean\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })\n */\nexport async function getProductListing(props: getProductListingParams) {\n const { data } = await client.post<getProductListingResponse>('getProductListing', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function proxyInstantsearch(props: TODO) {\n // console.log('sdk props', props)\n const { data } = await client.post<TODO>('proxyInstantsearch', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getCollection(props: TODO) {\n const { data } = await client.post<TODO>('getCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * API middleware endpoint: /getProductFacets\n * * Blackfisk endpoint: /v2/vsf/product/facets\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getProductFacets(props: TODO) {\n const { data } = await client.post<TODO>('getProductFacets', props);\n return data\n}\n","import { client } from './client';\nimport { Options } from './types';\nimport * as methods from './methods/index';\n\n/**\n * Connector methods.\n */\ntype Methods = typeof methods;\n\n/**\n * Initialize the Blackfisk connector.\n */\nexport const blackfiskConnector = (options: Options): Methods => {\n client.defaults.baseURL = options.apiUrl;\n\n return methods;\n};\n","import { blackfiskConnector } from './connector';\nimport type { Options } from './types';\nimport type { Module } from '@vue-storefront/sdk';\n\n/**\n * Blackfisk module type.\n */\nexport interface BlackfiskModuleType extends Module {\n /**\n * The connector of the Blackfisk module.\n */\n connector: ReturnType<typeof blackfiskConnector>;\n}\n\n/**\n * Blackfisk module.\n */\nexport const blackfiskModule = (options: Options): BlackfiskModuleType => {\n return {\n connector: blackfiskConnector({\n apiUrl: options.apiUrl,\n }),\n utils: {},\n subscribers: {},\n }\n};\n\nexport { client } from './client';\n\nexport * from './types';\n"],"names":["axios"],"mappings":";;;;;;;;;;MAEa,MAAM,GAAGA,yBAAK,CAAC,MAAM;;ACClC;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,oBAAoB,CAAC,KAAiC,EAAA;AAC1E,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA+B,sBAAsB,EAAE,KAAK,CAAC,CAAC;AAChG,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,iBAAiB,CAAC,KAA8B,EAAA;AACpE,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA4B,mBAAmB,EAAE,KAAK,CAAC,CAAC;AAC1F,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,kBAAkB,CAAC,KAAW,EAAA;;AAElD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,oBAAoB,EAAE,KAAK,CAAC,CAAC;AACtE,IAAA,OAAO,IAAI,CAAA;AACb;;ACvBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,eAAe,EAAE,KAAK,CAAC,CAAC;AACjE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,gBAAgB,CAAC,KAAW,EAAA;AAChD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AACpE,IAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;;;AChBA;;AAEG;AACI,MAAM,kBAAkB,GAAG,CAAC,OAAgB,KAAa;IAC9D,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;AAEzC,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;;ACFD;;AAEG;AACU,MAAA,eAAe,GAAG,CAAC,OAAgB,KAAyB;IACvE,OAAO;QACL,SAAS,EAAE,kBAAkB,CAAC;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;AACF,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,WAAW,EAAE,EAAE;KAChB,CAAA;AACH;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/client/index.ts","../src/methods/getProductCollection/index.ts","../src/methods/getProductListing/index.ts","../src/methods/proxyInstantsearch/index.ts","../src/methods/getCollection/index.ts","../src/methods/getProductFacets/index.ts","../src/methods/getCart/index.ts","../src/methods/upsertCartItem/index.ts","../src/methods/clearCart/index.ts","../src/methods/loadShippingMethods/index.ts","../src/methods/setShippingMethod/index.ts","../src/methods/getStripePaymentIntent/index.ts","../src/methods/getSortableAttributes/index.ts","../src/connector.ts","../src/index.ts"],"sourcesContent":["import axios from 'axios';\n\nexport const client = axios.create();","import { client } from '../../client';\nimport { getProductCollectionParams, getProductCollectionResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductCollection\n * * Blackfisk endpoint: /v2/vsf/productCollection\n * * Any authenticated client can make this call. A collectionId must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * \n * Optional -\n * * debug: boolean\n * * templateParams: object with the keys required to populate the template chain for the specified collection.\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })\n */\nexport async function getProductCollection(props: getProductCollectionParams) {\n const { data } = await client.post<getProductCollectionResponse>('getProductCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { getProductListingParams, getProductListingResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductListing\n * * Blackfisk endpoint: /v2/vsf/product/variations\n * * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * * [familyId || channelListingId]\n * \n * Optional -\n * * debug: boolean\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })\n */\nexport async function getProductListing(props: getProductListingParams) {\n const { data } = await client.post<getProductListingResponse>('getProductListing', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function proxyInstantsearch(props: TODO) {\n // console.log('sdk props', props)\n const { data } = await client.post<TODO>('proxyInstantsearch', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getCollection(props: TODO) {\n const { data } = await client.post<TODO>('getCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * API middleware endpoint: /getProductFacets\n * * Blackfisk endpoint: /v2/vsf/product/facets\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getProductFacets(props: TODO) {\n const { data } = await client.post<TODO>('getProductFacets', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getCart(props: TODO) {\n const { data } = await client.post<TODO>('getCart', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function upsertCartItem(props: TODO) {\n const { data } = await client.post<TODO>('upsertCartItem', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function clearCart(props: TODO) {\n const { data } = await client.post<TODO>('clearCart', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function loadShippingMethods(props: TODO) {\n const { data } = await client.post<TODO>('loadShippingMethods', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function setShippingMethod(props: TODO) {\n const { data } = await client.post<TODO>('setShippingMethod', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getStripePaymentIntent(props: TODO) {\n const { data } = await client.post<TODO>('getStripePaymentIntent', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getSortableAttributes(props: TODO) {\n const { data } = await client.post<TODO>('getSortableAttributes', props);\n return data\n}\n","import { client } from './client';\nimport { Options } from './types';\nimport * as methods from './methods/index';\n\n/**\n * Connector methods.\n */\ntype Methods = typeof methods;\n\n/**\n * Initialize the Blackfisk connector.\n */\nexport const blackfiskConnector = (options: Options): Methods => {\n client.defaults.baseURL = options.apiUrl;\n\n return methods;\n};\n","import { blackfiskConnector } from './connector';\nimport type { Options } from './types';\nimport type { Module } from '@vue-storefront/sdk';\n\n/**\n * Blackfisk module type.\n */\nexport interface BlackfiskModuleType extends Module {\n /**\n * The connector of the Blackfisk module.\n */\n connector: ReturnType<typeof blackfiskConnector>;\n}\n\n/**\n * Blackfisk module.\n */\nexport const blackfiskModule = (options: Options): BlackfiskModuleType => {\n return {\n connector: blackfiskConnector({\n apiUrl: options.apiUrl,\n }),\n utils: {},\n subscribers: {},\n }\n};\n\nexport { client } from './client';\n\nexport * from './types';\n"],"names":["axios"],"mappings":";;;;;;;;;;MAEa,MAAM,GAAGA,yBAAK,CAAC,MAAM;;ACClC;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,oBAAoB,CAAC,KAAiC,EAAA;AAC1E,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA+B,sBAAsB,EAAE,KAAK,CAAC,CAAC;AAChG,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,iBAAiB,CAAC,KAA8B,EAAA;AACpE,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA4B,mBAAmB,EAAE,KAAK,CAAC,CAAC;AAC1F,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,kBAAkB,CAAC,KAAW,EAAA;;AAElD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,oBAAoB,EAAE,KAAK,CAAC,CAAC;AACtE,IAAA,OAAO,IAAI,CAAA;AACb;;ACvBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,eAAe,EAAE,KAAK,CAAC,CAAC;AACjE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,gBAAgB,CAAC,KAAW,EAAA;AAChD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AACpE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,OAAO,CAAC,KAAW,EAAA;AACvC,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,SAAS,EAAE,KAAK,CAAC,CAAC;AAC3D,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,cAAc,CAAC,KAAW,EAAA;AAC9C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAClE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,SAAS,CAAC,KAAW,EAAA;AACzC,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,WAAW,EAAE,KAAK,CAAC,CAAC;AAC7D,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,mBAAmB,CAAC,KAAW,EAAA;AACnD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,qBAAqB,EAAE,KAAK,CAAC,CAAC;AACvE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,iBAAiB,CAAC,KAAW,EAAA;AACjD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,mBAAmB,EAAE,KAAK,CAAC,CAAC;AACrE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,sBAAsB,CAAC,KAAW,EAAA;AACtD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,wBAAwB,EAAE,KAAK,CAAC,CAAC;AAC1E,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,qBAAqB,CAAC,KAAW,EAAA;AACrD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,uBAAuB,EAAE,KAAK,CAAC,CAAC;AACzE,IAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;;;;;;;;;;AChBA;;AAEG;AACI,MAAM,kBAAkB,GAAG,CAAC,OAAgB,KAAa;IAC9D,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;AAEzC,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;;ACFD;;AAEG;AACU,MAAA,eAAe,GAAG,CAAC,OAAgB,KAAyB;IACvE,OAAO;QACL,SAAS,EAAE,kBAAkB,CAAC;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;AACF,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,WAAW,EAAE,EAAE;KAChB,CAAA;AACH;;;;;"}
package/lib/index.es.js CHANGED
@@ -131,13 +131,188 @@ async function getProductFacets(props) {
131
131
  return data;
132
132
  }
133
133
 
134
+ /**
135
+ * Method summary - General information about the SDK method, usually a single sentence.
136
+ *
137
+ * @remarks
138
+ * In this section, we have been adding detailed information such as:
139
+ * * what API middleware endpoint this method is calling,
140
+ * * what SAP OCC API endpoints are being called as a result of using this method,
141
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
142
+ * * simply everything what helps with understanding how it works.
143
+ *
144
+ * @param props
145
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
146
+ *
147
+ * @returns
148
+ * Human-friendly information what the SDK methods returns.
149
+ *
150
+ * @example
151
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
152
+ */
153
+ async function getCart(props) {
154
+ const { data } = await client.post('getCart', props);
155
+ return data;
156
+ }
157
+
158
+ /**
159
+ * Method summary - General information about the SDK method, usually a single sentence.
160
+ *
161
+ * @remarks
162
+ * In this section, we have been adding detailed information such as:
163
+ * * what API middleware endpoint this method is calling,
164
+ * * what SAP OCC API endpoints are being called as a result of using this method,
165
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
166
+ * * simply everything what helps with understanding how it works.
167
+ *
168
+ * @param props
169
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
170
+ *
171
+ * @returns
172
+ * Human-friendly information what the SDK methods returns.
173
+ *
174
+ * @example
175
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
176
+ */
177
+ async function upsertCartItem(props) {
178
+ const { data } = await client.post('upsertCartItem', props);
179
+ return data;
180
+ }
181
+
182
+ /**
183
+ * Method summary - General information about the SDK method, usually a single sentence.
184
+ *
185
+ * @remarks
186
+ * In this section, we have been adding detailed information such as:
187
+ * * what API middleware endpoint this method is calling,
188
+ * * what SAP OCC API endpoints are being called as a result of using this method,
189
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
190
+ * * simply everything what helps with understanding how it works.
191
+ *
192
+ * @param props
193
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
194
+ *
195
+ * @returns
196
+ * Human-friendly information what the SDK methods returns.
197
+ *
198
+ * @example
199
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
200
+ */
201
+ async function clearCart(props) {
202
+ const { data } = await client.post('clearCart', props);
203
+ return data;
204
+ }
205
+
206
+ /**
207
+ * Method summary - General information about the SDK method, usually a single sentence.
208
+ *
209
+ * @remarks
210
+ * In this section, we have been adding detailed information such as:
211
+ * * what API middleware endpoint this method is calling,
212
+ * * what SAP OCC API endpoints are being called as a result of using this method,
213
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
214
+ * * simply everything what helps with understanding how it works.
215
+ *
216
+ * @param props
217
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
218
+ *
219
+ * @returns
220
+ * Human-friendly information what the SDK methods returns.
221
+ *
222
+ * @example
223
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
224
+ */
225
+ async function loadShippingMethods(props) {
226
+ const { data } = await client.post('loadShippingMethods', props);
227
+ return data;
228
+ }
229
+
230
+ /**
231
+ * Method summary - General information about the SDK method, usually a single sentence.
232
+ *
233
+ * @remarks
234
+ * In this section, we have been adding detailed information such as:
235
+ * * what API middleware endpoint this method is calling,
236
+ * * what SAP OCC API endpoints are being called as a result of using this method,
237
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
238
+ * * simply everything what helps with understanding how it works.
239
+ *
240
+ * @param props
241
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
242
+ *
243
+ * @returns
244
+ * Human-friendly information what the SDK methods returns.
245
+ *
246
+ * @example
247
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
248
+ */
249
+ async function setShippingMethod(props) {
250
+ const { data } = await client.post('setShippingMethod', props);
251
+ return data;
252
+ }
253
+
254
+ /**
255
+ * Method summary - General information about the SDK method, usually a single sentence.
256
+ *
257
+ * @remarks
258
+ * In this section, we have been adding detailed information such as:
259
+ * * what API middleware endpoint this method is calling,
260
+ * * what SAP OCC API endpoints are being called as a result of using this method,
261
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
262
+ * * simply everything what helps with understanding how it works.
263
+ *
264
+ * @param props
265
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
266
+ *
267
+ * @returns
268
+ * Human-friendly information what the SDK methods returns.
269
+ *
270
+ * @example
271
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
272
+ */
273
+ async function getStripePaymentIntent(props) {
274
+ const { data } = await client.post('getStripePaymentIntent', props);
275
+ return data;
276
+ }
277
+
278
+ /**
279
+ * Method summary - General information about the SDK method, usually a single sentence.
280
+ *
281
+ * @remarks
282
+ * In this section, we have been adding detailed information such as:
283
+ * * what API middleware endpoint this method is calling,
284
+ * * what SAP OCC API endpoints are being called as a result of using this method,
285
+ * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
286
+ * * simply everything what helps with understanding how it works.
287
+ *
288
+ * @param props
289
+ * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.
290
+ *
291
+ * @returns
292
+ * Human-friendly information what the SDK methods returns.
293
+ *
294
+ * @example
295
+ * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.
296
+ */
297
+ async function getSortableAttributes(props) {
298
+ const { data } = await client.post('getSortableAttributes', props);
299
+ return data;
300
+ }
301
+
134
302
  var methods = /*#__PURE__*/Object.freeze({
135
303
  __proto__: null,
136
304
  getProductCollection: getProductCollection,
137
305
  getProductListing: getProductListing,
138
306
  proxyInstantsearch: proxyInstantsearch,
139
307
  getCollection: getCollection,
140
- getProductFacets: getProductFacets
308
+ getProductFacets: getProductFacets,
309
+ getCart: getCart,
310
+ upsertCartItem: upsertCartItem,
311
+ clearCart: clearCart,
312
+ loadShippingMethods: loadShippingMethods,
313
+ setShippingMethod: setShippingMethod,
314
+ getStripePaymentIntent: getStripePaymentIntent,
315
+ getSortableAttributes: getSortableAttributes
141
316
  });
142
317
 
143
318
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.es.js","sources":["../src/client/index.ts","../src/methods/getProductCollection/index.ts","../src/methods/getProductListing/index.ts","../src/methods/proxyInstantsearch/index.ts","../src/methods/getCollection/index.ts","../src/methods/getProductFacets/index.ts","../src/connector.ts","../src/index.ts"],"sourcesContent":["import axios from 'axios';\n\nexport const client = axios.create();","import { client } from '../../client';\nimport { getProductCollectionParams, getProductCollectionResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductCollection\n * * Blackfisk endpoint: /v2/vsf/productCollection\n * * Any authenticated client can make this call. A collectionId must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * \n * Optional -\n * * debug: boolean\n * * templateParams: object with the keys required to populate the template chain for the specified collection.\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })\n */\nexport async function getProductCollection(props: getProductCollectionParams) {\n const { data } = await client.post<getProductCollectionResponse>('getProductCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { getProductListingParams, getProductListingResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductListing\n * * Blackfisk endpoint: /v2/vsf/product/variations\n * * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * * [familyId || channelListingId]\n * \n * Optional -\n * * debug: boolean\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })\n */\nexport async function getProductListing(props: getProductListingParams) {\n const { data } = await client.post<getProductListingResponse>('getProductListing', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function proxyInstantsearch(props: TODO) {\n // console.log('sdk props', props)\n const { data } = await client.post<TODO>('proxyInstantsearch', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getCollection(props: TODO) {\n const { data } = await client.post<TODO>('getCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * API middleware endpoint: /getProductFacets\n * * Blackfisk endpoint: /v2/vsf/product/facets\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getProductFacets(props: TODO) {\n const { data } = await client.post<TODO>('getProductFacets', props);\n return data\n}\n","import { client } from './client';\nimport { Options } from './types';\nimport * as methods from './methods/index';\n\n/**\n * Connector methods.\n */\ntype Methods = typeof methods;\n\n/**\n * Initialize the Blackfisk connector.\n */\nexport const blackfiskConnector = (options: Options): Methods => {\n client.defaults.baseURL = options.apiUrl;\n\n return methods;\n};\n","import { blackfiskConnector } from './connector';\nimport type { Options } from './types';\nimport type { Module } from '@vue-storefront/sdk';\n\n/**\n * Blackfisk module type.\n */\nexport interface BlackfiskModuleType extends Module {\n /**\n * The connector of the Blackfisk module.\n */\n connector: ReturnType<typeof blackfiskConnector>;\n}\n\n/**\n * Blackfisk module.\n */\nexport const blackfiskModule = (options: Options): BlackfiskModuleType => {\n return {\n connector: blackfiskConnector({\n apiUrl: options.apiUrl,\n }),\n utils: {},\n subscribers: {},\n }\n};\n\nexport { client } from './client';\n\nexport * from './types';\n"],"names":[],"mappings":";;MAEa,MAAM,GAAG,KAAK,CAAC,MAAM;;ACClC;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,oBAAoB,CAAC,KAAiC,EAAA;AAC1E,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA+B,sBAAsB,EAAE,KAAK,CAAC,CAAC;AAChG,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,iBAAiB,CAAC,KAA8B,EAAA;AACpE,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA4B,mBAAmB,EAAE,KAAK,CAAC,CAAC;AAC1F,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,kBAAkB,CAAC,KAAW,EAAA;;AAElD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,oBAAoB,EAAE,KAAK,CAAC,CAAC;AACtE,IAAA,OAAO,IAAI,CAAA;AACb;;ACvBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,eAAe,EAAE,KAAK,CAAC,CAAC;AACjE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,gBAAgB,CAAC,KAAW,EAAA;AAChD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AACpE,IAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;;;AChBA;;AAEG;AACI,MAAM,kBAAkB,GAAG,CAAC,OAAgB,KAAa;IAC9D,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;AAEzC,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;;ACFD;;AAEG;AACU,MAAA,eAAe,GAAG,CAAC,OAAgB,KAAyB;IACvE,OAAO;QACL,SAAS,EAAE,kBAAkB,CAAC;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;AACF,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,WAAW,EAAE,EAAE;KAChB,CAAA;AACH;;;;"}
1
+ {"version":3,"file":"index.es.js","sources":["../src/client/index.ts","../src/methods/getProductCollection/index.ts","../src/methods/getProductListing/index.ts","../src/methods/proxyInstantsearch/index.ts","../src/methods/getCollection/index.ts","../src/methods/getProductFacets/index.ts","../src/methods/getCart/index.ts","../src/methods/upsertCartItem/index.ts","../src/methods/clearCart/index.ts","../src/methods/loadShippingMethods/index.ts","../src/methods/setShippingMethod/index.ts","../src/methods/getStripePaymentIntent/index.ts","../src/methods/getSortableAttributes/index.ts","../src/connector.ts","../src/index.ts"],"sourcesContent":["import axios from 'axios';\n\nexport const client = axios.create();","import { client } from '../../client';\nimport { getProductCollectionParams, getProductCollectionResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductCollection\n * * Blackfisk endpoint: /v2/vsf/productCollection\n * * Any authenticated client can make this call. A collectionId must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * \n * Optional -\n * * debug: boolean\n * * templateParams: object with the keys required to populate the template chain for the specified collection.\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })\n */\nexport async function getProductCollection(props: getProductCollectionParams) {\n const { data } = await client.post<getProductCollectionResponse>('getProductCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { getProductListingParams, getProductListingResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing'\n\n/**\n * Executes a collection template chain against Elasticsearch - returning a collection of products.\n * \n * @remarks\n * * API middleware endpoint: /getProductListing\n * * Blackfisk endpoint: /v2/vsf/product/variations\n * * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.\n * \n * @param props\n * \n * Required\n * * collectionId \n * * [familyId || channelListingId]\n * \n * Optional -\n * * debug: boolean\n * \n * @returns\n * An array of SearchProduct objects.\n * \n * @example\n * const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })\n */\nexport async function getProductListing(props: getProductListingParams) {\n const { data } = await client.post<getProductListingResponse>('getProductListing', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function proxyInstantsearch(props: TODO) {\n // console.log('sdk props', props)\n const { data } = await client.post<TODO>('proxyInstantsearch', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getCollection(props: TODO) {\n const { data } = await client.post<TODO>('getCollection', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * API middleware endpoint: /getProductFacets\n * * Blackfisk endpoint: /v2/vsf/product/facets\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getProductFacets(props: TODO) {\n const { data } = await client.post<TODO>('getProductFacets', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getCart(props: TODO) {\n const { data } = await client.post<TODO>('getCart', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function upsertCartItem(props: TODO) {\n const { data } = await client.post<TODO>('upsertCartItem', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function clearCart(props: TODO) {\n const { data } = await client.post<TODO>('clearCart', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function loadShippingMethods(props: TODO) {\n const { data } = await client.post<TODO>('loadShippingMethods', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function setShippingMethod(props: TODO) {\n const { data } = await client.post<TODO>('setShippingMethod', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getStripePaymentIntent(props: TODO) {\n const { data } = await client.post<TODO>('getStripePaymentIntent', props);\n return data\n}\n","import { client } from '../../client';\nimport { TODO } from '../../types';\n\n/**\n * Method summary - General information about the SDK method, usually a single sentence.\n * \n * @remarks\n * In this section, we have been adding detailed information such as:\n * * what API middleware endpoint this method is calling,\n * * what SAP OCC API endpoints are being called as a result of using this method,\n * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),\n * * simply everything what helps with understanding how it works.\n * \n * @param props\n * Just like our API methods, our SDK connector methods accept a single props parameter which carries relevant sub-properties. Therefore, there isn’t much to be described within that TSDoc section.\n * \n * @returns\n * Human-friendly information what the SDK methods returns.\n * \n * @example\n * A short code snippet showing how to use the method. Usually we have more than one @example. We should strive for adding as many examples as possible here, with multiple param configurations.\n */\nexport async function getSortableAttributes(props: TODO) {\n const { data } = await client.post<TODO>('getSortableAttributes', props);\n return data\n}\n","import { client } from './client';\nimport { Options } from './types';\nimport * as methods from './methods/index';\n\n/**\n * Connector methods.\n */\ntype Methods = typeof methods;\n\n/**\n * Initialize the Blackfisk connector.\n */\nexport const blackfiskConnector = (options: Options): Methods => {\n client.defaults.baseURL = options.apiUrl;\n\n return methods;\n};\n","import { blackfiskConnector } from './connector';\nimport type { Options } from './types';\nimport type { Module } from '@vue-storefront/sdk';\n\n/**\n * Blackfisk module type.\n */\nexport interface BlackfiskModuleType extends Module {\n /**\n * The connector of the Blackfisk module.\n */\n connector: ReturnType<typeof blackfiskConnector>;\n}\n\n/**\n * Blackfisk module.\n */\nexport const blackfiskModule = (options: Options): BlackfiskModuleType => {\n return {\n connector: blackfiskConnector({\n apiUrl: options.apiUrl,\n }),\n utils: {},\n subscribers: {},\n }\n};\n\nexport { client } from './client';\n\nexport * from './types';\n"],"names":[],"mappings":";;MAEa,MAAM,GAAG,KAAK,CAAC,MAAM;;ACClC;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,oBAAoB,CAAC,KAAiC,EAAA;AAC1E,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA+B,sBAAsB,EAAE,KAAK,CAAC,CAAC;AAChG,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;;;;;AAsBG;AACI,eAAe,iBAAiB,CAAC,KAA8B,EAAA;AACpE,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAA4B,mBAAmB,EAAE,KAAK,CAAC,CAAC;AAC1F,IAAA,OAAO,IAAI,CAAA;AACb;;AC1BA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,kBAAkB,CAAC,KAAW,EAAA;;AAElD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,oBAAoB,EAAE,KAAK,CAAC,CAAC;AACtE,IAAA,OAAO,IAAI,CAAA;AACb;;ACvBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,eAAe,EAAE,KAAK,CAAC,CAAC;AACjE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,gBAAgB,CAAC,KAAW,EAAA;AAChD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AACpE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,OAAO,CAAC,KAAW,EAAA;AACvC,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,SAAS,EAAE,KAAK,CAAC,CAAC;AAC3D,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,cAAc,CAAC,KAAW,EAAA;AAC9C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAClE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,SAAS,CAAC,KAAW,EAAA;AACzC,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,WAAW,EAAE,KAAK,CAAC,CAAC;AAC7D,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,mBAAmB,CAAC,KAAW,EAAA;AACnD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,qBAAqB,EAAE,KAAK,CAAC,CAAC;AACvE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,iBAAiB,CAAC,KAAW,EAAA;AACjD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,mBAAmB,EAAE,KAAK,CAAC,CAAC;AACrE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,sBAAsB,CAAC,KAAW,EAAA;AACtD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,wBAAwB,EAAE,KAAK,CAAC,CAAC;AAC1E,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,qBAAqB,CAAC,KAAW,EAAA;AACrD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,uBAAuB,EAAE,KAAK,CAAC,CAAC;AACzE,IAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;;;;;;;;;;AChBA;;AAEG;AACI,MAAM,kBAAkB,GAAG,CAAC,OAAgB,KAAa;IAC9D,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;AAEzC,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;;ACFD;;AAEG;AACU,MAAA,eAAe,GAAG,CAAC,OAAgB,KAAyB;IACvE,OAAO;QACL,SAAS,EAAE,kBAAkB,CAAC;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;AACF,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,WAAW,EAAE,EAAE;KAChB,CAAA;AACH;;;;"}
@@ -0,0 +1,9 @@
1
+ import { Endpoints, Cart } from '../../types';
2
+ export interface clearCartParams {
3
+ id: number;
4
+ }
5
+ export interface clearCartResponse {
6
+ data: Cart;
7
+ }
8
+ export declare const clearCart: Endpoints['clearCart'];
9
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/clearCart/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAC9C,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;CACZ;AACD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,eAAO,MAAM,SAAS,EAAE,SAAS,CAAC,WAAW,CAa5C,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { Endpoints, Cart } from '../../types';
2
+ export interface getCartParams {
3
+ uuid: string;
4
+ debug?: boolean;
5
+ }
6
+ export interface getCartResponse {
7
+ data: Cart;
8
+ }
9
+ export declare const getCart: Endpoints['getCart'];
10
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getCart/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAC9C,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,SAAS,CAcxC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,WAAW,kCAAkC;IACjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,cAAc,CAAC,EAAE,kCAAkC,CAAC;IACpD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED,eAAO,MAAM,oBAAoB,EAAE,SAAS,CAAC,sBAAsB,CA0BlE,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,WAAW,kCAAkC;IACjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,0BAA0B;IACzC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,cAAc,CAAC,EAAE,kCAAkC,CAAC;IACpD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,GAAG,EAAE,CAAC;CACb;AAED,eAAO,MAAM,oBAAoB,EAAE,SAAS,CAAC,sBAAsB,CA2BlE,CAAC"}
@@ -0,0 +1,6 @@
1
+ import { Endpoints, Attribute } from '../../types';
2
+ export interface getSortableAttributesResponse {
3
+ data: Attribute[];
4
+ }
5
+ export declare const getSortableAttributes: Endpoints['getSortableAttributes'];
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getSortableAttributes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,SAAS,EAAE,CAAC;CACnB;AAED,eAAO,MAAM,qBAAqB,EAAE,SAAS,CAAC,uBAAuB,CAUpE,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { Endpoints } from '../../types';
2
+ export interface getStripePaymentIntentParams {
3
+ accountSiteCartId: number;
4
+ channelShippingTemplateId: number;
5
+ }
6
+ export interface getStripePaymentIntentResponse {
7
+ data: any;
8
+ }
9
+ export declare const getStripePaymentIntent: Endpoints['getStripePaymentIntent'];
10
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getStripePaymentIntent/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,MAAM,WAAW,4BAA4B;IAC3C,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yBAAyB,EAAE,MAAM,CAAC;CACnC;AACD,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,GAAG,CAAC;CACX;AAED,eAAO,MAAM,sBAAsB,EAAE,SAAS,CAAC,wBAAwB,CAetE,CAAC"}
@@ -0,0 +1,6 @@
1
+ import { Endpoints, ShippingMethod } from '../../types';
2
+ export interface loadShippingMethodsResponse {
3
+ data: ShippingMethod[];
4
+ }
5
+ export declare const loadShippingMethods: Endpoints['loadShippingMethods'];
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/loadShippingMethods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,cAAc,EAAE,CAAC;CACxB;AAED,eAAO,MAAM,mBAAmB,EAAE,SAAS,CAAC,qBAAqB,CAUhE,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/proxyInstantsearch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,GAAG,EAAE,CAAC;CAChB;AAED,eAAO,MAAM,kBAAkB,EAAE,SAAS,CAAC,oBAAoB,CAuC9D,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/proxyInstantsearch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,GAAG,EAAE,CAAC;CAChB;AAED,eAAO,MAAM,kBAAkB,EAAE,SAAS,CAAC,oBAAoB,CA8C9D,CAAC"}
@@ -0,0 +1,10 @@
1
+ import { Endpoints, Cart } from '../../types';
2
+ export interface setShippingMethodParams {
3
+ accountSiteCartId: number;
4
+ channelShippingTemplateId: number;
5
+ }
6
+ export interface setShippingMethodResponse {
7
+ data: Cart;
8
+ }
9
+ export declare const setShippingMethod: Endpoints['setShippingMethod'];
10
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/setShippingMethod/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAC9C,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,yBAAyB,EAAE,MAAM,CAAC;CACnC;AACD,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,mBAAmB,CAe5D,CAAC"}
@@ -0,0 +1,12 @@
1
+ import { Endpoints, Cart } from '../../types';
2
+ export interface upsertCartItemParams {
3
+ accountSiteCartId: number;
4
+ channelListingId: number;
5
+ title: string;
6
+ quantity: number;
7
+ }
8
+ export interface upsertCartItemResponse {
9
+ data: Cart;
10
+ }
11
+ export declare const upsertCartItem: Endpoints['upsertCartItem'];
12
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/upsertCartItem/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAC9C,MAAM,WAAW,oBAAoB;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,eAAO,MAAM,cAAc,EAAE,SAAS,CAAC,gBAAgB,CAiBtD,CAAC"}