@empathyco/x-components 6.0.0-alpha.5 → 6.0.0-alpha.6

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

@@ -0,0 +1,11 @@
+<!-- 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; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [relatedPrompts](./x-adapter-platform.platformadapter.relatedprompts.md)
+
+## PlatformAdapter.relatedPrompts property
+
+**Signature:**
+
+```typescript
+relatedPrompts: any;
+```

package/docs/API-reference/api/x-types.md

@@ -69,6 +69,9 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [RecommendationsRequest](./x-types.recommendationsrequest.md) | Request for Recommendations endpoint. |
 |  [RecommendationsResponse](./x-types.recommendationsresponse.md) | Response for the recommendations endpoint. |
 |  [Redirection](./x-types.redirection.md) | A redirection (AKA Direct Link) is simply a URL. Normally, the user is just redirected to it after making a query that matches the configuration of this URL. In other cases it is shown as a button that the user can click, and which will trigger the redirect action. |
+|  [RelatedPrompt](./x-types.relatedprompt.md) | Represents a related prompt. |
+|  [RelatedPromptsRequest](./x-types.relatedpromptsrequest.md) | Request for Related Prompts endpoint. |
+|  [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md) | Response for the related prompts endpoint. |
 |  [RelatedTag](./x-types.relatedtag.md) | A related tag is just a term that refines the current query. |
 |  [RelatedTagsRequest](./x-types.relatedtagsrequest.md) | Request for Related Tags endpoint. |
 |  [RelatedTagsResponse](./x-types.relatedtagsresponse.md) | Response for the related tags endpoint. |

package/docs/API-reference/api/x-types.relatedprompt.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md)
+
+## RelatedPrompt interface
+
+Represents a related prompt.
+
+**Signature:**
+
+```typescript
+export interface RelatedPrompt extends NamedModel<'RelatedPrompt'> 
+```
+**Extends:** [NamedModel](./x-types.namedmodel.md)<!-- -->&lt;'RelatedPrompt'&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [nextQueries](./x-types.relatedprompt.nextqueries.md) |  | string\[\] | The next queries related to the prompt. |
+|  [suggestionText](./x-types.relatedprompt.suggestiontext.md) |  | string | The prompt. |
+|  [type](./x-types.relatedprompt.type.md) |  | string | The type of the prompt. |
+

package/docs/API-reference/api/x-types.relatedprompt.nextqueries.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [nextQueries](./x-types.relatedprompt.nextqueries.md)
+
+## RelatedPrompt.nextQueries property
+
+The next queries related to the prompt.
+
+**Signature:**
+
+```typescript
+nextQueries: string[];
+```

package/docs/API-reference/api/x-types.relatedprompt.suggestiontext.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [suggestionText](./x-types.relatedprompt.suggestiontext.md)
+
+## RelatedPrompt.suggestionText property
+
+The prompt.
+
+**Signature:**
+
+```typescript
+suggestionText: string;
+```

package/docs/API-reference/api/x-types.relatedprompt.type.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPrompt](./x-types.relatedprompt.md) &gt; [type](./x-types.relatedprompt.type.md)
+
+## RelatedPrompt.type property
+
+The type of the prompt.
+
+**Signature:**
+
+```typescript
+type: string;
+```

package/docs/API-reference/api/x-types.relatedpromptsrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPromptsRequest](./x-types.relatedpromptsrequest.md)
+
+## RelatedPromptsRequest interface
+
+Request for Related Prompts endpoint.
+
+**Signature:**
+
+```typescript
+export interface RelatedPromptsRequest extends QueryableRequest, ExtraParamsRequest 
+```
+**Extends:** [QueryableRequest](./x-types.queryablerequest.md)<!-- -->, [ExtraParamsRequest](./x-types.extraparamsrequest.md)
+

