feat: add types for related prompts

empathyco · Oct 21, 2024 · 3c30f0b · 3c30f0b
1 parent 1aadc42
commit 3c30f0b
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 1 deletion.
diff --git a/packages/x-adapter-platform/src/platform.adapter.ts b/packages/x-adapter-platform/src/platform.adapter.ts
@@ -23,6 +23,7 @@ export const platformAdapter: PlatformAdapter = {
   recommendations: recommendationsEndpointAdapter,
   nextQueries: nextQueriesEndpointAdapter,
   querySuggestions: querySuggestionsEndpointAdapter,
+  relatedPrompts: undefined,
   relatedTags: relatedTagsEndpointAdapter,
   identifierResults: identifierResultsEndpointAdapter,
   tagging: taggingEndpointAdapter,

diff --git a/packages/x-adapter-platform/src/types/platform-adapter.types.ts b/packages/x-adapter-platform/src/types/platform-adapter.types.ts
@@ -33,6 +33,7 @@ export interface PlatformAdapter extends XComponentsAdapter {
   nextQueries: ExtendableEndpointAdapter<NextQueriesRequest, NextQueriesResponse>;
   recommendations: ExtendableEndpointAdapter<RecommendationsRequest, RecommendationsResponse>;
   querySuggestions: ExtendableEndpointAdapter<QuerySuggestionsRequest, QuerySuggestionsResponse>;
+  relatedPrompts: any;
   relatedTags: ExtendableEndpointAdapter<RelatedTagsRequest, RelatedTagsResponse>;
   identifierResults: ExtendableEndpointAdapter<IdentifierResultsRequest, IdentifierResultsResponse>;
   semanticQueries: ExtendableEndpointAdapter<SemanticQueriesRequest, SemanticQueriesResponse>;

diff --git a/packages/x-types/src/query-signals/index.ts b/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';
diff --git a/packages/x-types/src/query-signals/related-prompt.model.ts b/packages/x-types/src/query-signals/related-prompt.model.ts
@@ -0,0 +1,13 @@
+import { NamedModel } from '../named-model.model';
+
+/**
+ * Represents a related prompt.
+ */
+export interface RelatedPrompt extends NamedModel<'RelatedPrompt'> {
+  /** The next queries related to the prompt. */
+  nextQueries: string[];
+  /** The prompt. */
+  suggestionText: string;
+  /** The type of the prompt. */
+  type: string;
+}
diff --git a/packages/x-types/src/request/index.ts b/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';

diff --git a/packages/x-types/src/request/related-prompts-request.model.ts b/packages/x-types/src/request/related-prompts-request.model.ts
@@ -0,0 +1,6 @@
+import { ExtraParamsRequest, QueryableRequest } from './request.model';
+
+/**
+ * Request for Related Prompts endpoint.
+ */
+export interface RelatedPromptsRequest extends QueryableRequest, ExtraParamsRequest {}
diff --git a/packages/x-types/src/response/index.ts b/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';

diff --git a/packages/x-types/src/response/related-prompts-response.model.ts b/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 {
+  relatedPrompts: RelatedPrompt[];
+}
diff --git a/packages/x-types/src/schemas/related-prompt.schema.ts b/packages/x-types/src/schemas/related-prompt.schema.ts
@@ -0,0 +1,11 @@
+import { RelatedPrompt } from '../query-signals';
+
+/**
+ * Jest schema for validating Related Prompt entities.
+ */
+export const RelatedPromptSchema: RelatedPrompt = {
+  modelName: expect.any(String),
+  nextQueries: expect.any(Array),
+  suggestionText: expect.any(String),
+  type: expect.any(String)
+};
diff --git a/packages/x-types/src/x-components-adapter.model.ts b/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>;