@empathyco/x-components 6.0.0-alpha.21 → 6.0.0-alpha.210

package/docs/API-reference/api/x-adapter-platform.aitasksresponseschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksResponseSchema](./x-adapter-platform.aitasksresponseschema.md)
+
+## aiTasksResponseSchema variable
+
+Default implementation for the AITasksResponseSchema.
+
+**Signature:**
+
+```typescript
+aiTasksResponseSchema: import("@empathyco/x-adapter").MutableSchema<PlatformAiTasksResponse, AiTasksResponse>
+```

package/docs/API-reference/api/x-adapter-platform.aitasksschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [aiTasksSchema](./x-adapter-platform.aitasksschema.md)
+
+## aiTasksSchema variable
+
+Default implementation for the AITasksSchema.
+
+**Signature:**
+
+```typescript
+aiTasksSchema: import("@empathyco/x-adapter").MutableSchema<PlatformAiTasksResponse, AiTasksResponse>
+```

package/docs/API-reference/api/x-adapter-platform.extracturlparameters.md

@@ -17,9 +17,39 @@ export declare function extractUrlParameters(url: string): {
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  url | string | The url string to manipulate. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+url
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The url string to manipulate.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/API-reference/api/x-adapter-platform.facetconfig.md

@@ -14,8 +14,60 @@ export interface FacetConfig
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [modelName](./x-adapter-platform.facetconfig.modelname.md) |  | FacetModelName |  |
-|  [schema](./x-adapter-platform.facetconfig.schema.md) |  | Schema |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[modelName](./x-adapter-platform.facetconfig.modelname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+FacetModelName
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[schema](./x-adapter-platform.facetconfig.schema.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Schema
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/API-reference/api/x-adapter-platform.facetschema.md

@@ -9,5 +9,5 @@ Default implementation for the FacetSchema.
 **Signature:**
 
 ```typescript
-facetSchema: import("@empathyco/x-adapter").MutableSchema<PlatformFacet, EditableNumberRangeFacet | HierarchicalFacet | NumberRangeFacet | SimpleFacet>
+facetSchema: import("@empathyco/x-adapter").MutableSchema<PlatformFacet, HierarchicalFacet | NumberRangeFacet | SimpleFacet | EditableNumberRangeFacet>
 ```

package/docs/API-reference/api/x-adapter-platform.facetsendpointadapter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsEndpointAdapter](./x-adapter-platform.facetsendpointadapter.md)
+
+## facetsEndpointAdapter variable
+
+Default adapter for the search endpoint.
+
+**Signature:**
+
+```typescript
+facetsEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<FacetsRequest, FacetsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.facetsrequestschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsRequestSchema](./x-adapter-platform.facetsrequestschema.md)
+
+## facetsRequestSchema variable
+
+Default implementation for the FacetsRequestSchema.
+
+**Signature:**
+
+```typescript
+facetsRequestSchema: import("@empathyco/x-adapter").MutableSchema<FacetsRequest, PlatformFacetsRequest>
+```

package/docs/API-reference/api/x-adapter-platform.facetsresponsemapper.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsResponseMapper](./x-adapter-platform.facetsresponsemapper.md)
+
+## facetsResponseMapper variable
+
+Default implementation for the FacetsResponseMapper.
+
+**Signature:**
+
+```typescript
+facetsResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformFacetsResponse, FacetsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.getdisplaytagginginfofromurl.md

@@ -14,9 +14,39 @@ export declare function getDisplayTaggingInfoFromUrl(displayTaggingUrl: string):
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  displayTaggingUrl | string | The url containing the displayClick tagging info. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+displayTaggingUrl
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The url containing the displayClick tagging info.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/API-reference/api/x-adapter-platform.getfacetconfig.md

@@ -14,9 +14,39 @@ export declare function getFacetConfig(type: PlatformFacetType): FacetConfig;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  type | [PlatformFacetType](./x-adapter-platform.platformfacettype.md) | The facet type to resolve the configuration. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+type
+
+
+</td><td>
+
+[PlatformFacetType](./x-adapter-platform.platformfacettype.md)
+
+
+</td><td>
+
+The facet type to resolve the configuration.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/API-reference/api/x-adapter-platform.gettagginginfofromurl.md

@@ -14,9 +14,39 @@ export declare function getTaggingInfoFromUrl(taggingUrl: string): TaggingReques
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  taggingUrl | string | The url containing the tagging info. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+taggingUrl
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The url containing the tagging info.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/API-reference/api/x-adapter-platform.mapfilters.md

@@ -0,0 +1,110 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [mapFilters](./x-adapter-platform.mapfilters.md)
+
+## mapFilters() function
+
+Converts the filters to the shape the Platform's API is expecting.
+
+**Signature:**
+
+```typescript
+export declare function mapFilters(filters?: Record<string, Filter[]>): string[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+filters
+
+
+</td><td>
+
+Record&lt;string, Filter\[\]&gt;
+
+
+</td><td>
+
+_(Optional)_ The filters from our internal request.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string\[\]
+
+The filters ready to be consumed for the API.
+
+## Example
+
+
+```ts
+const filters = {
+  offer: [
+    {
+      facetId: 'offer',
+      modelName: 'SimpleFilter',
+      id: 'price:[0 TO 10]',
+      selected: true,
+      label: 'In Offer'
+    } as SimpleFilter
+  ],
+  categoryPaths: [
+    {
+      facetId: 'categoryPaths',
+      id: 'categoryIds:ffc61e1e9__be257cb26',
+      label: 'Fragrance',
+      modelName: 'HierarchicalFilter',
+      parentId: 'categoryIds:ffc61e1e9',
+      selected: true,
+      totalResults: 1
+    },
+    {
+      facetId: 'categoryPaths',
+      id: 'categoryIds:ffc61e1e9__fa5ef54f2',
+      label: 'Fragrance',
+      modelName: 'HierarchicalFilter',
+      parentId: 'categoryIds:ffc61e1e9',
+      selected: true,
+      totalResults: 1
+    },
+    {
+      children: ['categoryIds:ffc61e1e9__be257cb26', 'categoryIds:ffc61e1e9__fa5ef54f2'],
+      facetId: 'categoryPaths',
+      id: 'categoryIds:ffc61e1e9',
+      label: 'Personal Care',
+      modelName: 'HierarchicalFilter',
+      parentId: null,
+      selected: true,
+      totalResults: 1
+    }
+  ]
+};
+
+const mappedFilters = mapFilters({ filters });
+mappedFilters is [
+    'price:[0 TO 10]',
+    'categoryIds:ffc61e1e9__be257cb26',
+    'categoryIds:ffc61e1e9__fa5ef54f2'
+];
+```
+