@blackfisk/blackfisk-vue-storefront-sdk 1.0.2 → 1.0.3

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 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.
@@ -5,8 +5,8 @@ import * as methods from './methods/index';
5
5
  */
6
6
  declare type Methods = typeof methods;
7
7
  /**
8
- * Initialize the Boilerplate connector.
8
+ * Initialize the Blackfisk connector.
9
9
  */
10
- export declare const boilerplateConnector: (options: Options) => Methods;
10
+ export declare const blackfiskConnector: (options: Options) => Methods;
11
11
  export {};
12
12
  //# sourceMappingURL=connector.d.ts.map
@@ -1 +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,oBAAoB,YAAa,OAAO,KAAG,OAIvD,CAAC"}
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"}
package/lib/index.cjs.js CHANGED
@@ -90,19 +90,19 @@ var methods = /*#__PURE__*/Object.freeze({
90
90
  });
91
91
 
92
92
  /**
93
- * Initialize the Boilerplate connector.
93
+ * Initialize the Blackfisk connector.
94
94
  */
95
- const boilerplateConnector = (options) => {
95
+ const blackfiskConnector = (options) => {
96
96
  client.defaults.baseURL = options.apiUrl;
97
97
  return methods;
98
98
  };
99
99
 
100
100
  /**
101
- * Boilerplate module.
101
+ * Blackfisk module.
102
102
  */
103
- const boilerplateModule = (options) => {
103
+ const blackfiskModule = (options) => {
104
104
  return {
105
- connector: boilerplateConnector({
105
+ connector: blackfiskConnector({
106
106
  apiUrl: options.apiUrl,
107
107
  }),
108
108
  utils: {},
@@ -110,6 +110,6 @@ const boilerplateModule = (options) => {
110
110
  };
111
111
  };
112
112
 
113
- exports.boilerplateModule = boilerplateModule;
113
+ exports.blackfiskModule = blackfiskModule;
114
114
  exports.client = client;
115
115
  //# sourceMappingURL=index.cjs.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.cjs.js","sources":["../src/client/index.ts","../src/methods/exampleMethod/index.ts","../src/methods/getPageContent/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 { 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 exampleMethod(props: TODO) {\n const { data } = await client.post<TODO>('exampleEndpoint', 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 getPageContent(props: TODO) {\n const { data } = await client.post<TODO>('getPageContent', 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 getProductCollection(props: TODO) {\n const { data } = await client.post<TODO>('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 Boilerplate connector.\n */\nexport const boilerplateConnector = (options: Options): Methods => {\n client.defaults.baseURL = options.apiUrl;\n\n return methods;\n};\n","import { boilerplateConnector } from './connector';\nimport type { Options } from './types';\nimport type { Module } from '@vue-storefront/sdk';\n\n/**\n * Boulerplate module type.\n */\nexport interface BoilerplateModuleType extends Module {\n /**\n * The connector of the Boilerplate module.\n */\n connector: ReturnType<typeof boilerplateConnector>;\n}\n\n/**\n * Boilerplate module.\n */\nexport const boilerplateModule = (options: Options): BoilerplateModuleType => {\n return {\n connector: boilerplateConnector({\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;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,iBAAiB,EAAE,KAAK,CAAC,CAAC;AACnE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,cAAc,CAAC,KAAW,EAAA;AAC9C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAClE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,oBAAoB,CAAC,KAAW,EAAA;AACpD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC;AACxE,IAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;AChBA;;AAEG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAgB,KAAa;IAChE,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;AAEzC,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;;ACFD;;AAEG;AACU,MAAA,iBAAiB,GAAG,CAAC,OAAgB,KAA2B;IAC3E,OAAO;QACL,SAAS,EAAE,oBAAoB,CAAC;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;AACF,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,WAAW,EAAE,EAAE;KAChB,CAAA;AACH;;;;;"}
1
+ {"version":3,"file":"index.cjs.js","sources":["../src/client/index.ts","../src/methods/exampleMethod/index.ts","../src/methods/getPageContent/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 { 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 exampleMethod(props: TODO) {\n const { data } = await client.post<TODO>('exampleEndpoint', 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 getPageContent(props: TODO) {\n const { data } = await client.post<TODO>('getPageContent', 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 getProductCollection(props: TODO) {\n const { data } = await client.post<TODO>('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;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,iBAAiB,EAAE,KAAK,CAAC,CAAC;AACnE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,cAAc,CAAC,KAAW,EAAA;AAC9C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAClE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,oBAAoB,CAAC,KAAW,EAAA;AACpD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC;AACxE,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.d.ts CHANGED
@@ -1,19 +1,19 @@
1
- import { boilerplateConnector } from './connector';
1
+ import { blackfiskConnector } from './connector';
2
2
  import type { Options } from './types';
3
3
  import type { Module } from '@vue-storefront/sdk';
4
4
  /**
5
5
  * Boulerplate module type.
6
6
  */
7
- export interface BoilerplateModuleType extends Module {
7
+ export interface BlackfiskModuleType extends Module {
8
8
  /**
9
- * The connector of the Boilerplate module.
9
+ * The connector of the Blackfisk module.
10
10
  */
11
- connector: ReturnType<typeof boilerplateConnector>;
11
+ connector: ReturnType<typeof blackfiskConnector>;
12
12
  }
13
13
  /**
14
- * Boilerplate module.
14
+ * Blackfisk module.
15
15
  */
16
- export declare const boilerplateModule: (options: Options) => BoilerplateModuleType;
16
+ export declare const blackfiskModule: (options: Options) => BlackfiskModuleType;
17
17
  export { client } from './client';
18
18
  export * from './types';
19
19
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
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
+ {"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"}
package/lib/index.es.js CHANGED
@@ -82,19 +82,19 @@ var methods = /*#__PURE__*/Object.freeze({
82
82
  });
83
83
 
84
84
  /**
85
- * Initialize the Boilerplate connector.
85
+ * Initialize the Blackfisk connector.
86
86
  */
87
- const boilerplateConnector = (options) => {
87
+ const blackfiskConnector = (options) => {
88
88
  client.defaults.baseURL = options.apiUrl;
89
89
  return methods;
90
90
  };
91
91
 
92
92
  /**
93
- * Boilerplate module.
93
+ * Blackfisk module.
94
94
  */
95
- const boilerplateModule = (options) => {
95
+ const blackfiskModule = (options) => {
96
96
  return {
97
- connector: boilerplateConnector({
97
+ connector: blackfiskConnector({
98
98
  apiUrl: options.apiUrl,
99
99
  }),
100
100
  utils: {},
@@ -102,5 +102,5 @@ const boilerplateModule = (options) => {
102
102
  };
103
103
  };
104
104
 
105
- export { boilerplateModule, client };
105
+ export { blackfiskModule, client };
106
106
  //# sourceMappingURL=index.es.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.es.js","sources":["../src/client/index.ts","../src/methods/exampleMethod/index.ts","../src/methods/getPageContent/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 { 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 exampleMethod(props: TODO) {\n const { data } = await client.post<TODO>('exampleEndpoint', 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 getPageContent(props: TODO) {\n const { data } = await client.post<TODO>('getPageContent', 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 getProductCollection(props: TODO) {\n const { data } = await client.post<TODO>('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 Boilerplate connector.\n */\nexport const boilerplateConnector = (options: Options): Methods => {\n client.defaults.baseURL = options.apiUrl;\n\n return methods;\n};\n","import { boilerplateConnector } from './connector';\nimport type { Options } from './types';\nimport type { Module } from '@vue-storefront/sdk';\n\n/**\n * Boulerplate module type.\n */\nexport interface BoilerplateModuleType extends Module {\n /**\n * The connector of the Boilerplate module.\n */\n connector: ReturnType<typeof boilerplateConnector>;\n}\n\n/**\n * Boilerplate module.\n */\nexport const boilerplateModule = (options: Options): BoilerplateModuleType => {\n return {\n connector: boilerplateConnector({\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;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,iBAAiB,EAAE,KAAK,CAAC,CAAC;AACnE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,cAAc,CAAC,KAAW,EAAA;AAC9C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAClE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,oBAAoB,CAAC,KAAW,EAAA;AACpD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC;AACxE,IAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;AChBA;;AAEG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAgB,KAAa;IAChE,MAAM,CAAC,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;AAEzC,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;;ACFD;;AAEG;AACU,MAAA,iBAAiB,GAAG,CAAC,OAAgB,KAA2B;IAC3E,OAAO;QACL,SAAS,EAAE,oBAAoB,CAAC;YAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;AACF,QAAA,KAAK,EAAE,EAAE;AACT,QAAA,WAAW,EAAE,EAAE;KAChB,CAAA;AACH;;;;"}
1
+ {"version":3,"file":"index.es.js","sources":["../src/client/index.ts","../src/methods/exampleMethod/index.ts","../src/methods/getPageContent/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 { 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 exampleMethod(props: TODO) {\n const { data } = await client.post<TODO>('exampleEndpoint', 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 getPageContent(props: TODO) {\n const { data } = await client.post<TODO>('getPageContent', 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 getProductCollection(props: TODO) {\n const { data } = await client.post<TODO>('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;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,aAAa,CAAC,KAAW,EAAA;AAC7C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,iBAAiB,EAAE,KAAK,CAAC,CAAC;AACnE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,cAAc,CAAC,KAAW,EAAA;AAC9C,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,gBAAgB,EAAE,KAAK,CAAC,CAAC;AAClE,IAAA,OAAO,IAAI,CAAA;AACb;;ACtBA;;;;;;;;;;;;;;;;;;AAkBG;AACI,eAAe,oBAAoB,CAAC,KAAW,EAAA;AACpD,IAAA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC;AACxE,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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blackfisk/blackfisk-vue-storefront-sdk",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
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.2",
26
+ "@blackfisk/blackfisk-vue-storefront-api": "^1.0.3",
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": "90beb5104539291e597a9e1ca339c7ec8fa54c46"
32
+ "gitHead": "094c3d4d430d37b78ae5085ccbe6629ac79a8baf"
33
33
  }