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

package/lib/index.cjs.js

@@ -11,71 +11,27 @@ var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 const client = axios__default["default"].create();
 
 /**
- * Method summary - General information about the SDK method, usually a single sentence.
+ * Executes a collection template chain against Elasticsearch - returning a collection of products.
  *
  * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
+ * * API middleware endpoint: /getProductCollection
+ * * Blackfisk endpoint: /v2/vsf/productCollection
+ * * Any authenticated client can make this call. A collectionId must be provided.
  *
  * @param props
- * 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.
  *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-async function exampleMethod(props) {
-    const { data } = await client.post('exampleEndpoint', props);
-    return data;
-}
-
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
+ * Required
+ * * collectionId
  *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-async function getPageContent(props) {
-    const { data } = await client.post('getPageContent', props);
-    return data;
-}
-
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
+ * Optional -
+ * * debug: boolean
+ * * templateParams: object with the keys required to populate the template chain for the specified collection.
  *
  * @returns
- * Human-friendly information what the SDK methods returns.
+ * An array of SearchProduct objects.
  *
  * @example
- * 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.
+ * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })
  */
 async function getProductCollection(props) {
     const { data } = await client.post('getProductCollection', props);
@@ -84,8 +40,6 @@ async function getProductCollection(props) {
 
 var methods = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  exampleMethod: exampleMethod,
-  getPageContent: getPageContent,
   getProductCollection: getProductCollection
 });
 

package/lib/index.cjs.js.map

