feat: add types for related prompts

packages/x-types/src/query-signals/index.ts

@@ -1,4 +1,5 @@
 export * from './next-queries.model';
 export * from './next-query.model';
+export * from './related-prompt.model';
 export * from './related-tag.model';
 export * from './semantic-query.model';

packages/x-types/src/query-signals/related-prompt.model.ts

@@ -0,0 +1,14 @@
+import { NamedModel } from '../named-model.model';
+import { Previewable } from '../previewable.model';
+
+/**
+ * Represents a related prompt.
+ */
+export interface RelatedPrompt extends NamedModel<'RelatedPrompt'>, Required<Previewable> {
+  /** The next queries related to the prompt. */
+  nextQueries: Array<string>;
+  /** The prompt. */
+  suggestionText: string;
+  /** The type of the prompt. */
+  type: string;
+}

packages/x-types/src/request/index.ts

@@ -3,6 +3,7 @@ export * from './next-queries-request.model';
 export * from './popular-searches-request.model';
 export * from './query-suggestions-request.model';
 export * from './recommendations-request.model';
+export * from './related-prompts-request.model';
 export * from './related-tags-request.model';
 export * from './request.model';
 export * from './search-request.model';

packages/x-types/src/request/related-prompts-request.model.ts

@@ -0,0 +1,6 @@
+import { QueryableRequest } from './request.model';
+
+/**
+ * Request for Related Prompts endpoint.
+ */
+export interface RelatedPromptsRequest extends QueryableRequest {}

packages/x-types/src/response/index.ts

@@ -3,6 +3,7 @@ export * from './next-queries-response.model';
 export * from './popular-searches-response.model';
 export * from './query-suggestions-response.model';
 export * from './recommendations-response.model';
+export * from './related-prompts-response.model';
 export * from './related-tags-response.model';
 export * from './response.model';
 export * from './search-response.model';

packages/x-types/src/response/related-prompts-response.model.ts

@@ -0,0 +1,8 @@
+import { RelatedPrompt } from '../query-signals/related-prompt.model';
+
+/**
+ * Response for the related prompts endpoint.
+ */
+export interface RelatedPromptsResponse {
+  relatedPromptsProducts: RelatedPrompt[];
+}

packages/x-types/src/x-components-adapter.model.ts

@@ -6,6 +6,7 @@ import {
   PopularSearchesRequest,
   QuerySuggestionsRequest,
   RecommendationsRequest,
+  RelatedPromptsRequest,
   RelatedTagsRequest,
   SearchRequest,
   SemanticQueriesRequest,
@@ -20,7 +21,8 @@ import {
   RelatedTagsResponse,
   SearchResponse,
   SemanticQueriesResponse,
-  ExperienceControlsResponse
+  ExperienceControlsResponse,
+  RelatedPromptsResponse
 } from './response';
 
 export interface XComponentsAdapter {
@@ -29,6 +31,7 @@ export interface XComponentsAdapter {
   nextQueries: EndpointAdapter<NextQueriesRequest, NextQueriesResponse>;
   recommendations: EndpointAdapter<RecommendationsRequest, RecommendationsResponse>;
   querySuggestions: EndpointAdapter<QuerySuggestionsRequest, QuerySuggestionsResponse>;
+  relatedPrompts: EndpointAdapter<RelatedPromptsRequest, RelatedPromptsResponse>;
   relatedTags: EndpointAdapter<RelatedTagsRequest, RelatedTagsResponse>;
   identifierResults: EndpointAdapter<IdentifierResultsRequest, IdentifierResultsResponse>;
   tagging: EndpointAdapter<TaggingRequest, void>;