@blackfisk/blackfisk-vue-storefront-sdk 1.0.2 → 1.0.4
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/License.md +21 -0
- package/lib/index.cjs.js +17 -63
- package/lib/index.cjs.js.map +1 -1
- package/lib/index.es.js +17 -63
- package/lib/index.es.js.map +1 -1
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts +14 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts +13 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts +62 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/config/index.d.ts +15 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/config/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/context/index.d.ts +14 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/context/index.d.ts.map +1 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/index.d.ts +12 -0
- package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/api-extractor.data.d.ts.map +1 -0
- package/lib/packages/sdk/src/client/index.d.ts.map +1 -0
- package/lib/{connector.d.ts → packages/sdk/src/connector.d.ts} +2 -2
- package/lib/packages/sdk/src/connector.d.ts.map +1 -0
- package/lib/packages/sdk/src/index.d.ts +19 -0
- package/lib/packages/sdk/src/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/methods/getProductCollection/index.d.ts +26 -0
- package/lib/packages/sdk/src/methods/getProductCollection/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/methods/index.d.ts +2 -0
- package/lib/packages/sdk/src/methods/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/types/MethodOptions.d.ts.map +1 -0
- package/lib/packages/sdk/src/types/index.d.ts.map +1 -0
- package/lib/packages/sdk/src/types/options.d.ts.map +1 -0
- package/package.json +3 -3
- package/lib/api-extractor.data.d.ts.map +0 -1
- package/lib/client/index.d.ts.map +0 -1
- package/lib/connector.d.ts.map +0 -1
- package/lib/index.d.ts +0 -19
- package/lib/index.d.ts.map +0 -1
- package/lib/methods/exampleMethod/index.d.ts +0 -22
- package/lib/methods/exampleMethod/index.d.ts.map +0 -1
- package/lib/methods/getPageContent/index.d.ts +0 -22
- package/lib/methods/getPageContent/index.d.ts.map +0 -1
- package/lib/methods/getProductCollection/index.d.ts +0 -22
- package/lib/methods/getProductCollection/index.d.ts.map +0 -1
- package/lib/methods/index.d.ts +0 -4
- package/lib/methods/index.d.ts.map +0 -1
- package/lib/types/MethodOptions.d.ts.map +0 -1
- package/lib/types/index.d.ts.map +0 -1
- package/lib/types/options.d.ts.map +0 -1
- /package/lib/{api-extractor.data.d.ts → packages/sdk/src/api-extractor.data.d.ts} +0 -0
- /package/lib/{client → packages/sdk/src/client}/index.d.ts +0 -0
- /package/lib/{types → packages/sdk/src/types}/MethodOptions.d.ts +0 -0
- /package/lib/{types → packages/sdk/src/types}/index.d.ts +0 -0
- /package/lib/{types → packages/sdk/src/types}/options.d.ts +0 -0
package/License.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Vue Storefront
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/lib/index.cjs.js
CHANGED
|
@@ -11,71 +11,27 @@ var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
|
|
|
11
11
|
const client = axios__default["default"].create();
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Executes a collection template chain against Elasticsearch - returning a collection of products.
|
|
15
15
|
*
|
|
16
16
|
* @remarks
|
|
17
|
-
*
|
|
18
|
-
* *
|
|
19
|
-
* *
|
|
20
|
-
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
21
|
-
* * simply everything what helps with understanding how it works.
|
|
17
|
+
* * API middleware endpoint: /getProductCollection
|
|
18
|
+
* * Blackfisk endpoint: /v2/vsf/productCollection
|
|
19
|
+
* * Any authenticated client can make this call. A collectionId must be provided.
|
|
22
20
|
*
|
|
23
21
|
* @param props
|
|
24
|
-
* 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.
|
|
25
22
|
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* @example
|
|
30
|
-
* 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.
|
|
31
|
-
*/
|
|
32
|
-
async function exampleMethod(props) {
|
|
33
|
-
const { data } = await client.post('exampleEndpoint', props);
|
|
34
|
-
return data;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Method summary - General information about the SDK method, usually a single sentence.
|
|
39
|
-
*
|
|
40
|
-
* @remarks
|
|
41
|
-
* In this section, we have been adding detailed information such as:
|
|
42
|
-
* * what API middleware endpoint this method is calling,
|
|
43
|
-
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
44
|
-
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
45
|
-
* * simply everything what helps with understanding how it works.
|
|
46
|
-
*
|
|
47
|
-
* @param props
|
|
48
|
-
* 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.
|
|
23
|
+
* Required
|
|
24
|
+
* * collectionId
|
|
49
25
|
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* @example
|
|
54
|
-
* 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.
|
|
55
|
-
*/
|
|
56
|
-
async function getPageContent(props) {
|
|
57
|
-
const { data } = await client.post('getPageContent', 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.
|
|
26
|
+
* Optional -
|
|
27
|
+
* * debug: boolean
|
|
28
|
+
* * templateParams: object with the keys required to populate the template chain for the specified collection.
|
|
73
29
|
*
|
|
74
30
|
* @returns
|
|
75
|
-
*
|
|
31
|
+
* An array of SearchProduct objects.
|
|
76
32
|
*
|
|
77
33
|
* @example
|
|
78
|
-
*
|
|
34
|
+
* const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })
|
|
79
35
|
*/
|
|
80
36
|
async function getProductCollection(props) {
|
|
81
37
|
const { data } = await client.post('getProductCollection', props);
|
|
@@ -84,25 +40,23 @@ async function getProductCollection(props) {
|
|
|
84
40
|
|
|
85
41
|
var methods = /*#__PURE__*/Object.freeze({
|
|
86
42
|
__proto__: null,
|
|
87
|
-
exampleMethod: exampleMethod,
|
|
88
|
-
getPageContent: getPageContent,
|
|
89
43
|
getProductCollection: getProductCollection
|
|
90
44
|
});
|
|
91
45
|
|
|
92
46
|
/**
|
|
93
|
-
* Initialize the
|
|
47
|
+
* Initialize the Blackfisk connector.
|
|
94
48
|
*/
|
|
95
|
-
const
|
|
49
|
+
const blackfiskConnector = (options) => {
|
|
96
50
|
client.defaults.baseURL = options.apiUrl;
|
|
97
51
|
return methods;
|
|
98
52
|
};
|
|
99
53
|
|
|
100
54
|
/**
|
|
101
|
-
*
|
|
55
|
+
* Blackfisk module.
|
|
102
56
|
*/
|
|
103
|
-
const
|
|
57
|
+
const blackfiskModule = (options) => {
|
|
104
58
|
return {
|
|
105
|
-
connector:
|
|
59
|
+
connector: blackfiskConnector({
|
|
106
60
|
apiUrl: options.apiUrl,
|
|
107
61
|
}),
|
|
108
62
|
utils: {},
|
|
@@ -110,6 +64,6 @@ const boilerplateModule = (options) => {
|
|
|
110
64
|
};
|
|
111
65
|
};
|
|
112
66
|
|
|
113
|
-
exports.
|
|
67
|
+
exports.blackfiskModule = blackfiskModule;
|
|
114
68
|
exports.client = client;
|
|
115
69
|
//# sourceMappingURL=index.cjs.js.map
|
package/lib/index.cjs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.cjs.js","sources":["../src/client/index.ts","../src/methods/
|
|
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 * Boulerplate 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;;;;;;;ACpBA;;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
|
@@ -3,71 +3,27 @@ import axios from 'axios';
|
|
|
3
3
|
const client = axios.create();
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Executes a collection template chain against Elasticsearch - returning a collection of products.
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
|
-
*
|
|
10
|
-
* *
|
|
11
|
-
* *
|
|
12
|
-
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
13
|
-
* * simply everything what helps with understanding how it works.
|
|
9
|
+
* * API middleware endpoint: /getProductCollection
|
|
10
|
+
* * Blackfisk endpoint: /v2/vsf/productCollection
|
|
11
|
+
* * Any authenticated client can make this call. A collectionId must be provided.
|
|
14
12
|
*
|
|
15
13
|
* @param props
|
|
16
|
-
* 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.
|
|
17
14
|
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* 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.
|
|
23
|
-
*/
|
|
24
|
-
async function exampleMethod(props) {
|
|
25
|
-
const { data } = await client.post('exampleEndpoint', props);
|
|
26
|
-
return data;
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* Method summary - General information about the SDK method, usually a single sentence.
|
|
31
|
-
*
|
|
32
|
-
* @remarks
|
|
33
|
-
* In this section, we have been adding detailed information such as:
|
|
34
|
-
* * what API middleware endpoint this method is calling,
|
|
35
|
-
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
36
|
-
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
37
|
-
* * simply everything what helps with understanding how it works.
|
|
38
|
-
*
|
|
39
|
-
* @param props
|
|
40
|
-
* 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.
|
|
15
|
+
* Required
|
|
16
|
+
* * collectionId
|
|
41
17
|
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* @example
|
|
46
|
-
* 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.
|
|
47
|
-
*/
|
|
48
|
-
async function getPageContent(props) {
|
|
49
|
-
const { data } = await client.post('getPageContent', props);
|
|
50
|
-
return data;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
/**
|
|
54
|
-
* Method summary - General information about the SDK method, usually a single sentence.
|
|
55
|
-
*
|
|
56
|
-
* @remarks
|
|
57
|
-
* In this section, we have been adding detailed information such as:
|
|
58
|
-
* * what API middleware endpoint this method is calling,
|
|
59
|
-
* * what SAP OCC API endpoints are being called as a result of using this method,
|
|
60
|
-
* * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
|
|
61
|
-
* * simply everything what helps with understanding how it works.
|
|
62
|
-
*
|
|
63
|
-
* @param props
|
|
64
|
-
* 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.
|
|
18
|
+
* Optional -
|
|
19
|
+
* * debug: boolean
|
|
20
|
+
* * templateParams: object with the keys required to populate the template chain for the specified collection.
|
|
65
21
|
*
|
|
66
22
|
* @returns
|
|
67
|
-
*
|
|
23
|
+
* An array of SearchProduct objects.
|
|
68
24
|
*
|
|
69
25
|
* @example
|
|
70
|
-
*
|
|
26
|
+
* const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })
|
|
71
27
|
*/
|
|
72
28
|
async function getProductCollection(props) {
|
|
73
29
|
const { data } = await client.post('getProductCollection', props);
|
|
@@ -76,25 +32,23 @@ async function getProductCollection(props) {
|
|
|
76
32
|
|
|
77
33
|
var methods = /*#__PURE__*/Object.freeze({
|
|
78
34
|
__proto__: null,
|
|
79
|
-
exampleMethod: exampleMethod,
|
|
80
|
-
getPageContent: getPageContent,
|
|
81
35
|
getProductCollection: getProductCollection
|
|
82
36
|
});
|
|
83
37
|
|
|
84
38
|
/**
|
|
85
|
-
* Initialize the
|
|
39
|
+
* Initialize the Blackfisk connector.
|
|
86
40
|
*/
|
|
87
|
-
const
|
|
41
|
+
const blackfiskConnector = (options) => {
|
|
88
42
|
client.defaults.baseURL = options.apiUrl;
|
|
89
43
|
return methods;
|
|
90
44
|
};
|
|
91
45
|
|
|
92
46
|
/**
|
|
93
|
-
*
|
|
47
|
+
* Blackfisk module.
|
|
94
48
|
*/
|
|
95
|
-
const
|
|
49
|
+
const blackfiskModule = (options) => {
|
|
96
50
|
return {
|
|
97
|
-
connector:
|
|
51
|
+
connector: blackfiskConnector({
|
|
98
52
|
apiUrl: options.apiUrl,
|
|
99
53
|
}),
|
|
100
54
|
utils: {},
|
|
@@ -102,5 +56,5 @@ const boilerplateModule = (options) => {
|
|
|
102
56
|
};
|
|
103
57
|
};
|
|
104
58
|
|
|
105
|
-
export {
|
|
59
|
+
export { blackfiskModule, client };
|
|
106
60
|
//# sourceMappingURL=index.es.js.map
|
package/lib/index.es.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.es.js","sources":["../src/client/index.ts","../src/methods/
|
|
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 * Boulerplate 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;;;;;;;ACpBA;;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,14 @@
|
|
|
1
|
+
import { Endpoints, SearchProduct } 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: SearchProduct[];
|
|
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":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACvD,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,aAAa,EAAE,CAAC;CACvB;AACD,eAAO,MAAM,oBAAoB,EAAE,SAAS,CAAC,sBAAsB,CA0BlE,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BfskIntegrationContext } from '..';
|
|
2
|
+
import { getProductCollectionParams, getProductCollectionResponse } from '../../api/getProductCollection/index';
|
|
3
|
+
/**
|
|
4
|
+
* Definition of all API-client methods available in {@link https://docs.vuestorefront.io/v2/advanced/context.html#context-api | context}.
|
|
5
|
+
*/
|
|
6
|
+
export interface Endpoints {
|
|
7
|
+
/**
|
|
8
|
+
* Here you can find an example endpoint definition. Based on this example, you should define how your endpoint will look like.
|
|
9
|
+
* This description will appear in the API extractor, so try to document all endpoints added here.
|
|
10
|
+
*/
|
|
11
|
+
getProductCollection(context: BfskIntegrationContext, params: getProductCollectionParams): Promise<getProductCollectionResponse>;
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=endpoints.d.ts.map
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts.map
ADDED
|
@@ -0,0 +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,EAAQ,MAAM,IAAI,CAAA;AACjD,OAAO,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAA;AAE/G;;GAEG;AACH,MAAM,WAAW,SAAS;IAExB;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,sBAAsB,EAAE,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;CAClI"}
|
|
@@ -0,0 +1,62 @@
|
|
|
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 * from './endpoints';
|
|
62
|
+
//# 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/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"}
|
|
@@ -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
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/config/index.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/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
|
package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/context/index.d.ts.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/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":["../../../../../../../../node_modules/@blackfisk/blackfisk-vue-storefront-api/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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-extractor.data.d.ts","sourceRoot":"","sources":["../../../../src/api-extractor.data.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/client/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,+BAAiB,CAAC"}
|
|
@@ -5,8 +5,8 @@ import * as methods from './methods/index';
|
|
|
5
5
|
*/
|
|
6
6
|
declare type Methods = typeof methods;
|
|
7
7
|
/**
|
|
8
|
-
* Initialize the
|
|
8
|
+
* Initialize the Blackfisk connector.
|
|
9
9
|
*/
|
|
10
|
-
export declare const
|
|
10
|
+
export declare const blackfiskConnector: (options: Options) => Methods;
|
|
11
11
|
export {};
|
|
12
12
|
//# sourceMappingURL=connector.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connector.d.ts","sourceRoot":"","sources":["../../../../src/connector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAE3C;;GAEG;AACH,aAAK,OAAO,GAAG,OAAO,OAAO,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,kBAAkB,YAAa,OAAO,KAAG,OAIrD,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { blackfiskConnector } from './connector';
|
|
2
|
+
import type { Options } from './types';
|
|
3
|
+
import type { Module } from '@vue-storefront/sdk';
|
|
4
|
+
/**
|
|
5
|
+
* Boulerplate module type.
|
|
6
|
+
*/
|
|
7
|
+
export interface BlackfiskModuleType extends Module {
|
|
8
|
+
/**
|
|
9
|
+
* The connector of the Blackfisk module.
|
|
10
|
+
*/
|
|
11
|
+
connector: ReturnType<typeof blackfiskConnector>;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Blackfisk module.
|
|
15
|
+
*/
|
|
16
|
+
export declare const blackfiskModule: (options: Options) => BlackfiskModuleType;
|
|
17
|
+
export { client } from './client';
|
|
18
|
+
export * from './types';
|
|
19
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,MAAM;IACjD;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC;CAClD;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,YAAa,OAAO,KAAG,mBAQlD,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,cAAc,SAAS,CAAC"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { getProductCollectionParams, getProductCollectionResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection';
|
|
2
|
+
/**
|
|
3
|
+
* Executes a collection template chain against Elasticsearch - returning a collection of products.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* * API middleware endpoint: /getProductCollection
|
|
7
|
+
* * Blackfisk endpoint: /v2/vsf/productCollection
|
|
8
|
+
* * Any authenticated client can make this call. A collectionId must be provided.
|
|
9
|
+
*
|
|
10
|
+
* @param props
|
|
11
|
+
*
|
|
12
|
+
* Required
|
|
13
|
+
* * collectionId
|
|
14
|
+
*
|
|
15
|
+
* Optional -
|
|
16
|
+
* * debug: boolean
|
|
17
|
+
* * templateParams: object with the keys required to populate the template chain for the specified collection.
|
|
18
|
+
*
|
|
19
|
+
* @returns
|
|
20
|
+
* An array of SearchProduct objects.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })
|
|
24
|
+
*/
|
|
25
|
+
export declare function getProductCollection(props: getProductCollectionParams): Promise<getProductCollectionResponse>;
|
|
26
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/methods/getProductCollection/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,4BAA4B,EAAE,MAAM,sEAAsE,CAAA;AAE/I;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,oBAAoB,CAAC,KAAK,EAAE,0BAA0B,yCAG3E"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MethodOptions.d.ts","sourceRoot":"","sources":["../../../../../src/types/MethodOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAElD;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/types/index.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI,GAAG,GAAG,CAAC;AAEvB,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../../src/types/options.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}
|
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.4",
|
|
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.4",
|
|
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": "be6d7a7b779ae7025136bd8e093ca3d2284f1a9d"
|
|
33
33
|
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"api-extractor.data.d.ts","sourceRoot":"","sources":["../src/api-extractor.data.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,+BAAiB,CAAC"}
|
package/lib/connector.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"connector.d.ts","sourceRoot":"","sources":["../src/connector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAE3C;;GAEG;AACH,aAAK,OAAO,GAAG,OAAO,OAAO,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,oBAAoB,YAAa,OAAO,KAAG,OAIvD,CAAC"}
|
package/lib/index.d.ts
DELETED
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { boilerplateConnector } from './connector';
|
|
2
|
-
import type { Options } from './types';
|
|
3
|
-
import type { Module } from '@vue-storefront/sdk';
|
|
4
|
-
/**
|
|
5
|
-
* Boulerplate module type.
|
|
6
|
-
*/
|
|
7
|
-
export interface BoilerplateModuleType extends Module {
|
|
8
|
-
/**
|
|
9
|
-
* The connector of the Boilerplate module.
|
|
10
|
-
*/
|
|
11
|
-
connector: ReturnType<typeof boilerplateConnector>;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Boilerplate module.
|
|
15
|
-
*/
|
|
16
|
-
export declare const boilerplateModule: (options: Options) => BoilerplateModuleType;
|
|
17
|
-
export { client } from './client';
|
|
18
|
-
export * from './types';
|
|
19
|
-
//# sourceMappingURL=index.d.ts.map
|
package/lib/index.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACnD;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;CACpD;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,YAAa,OAAO,KAAG,qBAQpD,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,cAAc,SAAS,CAAC"}
|
|
@@ -1,22 +0,0 @@
|
|
|
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 exampleMethod(props: TODO): Promise<any>;
|
|
22
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/methods/exampleMethod/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,IAAI,gBAG9C"}
|
|
@@ -1,22 +0,0 @@
|
|
|
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 getPageContent(props: TODO): Promise<any>;
|
|
22
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/methods/getPageContent/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,cAAc,CAAC,KAAK,EAAE,IAAI,gBAG/C"}
|
|
@@ -1,22 +0,0 @@
|
|
|
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 getProductCollection(props: TODO): Promise<any>;
|
|
22
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/methods/getProductCollection/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,oBAAoB,CAAC,KAAK,EAAE,IAAI,gBAGrD"}
|
package/lib/methods/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"MethodOptions.d.ts","sourceRoot":"","sources":["../../src/types/MethodOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAElD;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}
|
package/lib/types/index.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,oBAAY,IAAI,GAAG,GAAG,CAAC;AAEvB,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/types/options.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|