package/docs/API-reference/api/x-types.relatedpromptsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md)
+
+## RelatedPromptsResponse interface
+
+Response for the related prompts endpoint.
+
+**Signature:**
+
+```typescript
+export interface RelatedPromptsResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [relatedPrompts](./x-types.relatedpromptsresponse.relatedprompts.md) |  | [RelatedPrompt](./x-types.relatedprompt.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-types.relatedpromptsresponse.relatedprompts.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md) &gt; [relatedPrompts](./x-types.relatedpromptsresponse.relatedprompts.md)
+
+## RelatedPromptsResponse.relatedPrompts property
+
+**Signature:**
+
+```typescript
+relatedPrompts: RelatedPrompt[];
+```

package/docs/API-reference/api/x-types.xcomponentsadapter.md

@@ -20,6 +20,7 @@ export interface XComponentsAdapter
 |  [popularSearches](./x-types.xcomponentsadapter.popularsearches.md) |  | EndpointAdapter&lt;[PopularSearchesRequest](./x-types.popularsearchesrequest.md)<!-- -->, [PopularSearchesResponse](./x-types.popularsearchesresponse.md)<!-- -->&gt; |  |
 |  [querySuggestions](./x-types.xcomponentsadapter.querysuggestions.md) |  | EndpointAdapter&lt;[QuerySuggestionsRequest](./x-types.querysuggestionsrequest.md)<!-- -->, [QuerySuggestionsResponse](./x-types.querysuggestionsresponse.md)<!-- -->&gt; |  |
 |  [recommendations](./x-types.xcomponentsadapter.recommendations.md) |  | EndpointAdapter&lt;[RecommendationsRequest](./x-types.recommendationsrequest.md)<!-- -->, [RecommendationsResponse](./x-types.recommendationsresponse.md)<!-- -->&gt; |  |
+|  [relatedPrompts](./x-types.xcomponentsadapter.relatedprompts.md) |  | EndpointAdapter&lt;[RelatedPromptsRequest](./x-types.relatedpromptsrequest.md)<!-- -->, [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md)<!-- -->&gt; |  |
 |  [relatedTags](./x-types.xcomponentsadapter.relatedtags.md) |  | EndpointAdapter&lt;[RelatedTagsRequest](./x-types.relatedtagsrequest.md)<!-- -->, [RelatedTagsResponse](./x-types.relatedtagsresponse.md)<!-- -->&gt; |  |
 |  [search](./x-types.xcomponentsadapter.search.md) |  | EndpointAdapter&lt;[SearchRequest](./x-types.searchrequest.md)<!-- -->, [SearchResponse](./x-types.searchresponse.md)<!-- -->&gt; |  |
 |  [semanticQueries](./x-types.xcomponentsadapter.semanticqueries.md) |  | EndpointAdapter&lt;[SemanticQueriesRequest](./x-types.semanticqueriesrequest.md)<!-- -->, [SemanticQueriesResponse](./x-types.semanticqueriesresponse.md)<!-- -->&gt; |  |

package/docs/API-reference/api/x-types.xcomponentsadapter.relatedprompts.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [relatedPrompts](./x-types.xcomponentsadapter.relatedprompts.md)
+
+## XComponentsAdapter.relatedPrompts property
+
+**Signature:**
+
+```typescript
+relatedPrompts: EndpointAdapter<RelatedPromptsRequest, RelatedPromptsResponse>;
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "6.0.0-alpha.5",
+  "version": "6.0.0-alpha.6",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -70,12 +70,12 @@
   },
   "dependencies": {
     "@empathyco/x-adapter": "^8.1.0-alpha.0",
-    "@empathyco/x-adapter-platform": "^1.1.0-alpha.3",
+    "@empathyco/x-adapter-platform": "^1.1.0-alpha.4",
     "@empathyco/x-bus": "^1.0.3-alpha.1",
     "@empathyco/x-deep-merge": "^2.0.3-alpha.1",
     "@empathyco/x-logger": "^1.2.0-alpha.11",
     "@empathyco/x-storage-service": "^2.0.3-alpha.0",
-    "@empathyco/x-types": "^10.1.0-alpha.3",
+    "@empathyco/x-types": "^10.1.0-alpha.4",
     "@empathyco/x-utils": "^1.0.3-alpha.1",
     "@vue/devtools-api": "~6.5.0",
     "@vueuse/core": "~10.7.1",
@@ -137,5 +137,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "7b902304aa824dcb79eeeaea29b884d0a36a01cb"
+  "gitHead": "abc0d00d934bc6cd4052c2212d816321ab097742"
 }