@@ -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 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;;;;;"}
+{"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 * 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;;;;;;;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

@@ -3,71 +3,27 @@ import axios from 'axios';
 const client = axios.create();
 
 /**
- * Method summary - General information about the SDK method, usually a single sentence.
+ * Executes a collection template chain against Elasticsearch - returning a collection of products.
  *
  * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
+ * * API middleware endpoint: /getProductCollection
+ * * Blackfisk endpoint: /v2/vsf/productCollection
+ * * Any authenticated client can make this call. A collectionId must be provided.
  *
  * @param props
- * 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.
  *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-async function exampleMethod(props) {
-    const { data } = await client.post('exampleEndpoint', props);
-    return data;
-}
-
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
+ * Required
+ * * collectionId
  *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-async function getPageContent(props) {
-    const { data } = await client.post('getPageContent', props);
-    return data;
-}
-
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
+ * Optional -
+ * * debug: boolean
+ * * templateParams: object with the keys required to populate the template chain for the specified collection.
  *
  * @returns
- * Human-friendly information what the SDK methods returns.
+ * An array of SearchProduct objects.
  *
  * @example
- * 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.
+ * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })
  */
 async function getProductCollection(props) {
     const { data } = await client.post('getProductCollection', props);
@@ -76,8 +32,6 @@ async function getProductCollection(props) {
 
 var methods = /*#__PURE__*/Object.freeze({
   __proto__: null,
-  exampleMethod: exampleMethod,
-  getPageContent: getPageContent,
   getProductCollection: getProductCollection
 });
 

package/lib/index.es.js.map

@@ -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 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;;;;"}
+{"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 * 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;;;;;;;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/methods/index.d.ts

@@ -1,4 +1,2 @@
-export { exampleMethod } from './exampleMethod';
-export { getPageContent } from './getPageContent';
 export { getProductCollection } from './getProductCollection';
 //# sourceMappingURL=index.d.ts.map

package/lib/methods/index.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts

@@ -0,0 +1,14 @@
+import { Endpoints, SearchProduct } from '../../types';
+export interface getProductCollectionTemplateParams {
+    [key: string]: any;
+}
+export interface getProductCollectionParams {
+    collectionId: number | string;
+    templateParams?: getProductCollectionTemplateParams;
+    debug?: boolean;
+}
+export interface getProductCollectionResponse {
+    data: SearchProduct[];
+}
+export declare const getProductCollection: Endpoints['getProductCollection'];
+//# sourceMappingURL=index.d.ts.map

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection/index.d.ts.map

@@ -0,0 +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"}

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts

@@ -0,0 +1,13 @@
+import { BfskIntegrationContext } from '..';
+import { getProductCollectionParams, getProductCollectionResponse } from '../../api/getProductCollection/index';
+/**
+ * Definition of all API-client methods available in {@link https://docs.vuestorefront.io/v2/advanced/context.html#context-api | context}.
+ */
+export interface Endpoints {
+    /**
+     * Here you can find an example endpoint definition. Based on this example, you should define how your endpoint will look like.
+     * This description will appear in the API extractor, so try to document all endpoints added here.
+     */
+    getProductCollection(context: BfskIntegrationContext, params: getProductCollectionParams): Promise<getProductCollectionResponse>;
+}
+//# sourceMappingURL=endpoints.d.ts.map

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/endpoints.d.ts.map

@@ -0,0 +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"}

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts

@@ -0,0 +1,62 @@
+export interface SearchProductAttribute {
+    id: number;
+    name: string;
+    valueJSON: string;
+}
+export interface SearchProductAttributeTypes {
+    facets: SearchProductAttribute[];
+    misc: SearchProductAttribute[];
+    specifications: SearchProductAttribute[];
+    variants: SearchProductAttribute[];
+}
+export interface SearchProductCondition {
+    id: number;
+    name: string;
+    description: string;
+}
+export interface SearchProductImage {
+    url: string;
+    public_id: string;
+    isPrimary: number;
+    alt: string;
+}
+export interface SearchProductMeta {
+}
+export interface SearchProduct {
+    id: number;
+    accountId: number;
+    attributeListValues: string[];
+    attributeValues: string[];
+    attributes: SearchProductAttributeTypes;
+    brandId: number;
+    brandName: string;
+    categories: string[];
+    categoryIds: number[];
+    categoryName: string;
+    channelId: number;
+    colors: [];
+    condition: SearchProductCondition;
+    description: string;
+    familyId: number;
+    features: string[];
+    heading: string;
+    images: SearchProductImage[];
+    imagesCount: number;
+    isAvailable: boolean;
+    keywords: string[];
+    meta: SearchProductMeta;
+    metaDescription: string;
+    mpn: string;
+    parentName: string;
+    priceMAP: number;
+    priceSale: number;
+    pricingStrategy: string;
+    productName: string;
+    quantity: number;
+    sku: string;
+    slug: string;
+    title: string;
+    upc: string;
+}
+export * from './endpoints';
+//# sourceMappingURL=index.d.ts.map

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/api/index.d.ts.map

@@ -0,0 +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"}

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/config/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Settings to be provided in the `middleware.config.js` file.
+ */
+interface ApiMiddlewareConfig {
+    url: string;
+    auth_jwt: string;
+}
+export interface MiddlewareConfig {
+    accountId: number;
+    channelId: number;
+    accountSiteId: number;
+    api: ApiMiddlewareConfig;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/config/index.d.ts.map

@@ -0,0 +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"}

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/context/index.d.ts

@@ -0,0 +1,14 @@
+import { IntegrationContext } from '@vue-storefront/middleware';
+import { AxiosInstance } from 'axios';
+import { MiddlewareConfig, ContextualizedEndpoints } from '../index';
+/**
+ * Runtime integration context, which includes API client instance, settings, and endpoints that will be passed via middleware server.
+ **/
+export declare type BfskIntegrationContext = IntegrationContext<AxiosInstance, MiddlewareConfig, ContextualizedEndpoints>;
+/**
+ * Global context of the application which includes runtime integration context.
+ **/
+export interface Context {
+    $bfsk: BfskIntegrationContext;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/context/index.d.ts.map

@@ -0,0 +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"}

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/index.d.ts

@@ -0,0 +1,12 @@
+import { Endpoints } from './api';
+/**
+ * All available API Endpoints without first argument - `context`, because this prop is set automatically.
+ */
+export declare type ContextualizedEndpoints = {
+    [T in keyof Endpoints]: Endpoints[T] extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+};
+export declare type TODO = any;
+export * from './api';
+export * from './config';
+export * from './context';
+//# sourceMappingURL=index.d.ts.map

package/lib/node_modules/@blackfisk/blackfisk-vue-storefront-api/src/types/index.d.ts.map

@@ -0,0 +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"}

package/lib/packages/api-client/src/api/getProductCollection/index.d.ts

@@ -0,0 +1,14 @@
+import { Endpoints, SearchProduct } from '../../types';
+export interface getProductCollectionTemplateParams {
+    [key: string]: any;
+}
+export interface getProductCollectionParams {
+    collectionId: number | string;
+    templateParams?: getProductCollectionTemplateParams;
+    debug?: boolean;
+}
+export interface getProductCollectionResponse {
+    data: SearchProduct[];
+}
+export declare const getProductCollection: Endpoints['getProductCollection'];
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/api-client/src/api/getProductCollection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/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"}

package/lib/packages/api-client/src/types/api/endpoints.d.ts

@@ -0,0 +1,13 @@
+import { BfskIntegrationContext } from '..';
+import { getProductCollectionParams, getProductCollectionResponse } from '../../api/getProductCollection/index';
+/**
+ * Definition of all API-client methods available in {@link https://docs.vuestorefront.io/v2/advanced/context.html#context-api | context}.
+ */
+export interface Endpoints {
+    /**
+     * Here you can find an example endpoint definition. Based on this example, you should define how your endpoint will look like.
+     * This description will appear in the API extractor, so try to document all endpoints added here.
+     */
+    getProductCollection(context: BfskIntegrationContext, params: getProductCollectionParams): Promise<getProductCollectionResponse>;
+}
+//# sourceMappingURL=endpoints.d.ts.map

package/lib/packages/api-client/src/types/api/endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.d.ts","sourceRoot":"","sources":["../../../../../../../api-client/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"}

package/lib/packages/api-client/src/types/api/index.d.ts

@@ -0,0 +1,62 @@
+export interface SearchProductAttribute {
+    id: number;
+    name: string;
+    valueJSON: string;
+}
+export interface SearchProductAttributeTypes {
+    facets: SearchProductAttribute[];
+    misc: SearchProductAttribute[];
+    specifications: SearchProductAttribute[];
+    variants: SearchProductAttribute[];
+}
+export interface SearchProductCondition {
+    id: number;
+    name: string;
+    description: string;
+}
+export interface SearchProductImage {
+    url: string;
+    public_id: string;
+    isPrimary: number;
+    alt: string;
+}
+export interface SearchProductMeta {
+}
+export interface SearchProduct {
+    id: number;
+    accountId: number;
+    attributeListValues: string[];
+    attributeValues: string[];
+    attributes: SearchProductAttributeTypes;
+    brandId: number;
+    brandName: string;
+    categories: string[];
+    categoryIds: number[];
+    categoryName: string;
+    channelId: number;
+    colors: [];
+    condition: SearchProductCondition;
+    description: string;
+    familyId: number;
+    features: string[];
+    heading: string;
+    images: SearchProductImage[];
+    imagesCount: number;
+    isAvailable: boolean;
+    keywords: string[];
+    meta: SearchProductMeta;
+    metaDescription: string;
+    mpn: string;
+    parentName: string;
+    priceMAP: number;
+    priceSale: number;
+    pricingStrategy: string;
+    productName: string;
+    quantity: number;
+    sku: string;
+    slug: string;
+    title: string;
+    upc: string;
+}
+export * from './endpoints';
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/api-client/src/types/api/index.d.ts.map

@@ -0,0 +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;AACD,cAAc,aAAa,CAAC"}

package/lib/packages/api-client/src/types/config/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Settings to be provided in the `middleware.config.js` file.
+ */
+interface ApiMiddlewareConfig {
+    url: string;
+    auth_jwt: string;
+}
+export interface MiddlewareConfig {
+    accountId: number;
+    channelId: number;
+    accountSiteId: number;
+    api: ApiMiddlewareConfig;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/api-client/src/types/config/index.d.ts.map

@@ -0,0 +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"}

package/lib/packages/api-client/src/types/context/index.d.ts

@@ -0,0 +1,14 @@
+import { IntegrationContext } from '@vue-storefront/middleware';
+import { AxiosInstance } from 'axios';
+import { MiddlewareConfig, ContextualizedEndpoints } from '../index';
+/**
+ * Runtime integration context, which includes API client instance, settings, and endpoints that will be passed via middleware server.
+ **/
+export declare type BfskIntegrationContext = IntegrationContext<AxiosInstance, MiddlewareConfig, ContextualizedEndpoints>;
+/**
+ * Global context of the application which includes runtime integration context.
+ **/
+export interface Context {
+    $bfsk: BfskIntegrationContext;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/api-client/src/types/context/index.d.ts.map

@@ -0,0 +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"}

package/lib/packages/api-client/src/types/index.d.ts

@@ -0,0 +1,12 @@
+import { Endpoints } from './api';
+/**
+ * All available API Endpoints without first argument - `context`, because this prop is set automatically.
+ */
+export declare type ContextualizedEndpoints = {
+    [T in keyof Endpoints]: Endpoints[T] extends (x: any, ...args: infer P) => infer R ? (...args: P) => R : never;
+};
+export declare type TODO = any;
+export * from './api';
+export * from './config';
+export * from './context';
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/api-client/src/types/index.d.ts.map

@@ -0,0 +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"}

package/lib/packages/sdk/src/api-extractor.data.d.ts.map

@@ -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"}

package/lib/packages/sdk/src/client/index.d.ts

@@ -0,0 +1,2 @@
+export declare const client: import("axios").AxiosInstance;
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/sdk/src/client/index.d.ts.map

@@ -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/packages/sdk/src/connector.d.ts

@@ -0,0 +1,12 @@
+import { Options } from './types';
+import * as methods from './methods/index';
+/**
+ * Connector methods.
+ */
+declare type Methods = typeof methods;
+/**
+ * Initialize the Blackfisk connector.
+ */
+export declare const blackfiskConnector: (options: Options) => Methods;
+export {};
+//# sourceMappingURL=connector.d.ts.map

package/lib/packages/sdk/src/connector.d.ts.map

@@ -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,kBAAkB,YAAa,OAAO,KAAG,OAIrD,CAAC"}

package/lib/{index.d.ts → packages/sdk/src/index.d.ts}

@@ -2,7 +2,7 @@ import { blackfiskConnector } from './connector';
 import type { Options } from './types';
 import type { Module } from '@vue-storefront/sdk';
 /**
- * Boulerplate module type.
+ * Blackfisk module type.
  */
 export interface BlackfiskModuleType extends Module {
     /**

package/lib/packages/sdk/src/index.d.ts.map

@@ -0,0 +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/packages/sdk/src/methods/getProductCollection/index.d.ts

@@ -0,0 +1,26 @@
+import { getProductCollectionParams, getProductCollectionResponse } from '@blackfisk/blackfisk-vue-storefront-api/src/api/getProductCollection';
+/**
+ * Executes a collection template chain against Elasticsearch - returning a collection of products.
+ *
+ * @remarks
+ * * API middleware endpoint: /getProductCollection
+ * * Blackfisk endpoint: /v2/vsf/productCollection
+ * * Any authenticated client can make this call. A collectionId must be provided.
+ *
+ * @param props
+ *
+ * Required
+ * * collectionId
+ *
+ * Optional -
+ * * debug: boolean
+ * * templateParams: object with the keys required to populate the template chain for the specified collection.
+ *
+ * @returns
+ * An array of SearchProduct objects.
+ *
+ * @example
+ * const { data: ProductCollection } = await getProductCollection({ collectionId: 145, debug: true })
+ */
+export declare function getProductCollection(props: getProductCollectionParams): Promise<getProductCollectionResponse>;
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/sdk/src/methods/getProductCollection/index.d.ts.map

@@ -0,0 +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"}

package/lib/packages/sdk/src/methods/index.d.ts

@@ -0,0 +1,2 @@
+export { getProductCollection } from './getProductCollection';
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/sdk/src/methods/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/methods/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC"}

package/lib/packages/sdk/src/types/MethodOptions.d.ts

@@ -0,0 +1,16 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * Definition of the MethodOptions parameter.
+ */
+export interface MethodOptions {
+    /**
+     * {@link https://axios-http.com/docs/req_config | AxiosRequestConfig} object
+     * You can use it to override Axios request configuration
+     */
+    axiosRequestConfig?: Readonly<AxiosRequestConfig>;
+    /**
+     * Additional optional fields. Its usage depends on the custom implementation.
+     */
+    [key: string]: any;
+}
+//# sourceMappingURL=MethodOptions.d.ts.map

package/lib/packages/sdk/src/types/MethodOptions.d.ts.map

@@ -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/packages/sdk/src/types/index.d.ts

@@ -0,0 +1,4 @@
+export declare type TODO = any;
+export type { MethodOptions } from './MethodOptions';
+export type { Options } from './options';
+//# sourceMappingURL=index.d.ts.map

package/lib/packages/sdk/src/types/index.d.ts.map

@@ -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"}

package/lib/packages/sdk/src/types/options.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Options for the SDK module.
+ */
+export interface Options {
+    /**
+     * The API URL of the client-side environment.
+     */
+    apiUrl: string;
+}
+//# sourceMappingURL=options.d.ts.map

package/lib/packages/sdk/src/types/options.d.ts.map

@@ -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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blackfisk/blackfisk-vue-storefront-sdk",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "main": "lib/index.cjs.js",
   "module": "lib/index.es.js",
   "types": "lib/index.d.ts",
@@ -23,11 +23,11 @@
     "axios": "^0.27.2"
   },
   "devDependencies": {
-    "@blackfisk/blackfisk-vue-storefront-api": "^1.0.3",
+    "@blackfisk/blackfisk-vue-storefront-api": "^1.0.4",
     "@vue-storefront/sdk": "1.0.1",
     "msw": "^0.47.3",
     "nock": "^13.2.9",
     "rollup-plugin-typescript2": "^0.34.1"
   },
-  "gitHead": "094c3d4d430d37b78ae5085ccbe6629ac79a8baf"
+  "gitHead": "24e4a47e724b2c64639629691963c5c51bc69709"
 }

package/lib/api-extractor.data.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/lib/index.d.ts.map

@@ -1 +0,0 @@
-{"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/methods/exampleMethod/index.d.ts

@@ -1,22 +0,0 @@
-import { TODO } from '../../types';
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
- *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-export declare function exampleMethod(props: TODO): Promise<any>;
-//# sourceMappingURL=index.d.ts.map

package/lib/methods/exampleMethod/index.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/lib/methods/getPageContent/index.d.ts

@@ -1,22 +0,0 @@
-import { TODO } from '../../types';
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
- *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-export declare function getPageContent(props: TODO): Promise<any>;
-//# sourceMappingURL=index.d.ts.map

package/lib/methods/getPageContent/index.d.ts.map

@@ -1 +0,0 @@
-{"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"}

package/lib/methods/getProductCollection/index.d.ts

@@ -1,22 +0,0 @@
-import { TODO } from '../../types';
-/**
- * Method summary - General information about the SDK method, usually a single sentence.
- *
- * @remarks
- * In this section, we have been adding detailed information such as:
- * * what API middleware endpoint this method is calling,
- * * what SAP OCC API endpoints are being called as a result of using this method,
- * * when this method can be used and when it can’t (e.g. logged-in vs anonymous users),
- * * simply everything what helps with understanding how it works.
- *
- * @param props
- * 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.
- *
- * @returns
- * Human-friendly information what the SDK methods returns.
- *
- * @example
- * 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.
- */
-export declare function getProductCollection(props: TODO): Promise<any>;
-//# sourceMappingURL=index.d.ts.map

package/lib/methods/getProductCollection/index.d.ts.map

@@ -1 +0,0 @@
-{"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"}