@empathyco/x-adapter-platform 1.1.0-alpha.8 → 1.1.0

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

@@ -9,7 +9,7 @@ import { EndpointAdapter } from '@empathyco/x-adapter';
 import { ExtendableEndpointAdapter } from '@empathyco/x-adapter';
 import { Mapper } from '@empathyco/x-adapter';
 import { MutableSchema } from '@empathyco/x-adapter';
-import { Schema } from '@empathyco/x-adapter';
+import type { Schema } from '@empathyco/x-adapter';
 
 // Warning: (ae-forgotten-export) The symbol "Facet" needs to be exported by the entry point index.d.ts
 // Warning: (ae-internal-missing-underscore) The name "AdapterHierarchicalFacet" should be prefixed with an underscore because the declaration is marked as @internal
@@ -31,6 +31,85 @@ export interface AdapterHierarchicalFilter extends BooleanFilter {
     parentId: Filter['id'] | null;
 }
 
+// Warning: (ae-forgotten-export) The symbol "AiQuestionsRequest" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "AiQuestionsResponse" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const aiQuestionsEndpointAdapter: ExtendableEndpointAdapter<AiQuestionsRequest, AiQuestionsResponse>;
+
+// @public
+export const aiQuestionsRequestMapper: Mapper<AiQuestionsRequest, PlatformAiQuestionsRequest>;
+
+// @public
+export const aiQuestionsRequestSchema: MutableSchema<AiQuestionsRequest, PlatformAiQuestionsRequest>;
+
+// @public
+export const aiQuestionsResponseMapper: Mapper<PlatformAiQuestionsResponse, AiQuestionsResponse>;
+
+// @public
+export const aiQuestionsResponseSchema: MutableSchema<PlatformAiQuestionsResponse, AiQuestionsResponse>;
+
+// @public
+export const aiQuestionsSchema: MutableSchema<PlatformAiQuestionsResponse, AiQuestionsResponse>;
+
+// Warning: (ae-forgotten-export) The symbol "AiSuggestionSearch" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const aiSuggestionSearchSchema: MutableSchema<PlatformAiSuggestionSearch, AiSuggestionSearch>;
+
+// Warning: (ae-forgotten-export) The symbol "AiSuggestionsRequest" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const aiSuggestionsEndpointAdapter: ExtendableEndpointAdapter<AiSuggestionsRequest, Response>;
+
+// @public
+export const aiSuggestionsRequestMapper: Mapper<AiSuggestionsRequest, PlatformAiSuggestionsRequest>;
+
+// Warning: (ae-forgotten-export) The symbol "AiSuggestionsSearchRequest" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "AiSuggestionsSearchResponse" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const aiSuggestionsSearchEndpointAdapter: ExtendableEndpointAdapter<AiSuggestionsSearchRequest, AiSuggestionsSearchResponse>;
+
+// @public
+export const aiSuggestionsSearchRequestMapper: Mapper<AiSuggestionsSearchRequest, PlatformAiSuggestionsSearchRequest>;
+
+// @public
+export const aiSuggestionsSearchRequestSchema: MutableSchema<AiSuggestionsSearchRequest, PlatformAiSuggestionsSearchRequest>;
+
+// @public
+export const aiSuggestionsSearchResponseMapper: Mapper<PlatformAiSuggestionsSearchResponse, AiSuggestionsSearchResponse>;
+
+// @public
+export const aiSuggestionsSearchResponseSchema: MutableSchema<PlatformAiSuggestionsSearchResponse, AiSuggestionsSearchResponse>;
+
+// @public
+export const aiSuggestionsSearchSchema: MutableSchema<PlatformAiSuggestionsSearchResponse, AiSuggestionsSearchResponse>;
+
+// @public
+export const aiSummarizeEndpointAdapter: ExtendableEndpointAdapter<AiSuggestionsRequest, Response>;
+
+// Warning: (ae-forgotten-export) The symbol "AiTasksRequest" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "AiTasksResponse" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const aiTasksEndpointAdapter: ExtendableEndpointAdapter<AiTasksRequest, AiTasksResponse>;
+
+// @public
+export const aiTasksRequestMapper: Mapper<AiTasksRequest, PlatformAiTasksRequest>;
+
+// @public
+export const aiTasksRequestSchema: MutableSchema<AiTasksRequest, PlatformAiTasksRequest>;
+
+// @public
+export const aiTasksResponseMapper: Mapper<PlatformAiTasksResponse, AiTasksResponse>;
+
+// @public
+export const aiTasksResponseSchema: MutableSchema<PlatformAiTasksResponse, AiTasksResponse>;
+
+// @public
+export const aiTasksSchema: MutableSchema<PlatformAiTasksResponse, AiTasksResponse>;
+
 // Warning: (ae-forgotten-export) The symbol "Banner" needs to be exported by the entry point index.d.ts
 //
 // @public