package/report/x-adapter-platform.api.json

@@ -1840,6 +1840,33 @@
                 "endIndex": 7
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-adapter-platform!PlatformAdapter#relatedPrompts:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "relatedPrompts: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "relatedPrompts",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-adapter-platform!PlatformAdapter#relatedTags:member",

package/report/x-types.api.json

@@ -4580,6 +4580,217 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-types!RelatedPrompt:interface",
+          "docComment": "/**\n * Represents a related prompt.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RelatedPrompt extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "NamedModel",
+              "canonicalReference": "@empathyco/x-types!NamedModel:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<'RelatedPrompt'>"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/query-signals/related-prompt.model.ts",
+          "releaseTag": "Public",
+          "name": "RelatedPrompt",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-types!RelatedPrompt#nextQueries:member",
+              "docComment": "/**\n * The next queries related to the prompt.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "nextQueries: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "nextQueries",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-types!RelatedPrompt#suggestionText:member",
+              "docComment": "/**\n * The prompt.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "suggestionText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "suggestionText",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-types!RelatedPrompt#type:member",
+              "docComment": "/**\n * The type of the prompt.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "type: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "type",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-types!RelatedPromptsRequest:interface",
+          "docComment": "/**\n * Request for Related Prompts endpoint.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RelatedPromptsRequest extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryableRequest",
+              "canonicalReference": "@empathyco/x-types!QueryableRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "ExtraParamsRequest",
+              "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/request/related-prompts-request.model.ts",
+          "releaseTag": "Public",
+          "name": "RelatedPromptsRequest",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 4
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-types!RelatedPromptsResponse:interface",
+          "docComment": "/**\n * Response for the related prompts endpoint.\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RelatedPromptsResponse "
+            }
+          ],
+          "fileUrlPath": "src/response/related-prompts-response.model.ts",
+          "releaseTag": "Public",
+          "name": "RelatedPromptsResponse",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-types!RelatedPromptsResponse#relatedPrompts:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "relatedPrompts: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedPrompt",
+                  "canonicalReference": "@empathyco/x-types!RelatedPrompt:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "relatedPrompts",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-types!RelatedTag:interface",
@@ -7339,6 +7550,56 @@
                 "endIndex": 7
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-types!XComponentsAdapter#relatedPrompts:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "relatedPrompts: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "EndpointAdapter",
+                  "canonicalReference": "@empathyco/x-adapter!EndpointAdapter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedPromptsRequest",
+                  "canonicalReference": "@empathyco/x-types!RelatedPromptsRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedPromptsResponse",
+                  "canonicalReference": "@empathyco/x-types!RelatedPromptsResponse:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "relatedPrompts",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 7
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-types!XComponentsAdapter#relatedTags:member",

package/types/adapter/e2e-adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"e2e-adapter.d.ts","sourceRoot":"","sources":["../../../src/adapter/e2e-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,eAAe,EAA0B,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAG3F;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAMnC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,QAAQ,EACnD,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CASpC;AAED,eAAO,MAAM,UAAU,EAAE,kBAmBxB,CAAC"}
+{"version":3,"file":"e2e-adapter.d.ts","sourceRoot":"","sources":["../../../src/adapter/e2e-adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,eAAe,EAA0B,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAG3F;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAMnC,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,QAAQ,EACnD,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CASpC;AAED,eAAO,MAAM,UAAU,EAAE,kBAoBxB,CAAC"}