@empathyco/x-adapter-platform 1.0.0-alpha.9 → 1.0.0

package/README.md

@@ -1,9 +1,350 @@
 # x-adapter-platform
 
-`x-adapter-platform` is a library to ease the communication with
-**[empathy.co](https://empathy.co/)** Platform API.
+**Empathy Platform Adapter** is a library to ease the communication with **empathy.co**
+[Empathy Platform API](https://docs.empathy.co/develop-empathy-platform/api-reference/search-api.html).
+Built upon the [x-adapter](https://github.com/empathyco/x/tree/main/packages/x-adapter) library, it
+contains a sample configuration for setup, global configurations, mappers and models.
 
-### Contributing
+It is used as the default adapter configuration in
+[x-archetype](https://github.com/empathyco/x-archetype), a standardised implementation of the
+[x-components](https://github.com/empathyco/x/tree/main/packages/x-components) library, which
+imports it as a plugin.
 
-To start contributing to the project, please take a look to our
-[Contributing Guide](../../.github/CONTRIBUTING.md).
+<br>
+
+## Tech Stack
+
+[![TypeScript](https://img.shields.io/badge/-typescript-3178C6?logo=typescript&logoColor=white&style=for-the-badge)](https://www.typescriptlang.org/)
+[![Jest](https://img.shields.io/badge/-jest-C21325?logo=jest&logoColor=white&style=for-the-badge)](https://jestjs.io/)
+
+<br>
+
+## Installation
+
+```
+# or pnpm or yarn
+npm install @empathyco/x-adapter-platform
+```
+
+<br>
+
+## Configuration & Usage
+
+The `PlatformAdapter` is an object containing several endpoint adapters.
+
+Each `EndpointAdapter` contains the configuration of an endpoint, including the URL, the mapper to
+adapt the responses and the requests, the request options ...
+
+```ts
+export const platformAdapter: PlatformAdapter = {
+  search: searchEndpointAdapter,
+  popularSearches: popularSearchesEndpointAdapter,
+  recommendations: recommendationsEndpointAdapter,
+  nextQueries: nextQueriesEndpointAdapter,
+  querySuggestions: querySuggestionsEndpointAdapter,
+  relatedTags: relatedTagsEndpointAdapter,
+  identifierResults: identifierResultsEndpointAdapter,
+  tagging: taggingEndpointAdapter
+};
+```
+
+<br>
+
+### Platform Endpoint Adapters & usage
+
+The
+[Empathy Platform API](https://docs.empathy.co/develop-empathy-platform/api-reference/search-api.html)
+has the particularity of needing an `env`, `instance` and a `language` to be passed in each endpoint
+call (except the tagging).
+
+In an [x-archetype](https://github.com/empathyco/x-archetype) project context, which would be the
+recommended scenario to use this package, these parameters are configured through the
+[snippetConfig](https://docs.empathy.co/develop-empathy-platform/build-search-ui/web-archetype-integration-guide.html#snippet-configuration).
+
+If you are not using the `x-platform-adapter` inside an `x-archetype` based project, but you want to
+use the **Empathy Platform API**, you can use the `extraParams` field to specify the required
+parameters to make it work, as shown in the examples below.
+
+<br>
+
+##### Search endpoint adapter
+
+- endpoint: `/search/v1/query/{extraParams.instance}/search`
+- request:
+  [`SearchRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/search-request.model.ts)
+- response:
+  [`SearchResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/search-response.model.ts)
+
+The search endpoint will include an
+[array of results](https://github.com/empathyco/x/blob/main/packages/x-types/src/result/result.model.ts)
+in its response.
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { results } = await platformAdapter.search({
+  query: 'trousers',
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Popular searches endpoint adapter
+
+- endpoint: `/search/v1/query/{extraParams.instance}/empathize`
+- request:
+  [`PopularSearchesRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/popular-searches-request.model.ts)
+- response:
+  [`PopularSearchesResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/popular-searches-response.model.ts)
+
+The `PopularSearches` endpoint will return top searched queries.
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { suggestions } = await platformAdapter.popularSearches({
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Recommendations endpoint adapter
+
+- endpoint: `/search/v1/query/{extraParams.instance}/topclicked`
+- request:
+  [`RecommendationsRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/recommendations-request.model.ts)
+- response:
+  [`RecommendationsResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/recommendations-response.model.ts)
+
+These **recommendations** are top clicked products based on user click interactions (note: no
+personal user data is collected).
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { results } = await platformAdapter.recommendations({
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Next Queries endpoint adapter
+
+- endpoint: `/nextqueries/{extraParams.instance}`
+- request:
+  [`NextQueriesRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/next-queries-request.model.ts)
+- response:
+  [`NextQueriesResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/next-queries-response.model.ts)
+
+The `NextQueries` endpoint returns recurring searches that users tend to do after searching for a
+specific item. The aim is to suggest a new term that the user may be interested in.
+
+The `NextQueriesRequest` is usually done after a `SearchRequest` has been made.
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { nextQueries } = await platformAdapter.nextQueries({
+  query: 'trousers',
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Query suggestions endpoint adapter
+
+- endpoint: `/search/v1/query/{extraParams.instance}/empathize`
+- request:
+  [`QuerySuggestionsRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/query-suggestions-request.model.ts)
+- response:
+  [`QuerySuggestionsResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/query-suggestions-response.model.ts)
+
+The `QuerySuggestions` endpoint returns suggestions based on a query. For example, for the query
+"trousers" we could have "denim trousers, cargo trousers, chino trousers, etc..." as query
+suggestions.
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { suggestions } = await platformAdapter.querySuggestions({
+  query: 'trousers',
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Related tags endpoint adapter
+
+- endpoint: `/relatedtags/{extraParams.instance}`
+- request:
+  [`RelatedTagsRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/related-tags-request.model.ts)
+- response:
+  [`RelatedTagsResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/related-tags-response.model.ts)
+
+The `RelatedTags` endpoint will return terms used to help refining a search query by adding more
+**specificity** (e.g, adjectives: long, short, gluten-free; categories: kids, summer...).
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { relatedTags } = await platformAdapter.relatedTags({
+  query: 'trousers',
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Identifier results endpoint adapter
+
+- endpoint: `/search/v1/query/{extraParams.instance}/skusearch`
+- request:
+  [`IdentifierResultsRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/identifier-results-request.model.ts)
+- response:
+  [`IdentifierResultsResponse`](https://github.com/empathyco/x/blob/main/packages/x-types/src/response/identifier-results-response.model.ts)
+
+The `IdentifierResults` endpoint will return the results whose
+[identifier](https://github.com/empathyco/x/blob/main/packages/x-types/src/identifiable.model.ts)
+matches a given `query`.
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const { results } = await platformAdapter.identifierResults({
+  query: '1234',
+  extraParams: {
+    lang: 'en',
+    instance: 'empathy',
+    env: 'staging'
+  }
+});
+```
+
+<br>
+
+##### Tagging endpoint adapter
+
+- endpoint: `({ url }) => url`
+- request:
+  [`TaggingRequest`](https://github.com/empathyco/x/blob/main/packages/x-types/src/request/tagging-request.model.ts)
+- response: `void`
+
+The `Tagging` endpoint allows sending events to a server to collect metrics about how the search is
+performing (this won't collect user data, just the use of tools per session).
+
+You can configure your `tagging` object following the
+[`Taggable`](https://github.com/empathyco/x/blob/main/packages/x-types/src/tagging.model.ts)
+interface, which contains several user actions and the capability to include your own.
+
+```ts
+import { platformAdapter } from '@empathyco/x-adapter-platform';
+
+const tagging = await platformAdapter.tagging({
+  // The tagging request will be sent to this URL
+  url: 'https://api.staging.empathy.co/tagging/v1/track/empathy/query',
+  // Info that will be sent along with the query event
+  params: {
+    filtered: 'false',
+    lang: 'en',
+    origin: 'customer:no_query',
+    page: '1',
+    q: 'trousers',
+    scope: 'desktop',
+    spellcheck: 'false',
+    totalHits: 700
+  }
+});
+```
+
+<br>
+
+### Modifying the x-platform-adapter
+
+Each request and response schemas are created as `MutableSchemas`, so they can be modified using the
+`$extends`, `$override`, `$replace` methods accordingly. You can check the
+[`x-adapter`](https://github.com/empathyco/x/tree/main/packages/x-adapter/README.md)'s package
+documentation for further details.
+
+###### Example of overriding a response by adding a new parameter
+
+```ts
+import { PlatformResult, resultSchema } from '@empathyco/x-adapter-platform';
+import { Result } from '@empathyco/x-types';
+
+interface EmpathyDemoPlatformResult extends PlatformResult {
+  season: string;
+}
+
+declare module '@empathyco/x-types' {
+  export interface Result {
+    season: string;
+  }
+}
+
+resultSchema.$override<EmpathyDemoPlatformResult, Partial<Result>>({
+  season: 'season'
+});
+```
+
+<br>
+
+## Test
+
+**Empathy Adapter Platform** features are tested using [Jest](https://jestjs.io/). You will find a
+`__tests__` folder inside the `src` folder with tests for each of the endpoint calls, and also
+inside each of the project's sections functionalities (`endpoint-adapters`, `mappers` and
+`schemas`).
+
+```
+npm run test
+```
+
+<br>
+
+## Changelog
+
+[Changelog summary](https://github.com/empathyco/x/blob/main/packages/x-adapter-platform/CHANGELOG.md)
+
+<br>
+
+## Contributing
+
+To start contributing to the project, please take a look at our
+**[Contributing Guide](https://github.com/empathyco/x/blob/HEAD/.github/CONTRIBUTING.md).** Take in
+account that `x-adapter-platform` is developed using [Typescript](https://www.typescriptlang.org/),
+so we recommend you to check it out.
+
+<br>
+
+## License
+
+[empathyco/x License](https://github.com/empathyco/x/blob/main/packages/x-adapter-platform/LICENSE)

package/dist/cjs/endpoint-adapters/experience-controls.endpoint-adapter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.experienceControlsEndpointAdapter = void 0;
+/* eslint-disable max-len */
+const x_adapter_1 = require("@empathyco/x-adapter");
+const experience_controls_request_mapper_1 = require("../mappers/requests/experience-controls-request.mapper");
+const experience_controls_response_mapper_1 = require("../mappers/responses/experience-controls-response.mapper");
+/* eslint-enable max-len */
+/**.
+ * Default adapter for the experience controls endpoint.
+ *
+ * @public
+ */
+exports.experienceControlsEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
+    endpoint: 'https://api.{extraParams.env(.)}empathy.co/config/v1/public/configs',
+    requestMapper: experience_controls_request_mapper_1.experienceControlsRequestMapper,
+    responseMapper: experience_controls_response_mapper_1.experienceControlsResponseMapper,
+    defaultRequestOptions: {
+        id: 'experience-controls',
+        parameters: {
+            service: 'xcontrols'
+        }
+    }
+});
+//# sourceMappingURL=experience-controls.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/experience-controls.endpoint-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"experience-controls.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/experience-controls.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,4BAA4B;AAC5B,oDAA8D;AAE9D,+GAAyG;AACzG,kHAA4G;AAC5G,2BAA2B;AAE3B;;;;GAIG;AACU,QAAA,iCAAiC,GAAG,IAAA,kCAAsB,EAGrE;IACA,QAAQ,EAAE,qEAAqE;IAC/E,aAAa,EAAE,oEAA+B;IAC9C,cAAc,EAAE,sEAAgC;IAChD,qBAAqB,EAAE;QACrB,EAAE,EAAE,qBAAqB;QACzB,UAAU,EAAE;YACV,OAAO,EAAE,WAAW;SACrB;KACF;CACF,CAAC,CAAC","sourcesContent":["/* eslint-disable max-len */\nimport { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { ExperienceControlsRequest, ExperienceControlsResponse } from '@empathyco/x-types';\nimport { experienceControlsRequestMapper } from '../mappers/requests/experience-controls-request.mapper';\nimport { experienceControlsResponseMapper } from '../mappers/responses/experience-controls-response.mapper';\n/* eslint-enable max-len */\n\n/**.\n * Default adapter for the experience controls endpoint.\n *\n * @public\n */\nexport const experienceControlsEndpointAdapter = endpointAdapterFactory<\n  ExperienceControlsRequest,\n  ExperienceControlsResponse\n>({\n  endpoint: 'https://api.{extraParams.env(.)}empathy.co/config/v1/public/configs',\n  requestMapper: experienceControlsRequestMapper,\n  responseMapper: experienceControlsResponseMapper,\n  defaultRequestOptions: {\n    id: 'experience-controls',\n    parameters: {\n      service: 'xcontrols'\n    }\n  }\n});\n"]}

package/dist/cjs/endpoint-adapters/identifier-results.endpoint-adapter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.identifierResultsEndpointAdapter = void 0;
+const x_adapter_1 = require("@empathyco/x-adapter");
+// eslint-disable-next-line max-len
+const identifier_results_request_mapper_1 = require("../mappers/requests/identifier-results-request.mapper");
+// eslint-disable-next-line max-len
+const identifier_results_response_mapper_1 = require("../mappers/responses/identifier-results-response.mapper");
+/**
+ * Default adapter for the identifier results endpoint.
+ *
+ * @public
+ */
+exports.identifierResultsEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
+    endpoint: 'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/skusearch',
+    requestMapper: identifier_results_request_mapper_1.identifierResultsRequestMapper,
+    responseMapper: identifier_results_response_mapper_1.identifierResultsResponseMapper,
+    defaultRequestOptions: {
+        id: 'identifier-results',
+        parameters: {
+            internal: true
+        }
+    }
+});
+//# sourceMappingURL=identifier-results.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/identifier-results.endpoint-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier-results.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/identifier-results.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,oDAA8D;AAE9D,mCAAmC;AACnC,6GAAuG;AACvG,mCAAmC;AACnC,gHAA0G;AAE1G;;;;GAIG;AACU,QAAA,gCAAgC,GAAG,IAAA,kCAAsB,EAGpE;IACA,QAAQ,EACN,6FAA6F;IAC/F,aAAa,EAAE,kEAA8B;IAC7C,cAAc,EAAE,oEAA+B;IAC/C,qBAAqB,EAAE;QACrB,EAAE,EAAE,oBAAoB;QACxB,UAAU,EAAE;YACV,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { IdentifierResultsRequest, IdentifierResultsResponse } from '@empathyco/x-types';\n// eslint-disable-next-line max-len\nimport { identifierResultsRequestMapper } from '../mappers/requests/identifier-results-request.mapper';\n// eslint-disable-next-line max-len\nimport { identifierResultsResponseMapper } from '../mappers/responses/identifier-results-response.mapper';\n\n/**\n * Default adapter for the identifier results endpoint.\n *\n * @public\n */\nexport const identifierResultsEndpointAdapter = endpointAdapterFactory<\n  IdentifierResultsRequest,\n  IdentifierResultsResponse\n>({\n  endpoint:\n    'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/skusearch',\n  requestMapper: identifierResultsRequestMapper,\n  responseMapper: identifierResultsResponseMapper,\n  defaultRequestOptions: {\n    id: 'identifier-results',\n    parameters: {\n      internal: true\n    }\n  }\n});\n"]}

package/dist/cjs/endpoint-adapters/index.js

@@ -2,10 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./popular-searches.endpoint-adapter"), exports);
+tslib_1.__exportStar(require("./identifier-results.endpoint-adapter"), exports);
 tslib_1.__exportStar(require("./next-queries.endpoint-adapter"), exports);
+tslib_1.__exportStar(require("./query-suggestions.endpoint-adapter"), exports);
+tslib_1.__exportStar(require("./recommendations.endpoint-adapter"), exports);
 tslib_1.__exportStar(require("./related-tags.endpoint-adapter"), exports);
 tslib_1.__exportStar(require("./search.endpoint-adapter"), exports);
-tslib_1.__exportStar(require("./sku-search.endpoint-adapter"), exports);
+tslib_1.__exportStar(require("./semantic-queries.endpoint-adapter"), exports);
 tslib_1.__exportStar(require("./tagging.endpoint-adapter"), exports);
-tslib_1.__exportStar(require("./top-clicked.endpoint-adapter"), exports);
+tslib_1.__exportStar(require("./experience-controls.endpoint-adapter"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/endpoint-adapters/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/index.ts"],"names":[],"mappings":";;;AAAA,8EAAoD;AACpD,0EAAgD;AAChD,0EAAgD;AAChD,oEAA0C;AAC1C,wEAA8C;AAC9C,qEAA2C;AAC3C,yEAA+C","sourcesContent":["export * from './popular-searches.endpoint-adapter';\nexport * from './next-queries.endpoint-adapter';\nexport * from './related-tags.endpoint-adapter';\nexport * from './search.endpoint-adapter';\nexport * from './sku-search.endpoint-adapter';\nexport * from './tagging.endpoint-adapter';\nexport * from './top-clicked.endpoint-adapter';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/index.ts"],"names":[],"mappings":";;;AAAA,8EAAoD;AACpD,gFAAsD;AACtD,0EAAgD;AAChD,+EAAqD;AACrD,6EAAmD;AACnD,0EAAgD;AAChD,oEAA0C;AAC1C,8EAAoD;AACpD,qEAA2C;AAC3C,iFAAuD","sourcesContent":["export * from './popular-searches.endpoint-adapter';\nexport * from './identifier-results.endpoint-adapter';\nexport * from './next-queries.endpoint-adapter';\nexport * from './query-suggestions.endpoint-adapter';\nexport * from './recommendations.endpoint-adapter';\nexport * from './related-tags.endpoint-adapter';\nexport * from './search.endpoint-adapter';\nexport * from './semantic-queries.endpoint-adapter';\nexport * from './tagging.endpoint-adapter';\nexport * from './experience-controls.endpoint-adapter';\n"]}

package/dist/cjs/endpoint-adapters/next-queries.endpoint-adapter.js

@@ -1,13 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nextQueriesEndpointAdapter = exports.nextQueriesEndpointAdapterOptions = void 0;
-const x_adapter_next_1 = require("@empathyco/x-adapter-next");
+exports.nextQueriesEndpointAdapter = void 0;
+const x_adapter_1 = require("@empathyco/x-adapter");
+const next_queries_request_mapper_1 = require("../mappers/requests/next-queries-request.mapper");
 const next_queries_response_mapper_1 = require("../mappers/responses/next-queries-response.mapper");
-const base_request_mapper_1 = require("../mappers/requests/base-request.mapper");
-exports.nextQueriesEndpointAdapterOptions = {
-    endpoint: 'https://api.{env(.)}empathy.co/nextqueries/{instance}',
+/**
+ * This endpoint does not support pagination in the request.
+ *
+ * @public
+ */
+exports.nextQueriesEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
+    endpoint: 'https://api.{extraParams.env(.)}empathy.co/nextqueries/{extraParams.instance}',
+    requestMapper: next_queries_request_mapper_1.nextQueriesRequestMapper,
     responseMapper: next_queries_response_mapper_1.nextQueriesResponseMapper,
-    requestMapper: base_request_mapper_1.baseRequestMapper
-};
-exports.nextQueriesEndpointAdapter = (0, x_adapter_next_1.endpointAdapterFactory)(exports.nextQueriesEndpointAdapterOptions);
+    defaultRequestOptions: {
+        id: 'next-queries',
+        parameters: {
+            internal: true
+        }
+    }
+});
 //# sourceMappingURL=next-queries.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/next-queries.endpoint-adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"next-queries.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/next-queries.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,8DAA2F;AAG3F,oGAA8F;AAC9F,iFAA4E;AAE/D,QAAA,iCAAiC,GAG1C;IACF,QAAQ,EAAE,uDAAuD;IACjE,cAAc,EAAE,wDAAyB;IACzC,aAAa,EAAE,uCAAiB;CACjC,CAAC;AAEW,QAAA,0BAA0B,GAAG,IAAA,uCAAsB,EAAC,yCAAiC,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory, EndpointAdapterOptions } from '@empathyco/x-adapter-next';\nimport { BaseRequest } from '../types/request.types';\nimport { NextQueriesResponse } from '../types/response.types';\nimport { nextQueriesResponseMapper } from '../mappers/responses/next-queries-response.mapper';\nimport { baseRequestMapper } from '../mappers/requests/base-request.mapper';\n\nexport const nextQueriesEndpointAdapterOptions: EndpointAdapterOptions<\n  BaseRequest,\n  NextQueriesResponse\n> = {\n  endpoint: 'https://api.{env(.)}empathy.co/nextqueries/{instance}',\n  responseMapper: nextQueriesResponseMapper,\n  requestMapper: baseRequestMapper\n};\n\nexport const nextQueriesEndpointAdapter = endpointAdapterFactory(nextQueriesEndpointAdapterOptions);\n"]}
+{"version":3,"file":"next-queries.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/next-queries.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,oDAA8D;AAE9D,iGAA2F;AAC3F,oGAA8F;AAE9F;;;;GAIG;AACU,QAAA,0BAA0B,GAAG,IAAA,kCAAsB,EAG9D;IACA,QAAQ,EAAE,+EAA+E;IACzF,aAAa,EAAE,sDAAwB;IACvC,cAAc,EAAE,wDAAyB;IACzC,qBAAqB,EAAE;QACrB,EAAE,EAAE,cAAc;QAClB,UAAU,EAAE;YACV,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { NextQueriesRequest, NextQueriesResponse } from '@empathyco/x-types';\nimport { nextQueriesRequestMapper } from '../mappers/requests/next-queries-request.mapper';\nimport { nextQueriesResponseMapper } from '../mappers/responses/next-queries-response.mapper';\n\n/**\n * This endpoint does not support pagination in the request.\n *\n * @public\n */\nexport const nextQueriesEndpointAdapter = endpointAdapterFactory<\n  NextQueriesRequest,\n  NextQueriesResponse\n>({\n  endpoint: 'https://api.{extraParams.env(.)}empathy.co/nextqueries/{extraParams.instance}',\n  requestMapper: nextQueriesRequestMapper,\n  responseMapper: nextQueriesResponseMapper,\n  defaultRequestOptions: {\n    id: 'next-queries',\n    parameters: {\n      internal: true\n    }\n  }\n});\n"]}

package/dist/cjs/endpoint-adapters/popular-searches.endpoint-adapter.js

@@ -1,13 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.popularSearchesEndpointAdapter = void 0;
-const x_adapter_next_1 = require("@empathyco/x-adapter-next");
+const x_adapter_1 = require("@empathyco/x-adapter");
 const popular_searches_request_mapper_1 = require("../mappers/requests/popular-searches-request.mapper");
 // eslint-disable-next-line max-len
 const popular_searches_response_mapper_1 = require("../mappers/responses/popular-searches-response.mapper");
-exports.popularSearchesEndpointAdapter = (0, x_adapter_next_1.endpointAdapterFactory)({
+/**
+ * Default adapter for the popular searches endpoint.
+ *
+ * @public
+ */
+exports.popularSearchesEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
     endpoint: 'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/empathize',
     requestMapper: popular_searches_request_mapper_1.popularSearchesRequestMapper,
-    responseMapper: popular_searches_response_mapper_1.popularSearchesResponseMapper
+    responseMapper: popular_searches_response_mapper_1.popularSearchesResponseMapper,
+    defaultRequestOptions: {
+        id: 'popular-searches',
+        parameters: {
+            internal: true
+        }
+    }
 });
 //# sourceMappingURL=popular-searches.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/popular-searches.endpoint-adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"popular-searches.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/popular-searches.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,8DAAmE;AAEnE,yGAAmG;AACnG,mCAAmC;AACnC,4GAAsG;AAEzF,QAAA,8BAA8B,GAAG,IAAA,uCAAsB,EAGlE;IACA,QAAQ,EACN,6FAA6F;IAC/F,aAAa,EAAE,8DAA4B;IAC3C,cAAc,EAAE,gEAA6B;CAC9C,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter-next';\nimport { PopularSearchesRequest, PopularSearchesResponse } from '@empathyco/x-types';\nimport { popularSearchesRequestMapper } from '../mappers/requests/popular-searches-request.mapper';\n// eslint-disable-next-line max-len\nimport { popularSearchesResponseMapper } from '../mappers/responses/popular-searches-response.mapper';\n\nexport const popularSearchesEndpointAdapter = endpointAdapterFactory<\n  PopularSearchesRequest,\n  PopularSearchesResponse\n>({\n  endpoint:\n    'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/empathize',\n  requestMapper: popularSearchesRequestMapper,\n  responseMapper: popularSearchesResponseMapper\n});\n"]}
+{"version":3,"file":"popular-searches.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/popular-searches.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,oDAA8D;AAE9D,yGAAmG;AACnG,mCAAmC;AACnC,4GAAsG;AAEtG;;;;GAIG;AACU,QAAA,8BAA8B,GAAG,IAAA,kCAAsB,EAGlE;IACA,QAAQ,EACN,6FAA6F;IAC/F,aAAa,EAAE,8DAA4B;IAC3C,cAAc,EAAE,gEAA6B;IAC7C,qBAAqB,EAAE;QACrB,EAAE,EAAE,kBAAkB;QACtB,UAAU,EAAE;YACV,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { PopularSearchesRequest, PopularSearchesResponse } from '@empathyco/x-types';\nimport { popularSearchesRequestMapper } from '../mappers/requests/popular-searches-request.mapper';\n// eslint-disable-next-line max-len\nimport { popularSearchesResponseMapper } from '../mappers/responses/popular-searches-response.mapper';\n\n/**\n * Default adapter for the popular searches endpoint.\n *\n * @public\n */\nexport const popularSearchesEndpointAdapter = endpointAdapterFactory<\n  PopularSearchesRequest,\n  PopularSearchesResponse\n>({\n  endpoint:\n    'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/empathize',\n  requestMapper: popularSearchesRequestMapper,\n  responseMapper: popularSearchesResponseMapper,\n  defaultRequestOptions: {\n    id: 'popular-searches',\n    parameters: {\n      internal: true\n    }\n  }\n});\n"]}

package/dist/cjs/endpoint-adapters/query-suggestions.endpoint-adapter.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.querySuggestionsEndpointAdapter = void 0;
+const x_adapter_1 = require("@empathyco/x-adapter");
+// eslint-disable-next-line max-len
+const query_suggestions_request_mapper_1 = require("../mappers/requests/query-suggestions-request.mapper");
+// eslint-disable-next-line max-len
+const query_suggestions_response_mapper_1 = require("../mappers/responses/query-suggestions-response.mapper");
+/**
+ * Default adapter for the query suggestions endpoint.
+ *
+ * @public
+ */
+exports.querySuggestionsEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
+    endpoint: 'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/empathize',
+    requestMapper: query_suggestions_request_mapper_1.querySuggestionsRequestMapper,
+    responseMapper: query_suggestions_response_mapper_1.querySuggestionsResponseMapper,
+    defaultRequestOptions: {
+        id: 'query-suggestions',
+        parameters: {
+            internal: true
+        }
+    }
+});
+//# sourceMappingURL=query-suggestions.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/query-suggestions.endpoint-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-suggestions.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/query-suggestions.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,oDAA8D;AAE9D,mCAAmC;AACnC,2GAAqG;AACrG,mCAAmC;AACnC,8GAAwG;AAExG;;;;GAIG;AACU,QAAA,+BAA+B,GAAG,IAAA,kCAAsB,EAGnE;IACA,QAAQ,EACN,6FAA6F;IAC/F,aAAa,EAAE,gEAA6B;IAC5C,cAAc,EAAE,kEAA8B;IAC9C,qBAAqB,EAAE;QACrB,EAAE,EAAE,mBAAmB;QACvB,UAAU,EAAE;YACV,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { QuerySuggestionsRequest, QuerySuggestionsResponse } from '@empathyco/x-types';\n// eslint-disable-next-line max-len\nimport { querySuggestionsRequestMapper } from '../mappers/requests/query-suggestions-request.mapper';\n// eslint-disable-next-line max-len\nimport { querySuggestionsResponseMapper } from '../mappers/responses/query-suggestions-response.mapper';\n\n/**\n * Default adapter for the query suggestions endpoint.\n *\n * @public\n */\nexport const querySuggestionsEndpointAdapter = endpointAdapterFactory<\n  QuerySuggestionsRequest,\n  QuerySuggestionsResponse\n>({\n  endpoint:\n    'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/empathize',\n  requestMapper: querySuggestionsRequestMapper,\n  responseMapper: querySuggestionsResponseMapper,\n  defaultRequestOptions: {\n    id: 'query-suggestions',\n    parameters: {\n      internal: true\n    }\n  }\n});\n"]}

package/dist/cjs/endpoint-adapters/recommendations.endpoint-adapter.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recommendationsEndpointAdapter = void 0;
+const x_adapter_1 = require("@empathyco/x-adapter");
+const recommendations_request_mapper_1 = require("../mappers/requests/recommendations-request.mapper");
+// eslint-disable-next-line max-len
+const recommendations_response_mapper_1 = require("../mappers/responses/recommendations-response.mapper");
+/**
+ * Default adapter for the recommendations' endpoint.
+ *
+ * @public
+ */
+exports.recommendationsEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
+    endpoint: 'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/topclicked',
+    requestMapper: recommendations_request_mapper_1.recommendationsRequestMapper,
+    responseMapper: recommendations_response_mapper_1.recommendationsResponseMapper,
+    defaultRequestOptions: {
+        id: 'recommendations',
+        parameters: {
+            internal: true
+        }
+    }
+});
+//# sourceMappingURL=recommendations.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/recommendations.endpoint-adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendations.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/recommendations.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,oDAA8D;AAE9D,uGAAkG;AAClG,mCAAmC;AACnC,0GAAqG;AAErG;;;;GAIG;AACU,QAAA,8BAA8B,GAAG,IAAA,kCAAsB,EAGlE;IACA,QAAQ,EACN,8FAA8F;IAChG,aAAa,EAAE,6DAA4B;IAC3C,cAAc,EAAE,+DAA6B;IAC7C,qBAAqB,EAAE;QACrB,EAAE,EAAE,iBAAiB;QACrB,UAAU,EAAE;YACV,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { RecommendationsRequest, RecommendationsResponse } from '@empathyco/x-types';\nimport { recommendationsRequestMapper } from '../mappers/requests/recommendations-request.mapper';\n// eslint-disable-next-line max-len\nimport { recommendationsResponseMapper } from '../mappers/responses/recommendations-response.mapper';\n\n/**\n * Default adapter for the recommendations' endpoint.\n *\n * @public\n */\nexport const recommendationsEndpointAdapter = endpointAdapterFactory<\n  RecommendationsRequest,\n  RecommendationsResponse\n>({\n  endpoint:\n    'https://api.{extraParams.env(.)}empathy.co/search/v1/query/{extraParams.instance}/topclicked',\n  requestMapper: recommendationsRequestMapper,\n  responseMapper: recommendationsResponseMapper,\n  defaultRequestOptions: {\n    id: 'recommendations',\n    parameters: {\n      internal: true\n    }\n  }\n});\n"]}

package/dist/cjs/endpoint-adapters/related-tags.endpoint-adapter.js

@@ -1,13 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.relatedTagsEndpointAdapter = exports.relatedTagsEndpointAdapterOptions = void 0;
-const x_adapter_next_1 = require("@empathyco/x-adapter-next");
+exports.relatedTagsEndpointAdapter = void 0;
+const x_adapter_1 = require("@empathyco/x-adapter");
+const related_tags_request_mapper_1 = require("../mappers/requests/related-tags-request.mapper");
 const related_tags_response_mapper_1 = require("../mappers/responses/related-tags-response.mapper");
-const base_request_mapper_1 = require("../mappers/requests/base-request.mapper");
-exports.relatedTagsEndpointAdapterOptions = {
-    endpoint: 'https://api.{env(.)}empathy.co/relatedtags/{instance}',
+/**
+ * This endpoint does not support pagination in the request.
+ *
+ * @public
+ */
+exports.relatedTagsEndpointAdapter = (0, x_adapter_1.endpointAdapterFactory)({
+    endpoint: 'https://api.{extraParams.env(.)}empathy.co/relatedtags/{extraParams.instance}',
+    requestMapper: related_tags_request_mapper_1.relatedTagsRequestMapper,
     responseMapper: related_tags_response_mapper_1.relatedTagsResponseMapper,
-    requestMapper: base_request_mapper_1.baseRequestMapper
-};
-exports.relatedTagsEndpointAdapter = (0, x_adapter_next_1.endpointAdapterFactory)(exports.relatedTagsEndpointAdapterOptions);
+    defaultRequestOptions: {
+        id: 'related-tags',
+        parameters: {
+            internal: true
+        }
+    }
+});
 //# sourceMappingURL=related-tags.endpoint-adapter.js.map

package/dist/cjs/endpoint-adapters/related-tags.endpoint-adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"related-tags.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/related-tags.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,8DAA2F;AAG3F,oGAA8F;AAC9F,iFAA4E;AAE/D,QAAA,iCAAiC,GAG1C;IACF,QAAQ,EAAE,uDAAuD;IACjE,cAAc,EAAE,wDAAyB;IACzC,aAAa,EAAE,uCAAiB;CACjC,CAAC;AAEW,QAAA,0BAA0B,GAAG,IAAA,uCAAsB,EAAC,yCAAiC,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory, EndpointAdapterOptions } from '@empathyco/x-adapter-next';\nimport { BaseRequest } from '../types/request.types';\nimport { RelatedTagsResponse } from '../types/response.types';\nimport { relatedTagsResponseMapper } from '../mappers/responses/related-tags-response.mapper';\nimport { baseRequestMapper } from '../mappers/requests/base-request.mapper';\n\nexport const relatedTagsEndpointAdapterOptions: EndpointAdapterOptions<\n  BaseRequest,\n  RelatedTagsResponse\n> = {\n  endpoint: 'https://api.{env(.)}empathy.co/relatedtags/{instance}',\n  responseMapper: relatedTagsResponseMapper,\n  requestMapper: baseRequestMapper\n};\n\nexport const relatedTagsEndpointAdapter = endpointAdapterFactory(relatedTagsEndpointAdapterOptions);\n"]}
+{"version":3,"file":"related-tags.endpoint-adapter.js","sourceRoot":"","sources":["../../../src/endpoint-adapters/related-tags.endpoint-adapter.ts"],"names":[],"mappings":";;;AAAA,oDAA8D;AAE9D,iGAA2F;AAC3F,oGAA8F;AAE9F;;;;GAIG;AACU,QAAA,0BAA0B,GAAG,IAAA,kCAAsB,EAG9D;IACA,QAAQ,EAAE,+EAA+E;IACzF,aAAa,EAAE,sDAAwB;IACvC,cAAc,EAAE,wDAAyB;IACzC,qBAAqB,EAAE;QACrB,EAAE,EAAE,cAAc;QAClB,UAAU,EAAE;YACV,QAAQ,EAAE,IAAI;SACf;KACF;CACF,CAAC,CAAC","sourcesContent":["import { endpointAdapterFactory } from '@empathyco/x-adapter';\nimport { RelatedTagsRequest, RelatedTagsResponse } from '@empathyco/x-types';\nimport { relatedTagsRequestMapper } from '../mappers/requests/related-tags-request.mapper';\nimport { relatedTagsResponseMapper } from '../mappers/responses/related-tags-response.mapper';\n\n/**\n * This endpoint does not support pagination in the request.\n *\n * @public\n */\nexport const relatedTagsEndpointAdapter = endpointAdapterFactory<\n  RelatedTagsRequest,\n  RelatedTagsResponse\n>({\n  endpoint: 'https://api.{extraParams.env(.)}empathy.co/relatedtags/{extraParams.instance}',\n  requestMapper: relatedTagsRequestMapper,\n  responseMapper: relatedTagsResponseMapper,\n  defaultRequestOptions: {\n    id: 'related-tags',\n    parameters: {\n      internal: true\n    }\n  }\n});\n"]}