@@ -70,13 +149,25 @@ export interface FacetConfig {
     schema: Schema;
 }
 
-// Warning: (ae-forgotten-export) The symbol "EditableNumberRangeFacet" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "HierarchicalFacet" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "NumberRangeFacet" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "SimpleFacet" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "EditableNumberRangeFacet" needs to be exported by the entry point index.d.ts
 //
 // @public
-export const facetSchema: MutableSchema<PlatformFacet, EditableNumberRangeFacet | HierarchicalFacet | NumberRangeFacet | SimpleFacet>;
+export const facetSchema: MutableSchema<PlatformFacet, HierarchicalFacet | NumberRangeFacet | SimpleFacet | EditableNumberRangeFacet>;
+
+// Warning: (ae-forgotten-export) The symbol "FacetsRequest" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "FacetsResponse" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const facetsEndpointAdapter: ExtendableEndpointAdapter<FacetsRequest, FacetsResponse>;
+
+// @public
+export const facetsRequestSchema: MutableSchema<FacetsRequest, PlatformFacetsRequest>;
+
+// @public
+export const facetsResponseMapper: Mapper<PlatformFacetsResponse, FacetsResponse>;
 
 // Warning: (ae-forgotten-export) The symbol "TaggingRequest" needs to be exported by the entry point index.d.ts
 //
@@ -112,12 +203,20 @@ export const identifierResultsResponseMapper: Mapper<PlatformIdentifierResultsRe
 // @public
 export const identifierResultsResponseSchema: MutableSchema<PlatformIdentifierResultsResponse, IdentifierResultsResponse>;
 
+// @public
+export function mapFilters(filters?: Record<string, Filter[]>): string[];
+
 // Warning: (ae-forgotten-export) The symbol "NextQueriesRequest" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "NextQueriesResponse" needs to be exported by the entry point index.d.ts
 //
 // @public
 export const nextQueriesEndpointAdapter: ExtendableEndpointAdapter<NextQueriesRequest, NextQueriesResponse>;
 
+// Warning: (ae-forgotten-export) The symbol "RelatedPromptNextQuery" needs to be exported by the entry point index.d.ts
+//
+// @public
+export const nextQueriesRelatedPromptsSchema: MutableSchema<string, RelatedPromptNextQuery>;
+
 // @public
 export const nextQueriesRequestMapper: Mapper<NextQueriesRequest, PlatformNextQueriesRequest>;
 
