@blackfisk/blackfisk-vue-storefront-sdk 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.cjs.js +106 -1
- package/lib/index.cjs.js.map +1 -1
- package/lib/index.es.js +106 -1
- package/lib/index.es.js.map +1 -1
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getCollection/index.d.ts +9 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getCollection/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts +2 -2
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts.map +1 -1
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing/index.d.ts +15 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/proxyInstantsearch/index.d.ts +6 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/proxyInstantsearch/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts +8 -1
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts.map +1 -1
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts +3 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts.map +1 -1
- package/lib/packages/api-client/src/api/getCollection/index.d.ts +9 -0
- package/lib/packages/api-client/src/api/getCollection/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/api/getProductCollection/index.d.ts +14 -0
- package/lib/packages/api-client/src/api/getProductCollection/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/api/getProductListing/index.d.ts +15 -0
- package/lib/packages/api-client/src/api/getProductListing/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/api/proxyInstantsearch/index.d.ts +6 -0
- package/lib/packages/api-client/src/api/proxyInstantsearch/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/types/api/endpoints.d.ts +20 -0
- package/lib/packages/api-client/src/types/api/endpoints.d.ts.map +1 -0
- package/lib/packages/api-client/src/types/api/index.d.ts +65 -0
- package/lib/packages/api-client/src/types/api/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/types/config/index.d.ts +15 -0
- package/lib/packages/api-client/src/types/config/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/types/context/index.d.ts +14 -0
- package/lib/packages/api-client/src/types/context/index.d.ts.map +1 -0
- package/lib/packages/api-client/src/types/index.d.ts +12 -0
- package/lib/packages/api-client/src/types/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/index.d.ts +1 -1
- package/lib/packages/sdk/src/methods/getCollection/index.d.ts +22 -0
- package/lib/packages/sdk/src/methods/getCollection/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/methods/getProductFacets/index.d.ts +22 -0
- package/lib/packages/sdk/src/methods/getProductFacets/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/methods/getProductListing/index.d.ts +26 -0
- package/lib/packages/sdk/src/methods/getProductListing/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/methods/index.d.ts +4 -0
- package/lib/packages/sdk/src/methods/index.d.ts.map +1 -1
- package/lib/packages/sdk/src/methods/proxyInstantsearch/index.d.ts +22 -0
- package/lib/packages/sdk/src/methods/proxyInstantsearch/index.d.ts.map +1 -0
- package/lib/utils/elasticsearch/productGroup.d.ts +23 -0
- package/lib/utils/elasticsearch/productGroup.d.ts.map +1 -0
- package/package.json +3 -3
package/lib/index.cjs.js
CHANGED
|
@@ -38,9 +38,114 @@ async function getProductCollection(props) {
|
|
|
38
38
|
return data;
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
+
/**
|
|
42
|
+
* Executes a collection template chain against Elasticsearch - returning a collection of products.
|
|
43
|
+
*
|
|
44
|
+
* @remarks
|
|
45
|
+
* * API middleware endpoint: /getProductListing
|
|
46
|
+
* * Blackfisk endpoint: /v2/vsf/product/variations
|
|
47
|
+
* * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.
|
|
48
|
+
*
|
|
49
|
+
* @param props
|
|
50
|
+
*
|
|
51
|
+
* Required
|
|
52
|
+
* * collectionId
|
|
53
|
+
* * [familyId || channelListingId]
|
|
54
|
+
*
|
|
55
|
+
* Optional -
|
|
56
|
+
* * debug: boolean
|
|
57
|
+
*
|
|
58
|
+
* @returns
|
|
59
|
+
* An array of SearchProduct objects.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })
|
|
63
|
+
*/
|
|
64
|
+
async function getProductListing(props) {
|
|
65
|
+
const { data } = await client.post('getProductListing', props);
|
|
66
|
+
return data;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
71
|
+
*
|
|
72
|
+
* @remarks
|
|
73
|
+
* In this section, we have been adding detailed information such as:
|
|
74
|
+
* * what API middleware endpoint this method is calling,
|
|
75
|
+
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
76
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
77
|
+
* * simply everything what helps with understanding how it works.
|
|
78
|
+
*
|
|
79
|
+
* @param props
|
|
80
|
+
* 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.
|
|
81
|
+
*
|
|
82
|
+
* @returns
|
|
83
|
+
* Human-friendly information what the SDK methods returns.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* 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.
|
|
87
|
+
*/
|
|
88
|
+
async function proxyInstantsearch(props) {
|
|
89
|
+
// console.log('sdk props', props)
|
|
90
|
+
const { data } = await client.post('proxyInstantsearch', props);
|
|
91
|
+
return data;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
96
|
+
*
|
|
97
|
+
* @remarks
|
|
98
|
+
* In this section, we have been adding detailed information such as:
|
|
99
|
+
* * what API middleware endpoint this method is calling,
|
|
100
|
+
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
101
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
102
|
+
* * simply everything what helps with understanding how it works.
|
|
103
|
+
*
|
|
104
|
+
* @param props
|
|
105
|
+
* 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.
|
|
106
|
+
*
|
|
107
|
+
* @returns
|
|
108
|
+
* Human-friendly information what the SDK methods returns.
|
|
109
|
+
*
|
|
110
|
+
* @example
|
|
111
|
+
* 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.
|
|
112
|
+
*/
|
|
113
|
+
async function getCollection(props) {
|
|
114
|
+
const { data } = await client.post('getCollection', props);
|
|
115
|
+
return data;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
120
|
+
*
|
|
121
|
+
* @remarks
|
|
122
|
+
* In this section, we have been adding detailed information such as:
|
|
123
|
+
* * API middleware endpoint: /getProductFacets
|
|
124
|
+
* * Blackfisk endpoint: /v2/vsf/product/facets
|
|
125
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
126
|
+
* * simply everything what helps with understanding how it works.
|
|
127
|
+
*
|
|
128
|
+
* @param props
|
|
129
|
+
* 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.
|
|
130
|
+
*
|
|
131
|
+
* @returns
|
|
132
|
+
* Human-friendly information what the SDK methods returns.
|
|
133
|
+
*
|
|
134
|
+
* @example
|
|
135
|
+
* 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.
|
|
136
|
+
*/
|
|
137
|
+
async function getProductFacets(props) {
|
|
138
|
+
const { data } = await client.post('getProductFacets', props);
|
|
139
|
+
return data;
|
|
140
|
+
}
|
|
141
|
+
|
|
41
142
|
var methods = /*#__PURE__*/Object.freeze({
|
|
42
143
|
__proto__: null,
|
|
43
|
-
getProductCollection: getProductCollection
|
|
144
|
+
getProductCollection: getProductCollection,
|
|
145
|
+
getProductListing: getProductListing,
|
|
146
|
+
proxyInstantsearch: proxyInstantsearch,
|
|
147
|
+
getCollection: getCollection,
|
|
148
|
+
getProductFacets: getProductFacets
|
|
44
149
|
});
|
|
45
150
|
|
|
46
151
|
/**
|
package/lib/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/client/index.ts","../src/methods/getProductCollection/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 { 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 *
|
|
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;;;;;"}
|
package/lib/index.es.js
CHANGED
|
@@ -30,9 +30,114 @@ async function getProductCollection(props) {
|
|
|
30
30
|
return data;
|
|
31
31
|
}
|
|
32
32
|
|
|
33
|
+
/**
|
|
34
|
+
* Executes a collection template chain against Elasticsearch - returning a collection of products.
|
|
35
|
+
*
|
|
36
|
+
* @remarks
|
|
37
|
+
* * API middleware endpoint: /getProductListing
|
|
38
|
+
* * Blackfisk endpoint: /v2/vsf/product/variations
|
|
39
|
+
* * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.
|
|
40
|
+
*
|
|
41
|
+
* @param props
|
|
42
|
+
*
|
|
43
|
+
* Required
|
|
44
|
+
* * collectionId
|
|
45
|
+
* * [familyId || channelListingId]
|
|
46
|
+
*
|
|
47
|
+
* Optional -
|
|
48
|
+
* * debug: boolean
|
|
49
|
+
*
|
|
50
|
+
* @returns
|
|
51
|
+
* An array of SearchProduct objects.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })
|
|
55
|
+
*/
|
|
56
|
+
async function getProductListing(props) {
|
|
57
|
+
const { data } = await client.post('getProductListing', props);
|
|
58
|
+
return data;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
63
|
+
*
|
|
64
|
+
* @remarks
|
|
65
|
+
* In this section, we have been adding detailed information such as:
|
|
66
|
+
* * what API middleware endpoint this method is calling,
|
|
67
|
+
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
68
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
69
|
+
* * simply everything what helps with understanding how it works.
|
|
70
|
+
*
|
|
71
|
+
* @param props
|
|
72
|
+
* 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.
|
|
73
|
+
*
|
|
74
|
+
* @returns
|
|
75
|
+
* Human-friendly information what the SDK methods returns.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* 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.
|
|
79
|
+
*/
|
|
80
|
+
async function proxyInstantsearch(props) {
|
|
81
|
+
// console.log('sdk props', props)
|
|
82
|
+
const { data } = await client.post('proxyInstantsearch', props);
|
|
83
|
+
return data;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
88
|
+
*
|
|
89
|
+
* @remarks
|
|
90
|
+
* In this section, we have been adding detailed information such as:
|
|
91
|
+
* * what API middleware endpoint this method is calling,
|
|
92
|
+
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
93
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
94
|
+
* * simply everything what helps with understanding how it works.
|
|
95
|
+
*
|
|
96
|
+
* @param props
|
|
97
|
+
* 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.
|
|
98
|
+
*
|
|
99
|
+
* @returns
|
|
100
|
+
* Human-friendly information what the SDK methods returns.
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* 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.
|
|
104
|
+
*/
|
|
105
|
+
async function getCollection(props) {
|
|
106
|
+
const { data } = await client.post('getCollection', props);
|
|
107
|
+
return data;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
112
|
+
*
|
|
113
|
+
* @remarks
|
|
114
|
+
* In this section, we have been adding detailed information such as:
|
|
115
|
+
* * API middleware endpoint: /getProductFacets
|
|
116
|
+
* * Blackfisk endpoint: /v2/vsf/product/facets
|
|
117
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
118
|
+
* * simply everything what helps with understanding how it works.
|
|
119
|
+
*
|
|
120
|
+
* @param props
|
|
121
|
+
* 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.
|
|
122
|
+
*
|
|
123
|
+
* @returns
|
|
124
|
+
* Human-friendly information what the SDK methods returns.
|
|
125
|
+
*
|
|
126
|
+
* @example
|
|
127
|
+
* 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.
|
|
128
|
+
*/
|
|
129
|
+
async function getProductFacets(props) {
|
|
130
|
+
const { data } = await client.post('getProductFacets', props);
|
|
131
|
+
return data;
|
|
132
|
+
}
|
|
133
|
+
|
|
33
134
|
var methods = /*#__PURE__*/Object.freeze({
|
|
34
135
|
__proto__: null,
|
|
35
|
-
getProductCollection: getProductCollection
|
|
136
|
+
getProductCollection: getProductCollection,
|
|
137
|
+
getProductListing: getProductListing,
|
|
138
|
+
proxyInstantsearch: proxyInstantsearch,
|
|
139
|
+
getCollection: getCollection,
|
|
140
|
+
getProductFacets: getProductFacets
|
|
36
141
|
});
|
|
37
142
|
|
|
38
143
|
/**
|
package/lib/index.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.es.js","sources":["../src/client/index.ts","../src/methods/getProductCollection/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 { 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 *
|
|
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;;;;"}
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getCollection/index.d.ts
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Endpoints } from '../../types';
|
|
2
|
+
export interface getCollectionParams {
|
|
3
|
+
collectionId: number;
|
|
4
|
+
}
|
|
5
|
+
export interface getCollectionResponse {
|
|
6
|
+
data: any;
|
|
7
|
+
}
|
|
8
|
+
export declare const getCollection: Endpoints['getCollection'];
|
|
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/getCollection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,GAAG,CAAA;CACV;AACD,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,eAAe,CAcpD,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Endpoints
|
|
1
|
+
import { Endpoints } from '../../types';
|
|
2
2
|
export interface getProductCollectionTemplateParams {
|
|
3
3
|
[key: string]: any;
|
|
4
4
|
}
|
|
@@ -8,7 +8,7 @@ export interface getProductCollectionParams {
|
|
|
8
8
|
debug?: boolean;
|
|
9
9
|
}
|
|
10
10
|
export interface getProductCollectionResponse {
|
|
11
|
-
data:
|
|
11
|
+
data: any[];
|
|
12
12
|
}
|
|
13
13
|
export declare const getProductCollection: Endpoints['getProductCollection'];
|
|
14
14
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -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,
|
|
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,15 @@
|
|
|
1
|
+
import { Endpoints, ProductListing } from '../../types';
|
|
2
|
+
export interface getProductListingTemplateParams {
|
|
3
|
+
[key: string]: any;
|
|
4
|
+
}
|
|
5
|
+
export interface getProductListingParams {
|
|
6
|
+
collectionId: number | string;
|
|
7
|
+
familyId: number | string;
|
|
8
|
+
channelListingId: number | string;
|
|
9
|
+
debug?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export interface getProductListingResponse {
|
|
12
|
+
data: ProductListing[];
|
|
13
|
+
}
|
|
14
|
+
export declare const getProductListing: Endpoints['getProductListing'];
|
|
15
|
+
//# 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/getProductListing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,MAAM,WAAW,+BAA+B;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,cAAc,EAAE,CAAC;CACxB;AACD,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,mBAAmB,CAiB5D,CAAC"}
|
|
@@ -0,0 +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"}
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
|
-
import { BfskIntegrationContext } from '..';
|
|
1
|
+
import { BfskIntegrationContext, TODO } from '..';
|
|
2
2
|
import { getProductCollectionParams, getProductCollectionResponse } from '../../api/getProductCollection/index';
|
|
3
|
+
import { getProductListingParams, getProductListingResponse } from '../../api/getProductListing/index';
|
|
4
|
+
import { proxyInstantsearchResponse } from '../../api/proxyInstantsearch/index';
|
|
5
|
+
import { getCollectionParams, getCollectionResponse } from '../../api/getCollection/index';
|
|
3
6
|
/**
|
|
4
7
|
* Definition of all API-client methods available in {@link https://docs.vuestorefront.io/v2/advanced/context.html#context-api | context}.
|
|
5
8
|
*/
|
|
@@ -9,5 +12,9 @@ export interface Endpoints {
|
|
|
9
12
|
* This description will appear in the API extractor, so try to document all endpoints added here.
|
|
10
13
|
*/
|
|
11
14
|
getProductCollection(context: BfskIntegrationContext, params: getProductCollectionParams): Promise<getProductCollectionResponse>;
|
|
15
|
+
getProductListing(context: BfskIntegrationContext, params: getProductListingParams): Promise<getProductListingResponse>;
|
|
16
|
+
proxyInstantsearch(context: BfskIntegrationContext, params: any): Promise<proxyInstantsearchResponse>;
|
|
17
|
+
getCollection(context: BfskIntegrationContext, params: getCollectionParams): Promise<getCollectionResponse>;
|
|
18
|
+
getProductFacets(context: BfskIntegrationContext, params: TODO): Promise<TODO>;
|
|
12
19
|
}
|
|
13
20
|
//# sourceMappingURL=endpoints.d.ts.map
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,
|
|
1
|
+
{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,IAAI,CAAA;AACjD,OAAO,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAA;AAC/G,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA;AACtG,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAE1F;;GAEG;AACH,MAAM,WAAW,SAAS;IAExB;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;IACjI,iBAAiB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACxH,kBAAkB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACtG,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5G,gBAAgB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChF"}
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,sBAAsB,EAAE,CAAC;IACjC,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC/B,cAAc,EAAE,sBAAsB,EAAE,CAAC;IACzC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC;AACD,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,WAAW,iBAAiB;CAAG;AACrC,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE,2BAA2B,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,EAAE,CAAC;IACX,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,iBAAiB,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AACD,cAAc,aAAa,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,sBAAsB,EAAE,CAAC;IACjC,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC/B,cAAc,EAAE,sBAAsB,EAAE,CAAC;IACzC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC;AACD,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,WAAW,iBAAiB;CAAG;AACrC,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE,2BAA2B,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,EAAE,CAAC;IACX,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,iBAAiB,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,cAAc,aAAa,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Endpoints } from '../../types';
|
|
2
|
+
export interface getCollectionParams {
|
|
3
|
+
collectionId: number;
|
|
4
|
+
}
|
|
5
|
+
export interface getCollectionResponse {
|
|
6
|
+
data: any;
|
|
7
|
+
}
|
|
8
|
+
export declare const getCollection: Endpoints['getCollection'];
|
|
9
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/src/api/getCollection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,MAAM,CAAA;CACrB;AACD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,GAAG,CAAA;CACV;AACD,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,eAAe,CAcpD,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Endpoints } from '../../types';
|
|
2
|
+
export interface getProductCollectionTemplateParams {
|
|
3
|
+
[key: string]: any;
|
|
4
|
+
}
|
|
5
|
+
export interface getProductCollectionParams {
|
|
6
|
+
collectionId: number | string;
|
|
7
|
+
templateParams?: getProductCollectionTemplateParams;
|
|
8
|
+
debug?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface getProductCollectionResponse {
|
|
11
|
+
data: any[];
|
|
12
|
+
}
|
|
13
|
+
export declare const getProductCollection: Endpoints['getProductCollection'];
|
|
14
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/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,15 @@
|
|
|
1
|
+
import { Endpoints, ProductListing } from '../../types';
|
|
2
|
+
export interface getProductListingTemplateParams {
|
|
3
|
+
[key: string]: any;
|
|
4
|
+
}
|
|
5
|
+
export interface getProductListingParams {
|
|
6
|
+
collectionId: number | string;
|
|
7
|
+
familyId: number | string;
|
|
8
|
+
channelListingId: number | string;
|
|
9
|
+
debug?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export interface getProductListingResponse {
|
|
12
|
+
data: ProductListing[];
|
|
13
|
+
}
|
|
14
|
+
export declare const getProductListing: Endpoints['getProductListing'];
|
|
15
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/src/api/getProductListing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACxD,MAAM,WAAW,+BAA+B;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,MAAM,WAAW,uBAAuB;IACtC,YAAY,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AACD,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,cAAc,EAAE,CAAC;CACxB;AACD,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,mBAAmB,CAiB5D,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/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"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { BfskIntegrationContext, TODO } from '..';
|
|
2
|
+
import { getProductCollectionParams, getProductCollectionResponse } from '../../api/getProductCollection/index';
|
|
3
|
+
import { getProductListingParams, getProductListingResponse } from '../../api/getProductListing/index';
|
|
4
|
+
import { proxyInstantsearchResponse } from '../../api/proxyInstantsearch/index';
|
|
5
|
+
import { getCollectionParams, getCollectionResponse } from '../../api/getCollection/index';
|
|
6
|
+
/**
|
|
7
|
+
* Definition of all API-client methods available in {@link https://docs.vuestorefront.io/v2/advanced/context.html#context-api | context}.
|
|
8
|
+
*/
|
|
9
|
+
export interface Endpoints {
|
|
10
|
+
/**
|
|
11
|
+
* Here you can find an example endpoint definition. Based on this example, you should define how your endpoint will look like.
|
|
12
|
+
* This description will appear in the API extractor, so try to document all endpoints added here.
|
|
13
|
+
*/
|
|
14
|
+
getProductCollection(context: BfskIntegrationContext, params: getProductCollectionParams): Promise<getProductCollectionResponse>;
|
|
15
|
+
getProductListing(context: BfskIntegrationContext, params: getProductListingParams): Promise<getProductListingResponse>;
|
|
16
|
+
proxyInstantsearch(context: BfskIntegrationContext, params: any): Promise<proxyInstantsearchResponse>;
|
|
17
|
+
getCollection(context: BfskIntegrationContext, params: getCollectionParams): Promise<getCollectionResponse>;
|
|
18
|
+
getProductFacets(context: BfskIntegrationContext, params: TODO): Promise<TODO>;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=endpoints.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/src/types/api/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,IAAI,CAAA;AACjD,OAAO,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAA;AAC/G,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA;AACtG,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAA;AAE1F;;GAEG;AACH,MAAM,WAAW,SAAS;IAExB;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;IACjI,iBAAiB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACxH,kBAAkB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACtG,aAAa,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC5G,gBAAgB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChF"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
export interface SearchProductAttribute {
|
|
2
|
+
id: number;
|
|
3
|
+
name: string;
|
|
4
|
+
valueJSON: string;
|
|
5
|
+
}
|
|
6
|
+
export interface SearchProductAttributeTypes {
|
|
7
|
+
facets: SearchProductAttribute[];
|
|
8
|
+
misc: SearchProductAttribute[];
|
|
9
|
+
specifications: SearchProductAttribute[];
|
|
10
|
+
variants: SearchProductAttribute[];
|
|
11
|
+
}
|
|
12
|
+
export interface SearchProductCondition {
|
|
13
|
+
id: number;
|
|
14
|
+
name: string;
|
|
15
|
+
description: string;
|
|
16
|
+
}
|
|
17
|
+
export interface SearchProductImage {
|
|
18
|
+
url: string;
|
|
19
|
+
public_id: string;
|
|
20
|
+
isPrimary: number;
|
|
21
|
+
alt: string;
|
|
22
|
+
}
|
|
23
|
+
export interface SearchProductMeta {
|
|
24
|
+
}
|
|
25
|
+
export interface SearchProduct {
|
|
26
|
+
id: number;
|
|
27
|
+
accountId: number;
|
|
28
|
+
attributeListValues: string[];
|
|
29
|
+
attributeValues: string[];
|
|
30
|
+
attributes: SearchProductAttributeTypes;
|
|
31
|
+
brandId: number;
|
|
32
|
+
brandName: string;
|
|
33
|
+
categories: string[];
|
|
34
|
+
categoryIds: number[];
|
|
35
|
+
categoryName: string;
|
|
36
|
+
channelId: number;
|
|
37
|
+
colors: [];
|
|
38
|
+
condition: SearchProductCondition;
|
|
39
|
+
description: string;
|
|
40
|
+
familyId: number;
|
|
41
|
+
features: string[];
|
|
42
|
+
heading: string;
|
|
43
|
+
images: SearchProductImage[];
|
|
44
|
+
imagesCount: number;
|
|
45
|
+
isAvailable: boolean;
|
|
46
|
+
keywords: string[];
|
|
47
|
+
meta: SearchProductMeta;
|
|
48
|
+
metaDescription: string;
|
|
49
|
+
mpn: string;
|
|
50
|
+
parentName: string;
|
|
51
|
+
priceMAP: number;
|
|
52
|
+
priceSale: number;
|
|
53
|
+
pricingStrategy: string;
|
|
54
|
+
productName: string;
|
|
55
|
+
quantity: number;
|
|
56
|
+
sku: string;
|
|
57
|
+
slug: string;
|
|
58
|
+
title: string;
|
|
59
|
+
upc: string;
|
|
60
|
+
}
|
|
61
|
+
export interface ProductListing {
|
|
62
|
+
[key: string]: any;
|
|
63
|
+
}
|
|
64
|
+
export * from './endpoints';
|
|
65
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/src/types/api/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AACD,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,sBAAsB,EAAE,CAAC;IACjC,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC/B,cAAc,EAAE,sBAAsB,EAAE,CAAC;IACzC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC;AACD,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,WAAW,iBAAiB;CAAG;AACrC,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE,2BAA2B,CAAC;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,EAAE,CAAC;IACX,SAAS,EAAE,sBAAsB,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,EAAE,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,iBAAiB,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AACD,cAAc,aAAa,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Settings to be provided in the `middleware.config.js` file.
|
|
3
|
+
*/
|
|
4
|
+
interface ApiMiddlewareConfig {
|
|
5
|
+
url: string;
|
|
6
|
+
auth_jwt: string;
|
|
7
|
+
}
|
|
8
|
+
export interface MiddlewareConfig {
|
|
9
|
+
accountId: number;
|
|
10
|
+
channelId: number;
|
|
11
|
+
accountSiteId: number;
|
|
12
|
+
api: ApiMiddlewareConfig;
|
|
13
|
+
}
|
|
14
|
+
export {};
|
|
15
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/src/types/config/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,mBAAmB;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,gBAAgB;IAE/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE,mBAAmB,CAAC;CAC1B"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { IntegrationContext } from '@vue-storefront/middleware';
|
|
2
|
+
import { AxiosInstance } from 'axios';
|
|
3
|
+
import { MiddlewareConfig, ContextualizedEndpoints } from '../index';
|
|
4
|
+
/**
|
|
5
|
+
* Runtime integration context, which includes API client instance, settings, and endpoints that will be passed via middleware server.
|
|
6
|
+
**/
|
|
7
|
+
export declare type BfskIntegrationContext = IntegrationContext<AxiosInstance, MiddlewareConfig, ContextualizedEndpoints>;
|
|
8
|
+
/**
|
|
9
|
+
* Global context of the application which includes runtime integration context.
|
|
10
|
+
**/
|
|
11
|
+
export interface Context {
|
|
12
|
+
$bfsk: BfskIntegrationContext;
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/src/types/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAErE;;IAEI;AACJ,oBAAY,sBAAsB,GAAG,kBAAkB,CACrD,aAAa,EACb,gBAAgB,EAChB,uBAAuB,CACxB,CAAC;AAEF;;IAEI;AACJ,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,sBAAsB,CAAC;CAC/B"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Endpoints } from './api';
|
|
2
|
+
/**
|
|
3
|
+
* All available API Endpoints without first argument - `context`, because this prop is set automatically.
|
|
4
|
+
*/
|
|
5
|
+
export declare type ContextualizedEndpoints = {
|
|
6
|
+
[T in keyof Endpoints]: Endpoints[T] extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
|
|
7
|
+
};
|
|
8
|
+
export declare type TODO = any;
|
|
9
|
+
export * from './api';
|
|
10
|
+
export * from './config';
|
|
11
|
+
export * from './context';
|
|
12
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../api-client/src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC;;GAEG;AACH,oBAAY,uBAAuB,GAAG;KACnC,CAAC,IAAI,MAAM,SAAS,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAC3C,CAAC,EAAE,GAAG,EACN,GAAG,IAAI,EAAE,MAAM,CAAC,KACb,MAAM,CAAC,GACR,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GACjB,KAAK;CACV,CAAC;AAEF,oBAAY,IAAI,GAAG,GAAG,CAAC;AAEvB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}
|
|
@@ -2,7 +2,7 @@ import { blackfiskConnector } from './connector';
|
|
|
2
2
|
import type { Options } from './types';
|
|
3
3
|
import type { Module } from '@vue-storefront/sdk';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Blackfisk module type.
|
|
6
6
|
*/
|
|
7
7
|
export interface BlackfiskModuleType extends Module {
|
|
8
8
|
/**
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { TODO } from '../../types';
|
|
2
|
+
/**
|
|
3
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* In this section, we have been adding detailed information such as:
|
|
7
|
+
* * what API middleware endpoint this method is calling,
|
|
8
|
+
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
9
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
10
|
+
* * simply everything what helps with understanding how it works.
|
|
11
|
+
*
|
|
12
|
+
* @param props
|
|
13
|
+
* 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.
|
|
14
|
+
*
|
|
15
|
+
* @returns
|
|
16
|
+
* Human-friendly information what the SDK methods returns.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* 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.
|
|
20
|
+
*/
|
|
21
|
+
export declare function getCollection(props: TODO): Promise<any>;
|
|
22
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/methods/getCollection/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,IAAI,gBAG9C"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { TODO } from '../../types';
|
|
2
|
+
/**
|
|
3
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* In this section, we have been adding detailed information such as:
|
|
7
|
+
* * API middleware endpoint: /getProductFacets
|
|
8
|
+
* * Blackfisk endpoint: /v2/vsf/product/facets
|
|
9
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
10
|
+
* * simply everything what helps with understanding how it works.
|
|
11
|
+
*
|
|
12
|
+
* @param props
|
|
13
|
+
* 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.
|
|
14
|
+
*
|
|
15
|
+
* @returns
|
|
16
|
+
* Human-friendly information what the SDK methods returns.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* 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.
|
|
20
|
+
*/
|
|
21
|
+
export declare function getProductFacets(props: TODO): Promise<any>;
|
|
22
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/methods/getProductFacets/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,gBAAgB,CAAC,KAAK,EAAE,IAAI,gBAGjD"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { getProductListingParams, getProductListingResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductListing';
|
|
2
|
+
/**
|
|
3
|
+
* Executes a collection template chain against Elasticsearch - returning a collection of products.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* * API middleware endpoint: /getProductListing
|
|
7
|
+
* * Blackfisk endpoint: /v2/vsf/product/variations
|
|
8
|
+
* * Any authenticated client can make this call. A collectionId and either (a familyId, channelListingId, or both) must be provided.
|
|
9
|
+
*
|
|
10
|
+
* @param props
|
|
11
|
+
*
|
|
12
|
+
* Required
|
|
13
|
+
* * collectionId
|
|
14
|
+
* * [familyId || channelListingId]
|
|
15
|
+
*
|
|
16
|
+
* Optional -
|
|
17
|
+
* * debug: boolean
|
|
18
|
+
*
|
|
19
|
+
* @returns
|
|
20
|
+
* An array of SearchProduct objects.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* const { data: ProductCollection } = await getProductListing({ collectionId: 98, familyId: 12345, debug: true })
|
|
24
|
+
*/
|
|
25
|
+
export declare function getProductListing(props: getProductListingParams): Promise<getProductListingResponse>;
|
|
26
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/methods/getProductListing/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,mEAAmE,CAAA;AAEtI;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CAAC,KAAK,EAAE,uBAAuB,sCAGrE"}
|
|
@@ -1,2 +1,6 @@
|
|
|
1
1
|
export { getProductCollection } from './getProductCollection';
|
|
2
|
+
export { getProductListing } from './getProductListing';
|
|
3
|
+
export { proxyInstantsearch } from './proxyInstantsearch';
|
|
4
|
+
export { getCollection } from './getCollection';
|
|
5
|
+
export { getProductFacets } from './getProductFacets';
|
|
2
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { TODO } from '../../types';
|
|
2
|
+
/**
|
|
3
|
+
* Method summary - General information about the SDK method, usually a single sentence.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* In this section, we have been adding detailed information such as:
|
|
7
|
+
* * what API middleware endpoint this method is calling,
|
|
8
|
+
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
9
|
+
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
10
|
+
* * simply everything what helps with understanding how it works.
|
|
11
|
+
*
|
|
12
|
+
* @param props
|
|
13
|
+
* 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.
|
|
14
|
+
*
|
|
15
|
+
* @returns
|
|
16
|
+
* Human-friendly information what the SDK methods returns.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* 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.
|
|
20
|
+
*/
|
|
21
|
+
export declare function proxyInstantsearch(props: TODO): Promise<any>;
|
|
22
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/methods/proxyInstantsearch/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,kBAAkB,CAAC,KAAK,EAAE,IAAI,gBAInD"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface DisplayProductImage {
|
|
2
|
+
src: string;
|
|
3
|
+
url: string;
|
|
4
|
+
alt: string;
|
|
5
|
+
}
|
|
6
|
+
export interface DisplayProduct {
|
|
7
|
+
id: number;
|
|
8
|
+
slug: string;
|
|
9
|
+
name: string;
|
|
10
|
+
groupId: number;
|
|
11
|
+
price: string;
|
|
12
|
+
img: DisplayProductImage;
|
|
13
|
+
}
|
|
14
|
+
export interface DisplayProductGroup {
|
|
15
|
+
groupId: number;
|
|
16
|
+
groupName: string;
|
|
17
|
+
brandName: string;
|
|
18
|
+
groupPriceLow: number;
|
|
19
|
+
groupPriceHigh: number;
|
|
20
|
+
products: DisplayProduct[];
|
|
21
|
+
}
|
|
22
|
+
export declare const groupProductResult: (ProductResult: any) => unknown[];
|
|
23
|
+
//# sourceMappingURL=productGroup.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"productGroup.d.ts","sourceRoot":"","sources":["../../../../../utils/elasticsearch/productGroup.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AACD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,mBAAmB,CAAC;CAC1B;AACD,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AACD,eAAO,MAAM,kBAAkB,mCAmF9B,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blackfisk/blackfisk-vue-storefront-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.6",
|
|
4
4
|
"main": "lib/index.cjs.js",
|
|
5
5
|
"module": "lib/index.es.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -23,11 +23,11 @@
|
|
|
23
23
|
"axios": "^0.27.2"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"@blackfisk/blackfisk-vue-storefront-api": "^1.0.
|
|
26
|
+
"@blackfisk/blackfisk-vue-storefront-api": "^1.0.6",
|
|
27
27
|
"@vue-storefront/sdk": "1.0.1",
|
|
28
28
|
"msw": "^0.47.3",
|
|
29
29
|
"nock": "^13.2.9",
|
|
30
30
|
"rollup-plugin-typescript2": "^0.34.1"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "d644c181a9276e1f6613eb0a7afd252077bedf55"
|
|
33
33
|
}
|