@@ -149,6 +248,16 @@ export const partialResultsSchema: MutableSchema<PlatformPartialResult, PartialR
 //
 // @public
 export interface PlatformAdapter extends XComponentsAdapter {
+    // (undocumented)
+    aiQuestions: ExtendableEndpointAdapter<AiQuestionsRequest, AiQuestionsResponse>;
+    // (undocumented)
+    aiSuggestions: ExtendableEndpointAdapter<AiSuggestionsRequest, Response>;
+    // (undocumented)
+    aiSuggestionsSearch: ExtendableEndpointAdapter<AiSuggestionsSearchRequest, AiSuggestionsSearchResponse>;
+    // (undocumented)
+    aiSummarize: ExtendableEndpointAdapter<AiSuggestionsRequest, Response>;
+    // (undocumented)
+    aiTasks: ExtendableEndpointAdapter<AiTasksRequest, AiTasksResponse>;
     // (undocumented)
     experienceControls: ExtendableEndpointAdapter<ExperienceControlsRequest, ExperienceControlsResponse>;
     // (undocumented)
@@ -197,6 +306,77 @@ export interface PlatformAdapter extends XComponentsAdapter {
 // @public
 export const platformAdapter: PlatformAdapter;
 
+// @public
+export interface PlatformAiQuestionsRequest {
+    // (undocumented)
+    context: {
+        lang: string;
+        instance?: string;
+        filters?: Record<string, unknown>;
+        query?: string;
+    };
+}
+
+// @public
+export interface PlatformAiQuestionsResponse extends AiQuestionsResponse {
+}
+
+// @public
+export interface PlatformAiSuggestionSearch {
+    // (undocumented)
+    numFound: number;
+    // (undocumented)
+    query: string;
+    // (undocumented)
+    results: PlatformResult[];
+    // (undocumented)
+    tagging?: {
+        query: string;
+    };
+}
+
+// @public
+export interface PlatformAiSuggestionsRequest {
+    // (undocumented)
+    context: {
+        query?: string;
+        lang: string;
+        instance?: string;
+        filters?: Record<string, unknown>;
+    };
+}
+
+// @public
+export interface PlatformAiSuggestionsSearchRequest {
+    // (undocumented)
+    context: {
+        lang: string;
+        instance?: string;
+        filters?: Record<string, unknown>;
+    };
+    // (undocumented)
+    queries: {
+        query: string;
+        categories: string[];
+    }[];
+}
+
+// @public
+export interface PlatformAiSuggestionsSearchResponse {
+    // (undocumented)
+    items: PlatformAiSuggestionSearch[];
+}
+
+// @public
+export interface PlatformAiTasksRequest {
+    // (undocumented)
+    taskId: string;
+}
+
+// @public
+export interface PlatformAiTasksResponse extends AiTasksResponse {
+}
+
 // @public
 export interface PlatformBanner {
     // (undocumented)
@@ -235,6 +415,22 @@ export interface PlatformFacet {
     values: PlatformFilter[];
 }
 
+// Warning: (ae-forgotten-export) The symbol "PlatformQueryableRequest" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "PlatformFilterableRequest" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "PlatformTrackableRequest" needs to be exported by the entry point index.d.ts
+//
+// @public
+export interface PlatformFacetsRequest extends PlatformQueryableRequest, PlatformFilterableRequest, PlatformTrackableRequest, PlatformExtraParamsRequest {
+}
+
+// @public
+export interface PlatformFacetsResponse {
+    // (undocumented)
+    catalog: {
+        facets: PlatformFacet[];
+    };
+}
+
 // @public
 export type PlatformFacetType = 'value' | 'hierarchical' | 'range' | 'editable-range';
 
@@ -256,9 +452,7 @@ export interface PlatformHierarchicalFilter extends PlatformFilter {
     children: PlatformFacet;
 }
 
-// Warning: (ae-forgotten-export) The symbol "PlatformQueryableRequest" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "PlatformPageableRequest" needs to be exported by the entry point index.d.ts
-// Warning: (ae-forgotten-export) The symbol "PlatformTrackableRequest" needs to be exported by the entry point index.d.ts
 //
 // @public
 export interface PlatformIdentifierResultsRequest extends PlatformQueryableRequest, PlatformPageableRequest, PlatformTrackableRequest, PlatformExtraParamsRequest {
@@ -379,11 +573,25 @@ export interface PlatformRelatedPrompt {
     // (undocumented)
     nextQueries: string[];
     // (undocumented)
+    suggestionImageUrl: string;
+    // (undocumented)
     suggestionText: string;
     // (undocumented)
+    tagging: PlatformRelatedPromptTagging;
+    // (undocumented)
     type: 'SYNTHETIC' | 'CURATED';
 }
 
+// @public
+export interface PlatformRelatedPromptNextQueriesTagging {
+    // (undocumented)
+    toolingDisplay: string;
+    // (undocumented)
+    toolingDisplayAdd2Cart: string;
+    // (undocumented)
+    toolingDisplayClick: string;
+}
+
 // @public
 export interface PlatformRelatedPromptsRequest extends PlatformQueryableRequest, PlatformExtraParamsRequest {
 }
@@ -398,6 +606,16 @@ export interface PlatformRelatedPromptsResponse {
     status: number;
 }
 
+// @public
+export interface PlatformRelatedPromptTagging {
+    // (undocumented)
+    nextQueries: Dictionary<PlatformRelatedPromptNextQueriesTagging>;
+    // (undocumented)
+    toolingDisplay: string;
+    // (undocumented)
+    toolingDisplayClick: string;
+}
+
 // @public
 export interface PlatformRelatedTag {
     // (undocumented)
@@ -452,7 +670,6 @@ export interface PlatformResult {
     tagging: PlatformTagging;
 }
 
-// Warning: (ae-forgotten-export) The symbol "PlatformFilterableRequest" needs to be exported by the entry point index.d.ts
 // Warning: (ae-forgotten-export) The symbol "PlatformSortableRequest" needs to be exported by the entry point index.d.ts
 //
 // @public