@empathyco/x-components
Version:
Empathy X Components
1,449 lines • 3.16 MB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.52.8",
"schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"noStandardTags": true,
"tagDefinitions": [
{
"tagName": "@alpha",
"syntaxKind": "modifier"
},
{
"tagName": "@beta",
"syntaxKind": "modifier"
},
{
"tagName": "@defaultValue",
"syntaxKind": "block"
},
{
"tagName": "@decorator",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@deprecated",
"syntaxKind": "block"
},
{
"tagName": "@eventProperty",
"syntaxKind": "modifier"
},
{
"tagName": "@example",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@experimental",
"syntaxKind": "modifier"
},
{
"tagName": "@inheritDoc",
"syntaxKind": "inline"
},
{
"tagName": "@internal",
"syntaxKind": "modifier"
},
{
"tagName": "@label",
"syntaxKind": "inline"
},
{
"tagName": "@link",
"syntaxKind": "inline",
"allowMultiple": true
},
{
"tagName": "@override",
"syntaxKind": "modifier"
},
{
"tagName": "@packageDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@param",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@privateRemarks",
"syntaxKind": "block"
},
{
"tagName": "@public",
"syntaxKind": "modifier"
},
{
"tagName": "@readonly",
"syntaxKind": "modifier"
},
{
"tagName": "@remarks",
"syntaxKind": "block"
},
{
"tagName": "@returns",
"syntaxKind": "block"
},
{
"tagName": "@sealed",
"syntaxKind": "modifier"
},
{
"tagName": "@see",
"syntaxKind": "block"
},
{
"tagName": "@throws",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@typeParam",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@virtual",
"syntaxKind": "modifier"
},
{
"tagName": "@betaDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@internalRemarks",
"syntaxKind": "block"
},
{
"tagName": "@preapproved",
"syntaxKind": "modifier"
}
],
"supportForTags": {
"@alpha": true,
"@beta": true,
"@defaultValue": true,
"@decorator": true,
"@deprecated": true,
"@eventProperty": true,
"@example": true,
"@experimental": true,
"@inheritDoc": true,
"@internal": true,
"@label": true,
"@link": true,
"@override": true,
"@packageDocumentation": true,
"@param": true,
"@privateRemarks": true,
"@public": true,
"@readonly": true,
"@remarks": true,
"@returns": true,
"@sealed": true,
"@see": true,
"@throws": true,
"@typeParam": true,
"@virtual": true,
"@betaDocumentation": true,
"@internalRemarks": true,
"@preapproved": true
},
"reportUnsupportedHtmlElements": false
}
},
"kind": "Package",
"canonicalReference": "@empathyco/x-components!",
"docComment": "/**\n * X-Components is a library usable everywhere not only for search experiences.\n *\n * @packageDocumentation\n */\n",
"name": "@empathyco/x-components",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@empathyco/x-components!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionNamesFor:type",
"docComment": "/**\n * Returns the action names for a given module. They are the namespaced actions.\n *\n * @param ModuleName - The {@link XModuleName | module name}.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionNamesFor<ModuleName extends "
},
{
"kind": "Reference",
"text": "XModuleName",
"canonicalReference": "@empathyco/x-components!XModuleName:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "keyof "
},
{
"kind": "Reference",
"text": "ExtractActions",
"canonicalReference": "@empathyco/x-components!ExtractActions:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "XModulesTree",
"canonicalReference": "@empathyco/x-components!XModulesTree:interface"
},
{
"kind": "Content",
"text": "[ModuleName]>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/store.types.ts",
"releaseTag": "Public",
"name": "ActionNamesFor",
"typeParameters": [
{
"typeParameterName": "ModuleName",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionsClass:type",
"docComment": "/**\n * Type for implementing actions for a module with a class.\n *\n * @param Module - The module this actions belong to.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionsClass<Module extends "
},
{
"kind": "Reference",
"text": "AnyXStoreModule",
"canonicalReference": "@empathyco/x-components!AnyXStoreModule:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<Module['actions']>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "ActionsClass",
"typeParameters": [
{
"typeParameterName": "Module",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionsDictionary:type",
"docComment": "/**\n * Util type for being used on generic constraints which will only accept an object containing actions.\n *\n * @example\n *\n * Example constraint\n * ```typescript\n * // This function allows receiving any object who only contains actions;\n * function sampleFunction\\<Actions extends ActionsDictionary\\<Actions\\>\\>(actions: Actions): void;\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionsDictionary<Actions> = "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<keyof Actions, (payload?: any) => any>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "ActionsDictionary",
"typeParameters": [
{
"typeParameterName": "Actions",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!ActionsTree:type",
"docComment": "/**\n * Type-safe actions definition type. An object with this type is what it is needed to define {@link https://vuex.vuejs.org/ | Vuex} actions.\n *\n * @param State - The module state dictionary type definition.\n *\n * @param Getters - The module getters dictionary type definition.\n *\n * @param Mutations - The module mutation dictionary type definition.\n *\n * @param Actions - The module actions dictionary type definition.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type ActionsTree<State extends "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", Getters extends "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": ", Mutations extends "
},
{
"kind": "Reference",
"text": "MutationsDictionary",
"canonicalReference": "@empathyco/x-components!MutationsDictionary:type"
},
{
"kind": "Content",
"text": "<Mutations>"
},
{
"kind": "Content",
"text": ", Actions extends "
},
{
"kind": "Reference",
"text": "ActionsDictionary",
"canonicalReference": "@empathyco/x-components!ActionsDictionary:type"
},
{
"kind": "Content",
"text": "<Actions>"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n [Key in keyof Actions]: (context: "
},
{
"kind": "Reference",
"text": "XActionContext",
"canonicalReference": "@empathyco/x-components!XActionContext:interface"
},
{
"kind": "Content",
"text": "<State, Getters, Mutations, Actions>, payload: "
},
{
"kind": "Reference",
"text": "ExtractPayload",
"canonicalReference": "@empathyco/x-components!ExtractPayload:type"
},
{
"kind": "Content",
"text": "<Actions[Key]>) => "
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<Actions[Key]> | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<Actions[Key]>>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/store/actions.types.ts",
"releaseTag": "Public",
"name": "ActionsTree",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Getters",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Mutations",
"constraintTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Actions",
"constraintTokenRange": {
"startIndex": 8,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 11,
"endIndex": 22
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryPreviewInstanceWire:var",
"docComment": "/**\n * Adds a new instance in a query preview.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryPreviewInstanceWire: "
},
{
"kind": "Content",
"text": "import(\"../..\")."
},
{
"kind": "Reference",
"text": "Wire",
"canonicalReference": "@empathyco/x-components!Wire:type"
},
{
"kind": "Content",
"text": "<string>"
}
],
"fileUrlPath": "src/x-modules/queries-preview/wiring.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryPreviewInstanceWire",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Function",
"canonicalReference": "@empathyco/x-components!addQueryToHistory:function(1)",
"docComment": "/**\n * Default implementation for the {@link HistoryQueriesActions.addQueryToHistory}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param query - The query to try to add to the history.\n *\n * @returns A `void` promise that resolves when the history queries finishes updating.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistory: ({ state, dispatch }: "
},
{
"kind": "Reference",
"text": "HistoryQueriesActionContext",
"canonicalReference": "@empathyco/x-components!HistoryQueriesActionContext:type"
},
{
"kind": "Content",
"text": ", query: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Content",
"text": "void | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
}
],
"fileUrlPath": "src/x-modules/history-queries/store/actions/add-query-to-history.action.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ state, dispatch }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "query",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"name": "addQueryToHistory"
},
{
"kind": "Class",
"canonicalReference": "@empathyco/x-components!AddQueryToHistoryAction:class",
"docComment": "/**\n * Class implementation for the {@link HistoryQueriesActions.addQueryToHistory} action.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class AddQueryToHistoryAction implements "
},
{
"kind": "Reference",
"text": "ActionsClass",
"canonicalReference": "@empathyco/x-components!ActionsClass:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "HistoryQueriesXStoreModule",
"canonicalReference": "@empathyco/x-components!HistoryQueriesXStoreModule:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/x-modules/history-queries/store/actions/add-query-to-history.action.ts",
"releaseTag": "Public",
"isAbstract": false,
"name": "AddQueryToHistoryAction",
"preserveMemberOrder": false,
"members": [
{
"kind": "Method",
"canonicalReference": "@empathyco/x-components!AddQueryToHistoryAction#addQueryToHistory:member(1)",
"docComment": "/**\n * Default implementation for the {@link HistoryQueriesActions.addQueryToHistory}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions, provided by Vuex.\n *\n * @param query - The query to try to add to the history.\n *\n * @returns A `void` promise that resolves when the history queries finishes updating.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistory({ state, dispatch }: "
},
{
"kind": "Reference",
"text": "HistoryQueriesActionContext",
"canonicalReference": "@empathyco/x-components!HistoryQueriesActionContext:type"
},
{
"kind": "Content",
"text": ", query: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void | "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 8
},
"releaseTag": "Public",
"isProtected": false,
"overloadIndex": 1,
"parameters": [
{
"parameterName": "{ state, dispatch }",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "query",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"isOptional": false,
"isAbstract": false,
"name": "addQueryToHistory"
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 5
}
]
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryToHistoryQueries:var",
"docComment": "/**\n * Saves a new query into the history queries.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistoryQueries: "
},
{
"kind": "Content",
"text": "import(\"../..\")."
},
{
"kind": "Reference",
"text": "Wire",
"canonicalReference": "@empathyco/x-components!Wire:type"
},
{
"kind": "Content",
"text": "<string>"
}
],
"fileUrlPath": "src/x-modules/history-queries/wiring.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryToHistoryQueries",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-components!addQueryToHistoryQueriesFromPreview:var",
"docComment": "/**\n * Saves the selectedQueryPreview query into the history queries.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addQueryToHistoryQueriesFromPreview: "
},
{
"kind": "Content",
"text": "import(\"../..\")."
},
{
"kind": "Reference",
"text": "AnyWire",
"canonicalReference": "@empathyco/x-components!AnyWire:type"
}
],
"fileUrlPath": "src/x-modules/history-queries/wiring.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "addQueryToHistoryQueriesFromPreview",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-components!AiActionContext:type",
"docComment": "/**\n * Alias type for actions context of the {@link AiXStoreModule}.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type AiActionContext = "
},
{
"kind": "Reference",
"text": "XActionContext",
"canonicalReference": "@empathyco/x-components!XActionContext:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiState",
"canonicalReference": "@empathyco/x-components!AiState:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiGetters",
"canonicalReference": "@empathyco/x-components!AiGetters:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiMutations",
"canonicalReference": "@empathyco/x-components!AiMutations:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiActions",
"canonicalReference": "@empathyco/x-components!AiActions:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/x-modules/ai/store/types.ts",
"releaseTag": "Public",
"name": "AiActionContext",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 11
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-components!AiActions:interface",
"docComment": "/**\n * Ai module actions.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface AiActions "
}
],
"fileUrlPath": "src/x-modules/ai/store/types.ts",
"releaseTag": "Public",
"name": "AiActions",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiActions#fetchAndSaveAiSuggestions:member",
"docComment": "/**\n * Requests suggestions for the module ai.\n *\n * @param request - The ai suggestions request.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "fetchAndSaveAiSuggestions: "
},
{
"kind": "Content",
"text": "(request: "
},
{
"kind": "Reference",
"text": "AiSuggestionsRequest",
"canonicalReference": "@empathyco/x-components!AiSuggestionsRequest:interface"
},
{
"kind": "Content",
"text": " | null) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "fetchAndSaveAiSuggestions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiActions#fetchAndSaveAiSuggestionsSearch:member",
"docComment": "/**\n * Requests suggestions search for the module AI.\n *\n * @param expanded - The expanded state of the AI overview.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "fetchAndSaveAiSuggestionsSearch: "
},
{
"kind": "Content",
"text": "(expanded: boolean) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "fetchAndSaveAiSuggestionsSearch",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiActions#saveOrigin:member",
"docComment": "/**\n * Creates a {@link QueryOrigin} and saves it.\n *\n * @param originInit - The object to create the origin with.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "saveOrigin: "
},
{
"kind": "Content",
"text": "(originInit: "
},
{
"kind": "Reference",
"text": "QueryOriginInit",
"canonicalReference": "@empathyco/x-components!QueryOriginInit:type"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "saveOrigin",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiActions#setUrlParams:member",
"docComment": "/**\n * Checks if the URL has params on it and then updates the state with these values.\n *\n * @param urlParams - List of params from the url.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setUrlParams: "
},
{
"kind": "Content",
"text": "(urlParams: "
},
{
"kind": "Reference",
"text": "UrlParams",
"canonicalReference": "@empathyco/x-components!UrlParams:interface"
},
{
"kind": "Content",
"text": ") => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setUrlParams",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-components!AiConfig:interface",
"docComment": "/**\n * Configuration options for the {@link AiXModule}.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface AiConfig "
}
],
"fileUrlPath": "src/x-modules/ai/config.types.ts",
"releaseTag": "Public",
"name": "AiConfig",
"preserveMemberOrder": false,
"members": [],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-components!AiGetters:interface",
"docComment": "/**\n * Ai module getters.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface AiGetters "
}
],
"fileUrlPath": "src/x-modules/ai/store/types.ts",
"releaseTag": "Public",
"name": "AiGetters",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiGetters#query:member",
"docComment": "/**\n * The combination of the query and the selected related tags.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "query: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "query",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiGetters#suggestionsRequest:member",
"docComment": "/**\n * Request object to retrieve the streaming response using the ai suggestions adapter.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "suggestionsRequest: "
},
{
"kind": "Reference",
"text": "AiSuggestionsRequest",
"canonicalReference": "@empathyco/x-components!AiSuggestionsRequest:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "suggestionsRequest",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiGetters#suggestionsSearchRequest:member",
"docComment": "/**\n * Request object to retrieve the suggestions search based on queries or null if there is no valid queries to conform a valid request.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "suggestionsSearchRequest: "
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchRequest",
"canonicalReference": "@empathyco/x-components!AiSuggestionsSearchRequest:interface"
},
{
"kind": "Content",
"text": " | null"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "suggestionsSearchRequest",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-components!AiMutations:interface",
"docComment": "/**\n * Ai module mutations.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface AiMutations extends "
},
{
"kind": "Reference",
"text": "ConfigMutations",
"canonicalReference": "@empathyco/x-components!ConfigMutations:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiState",
"canonicalReference": "@empathyco/x-components!AiState:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "QueryMutations",
"canonicalReference": "@empathyco/x-components!QueryMutations:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/x-modules/ai/store/types.ts",
"releaseTag": "Public",
"name": "AiMutations",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#resetAiState:member",
"docComment": "/**\n * Resets the ai state.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "resetAiState: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "resetAiState",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setAiRelatedTags:member",
"docComment": "/**\n * Sets the related tags of the module.\n *\n * @param relatedTags - The new related tags to save to the state.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setAiRelatedTags: "
},
{
"kind": "Content",
"text": "(relatedTags: "
},
{
"kind": "Reference",
"text": "RelatedTag",
"canonicalReference": "@empathyco/x-components!RelatedTag_2:interface"
},
{
"kind": "Content",
"text": "[]) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setAiRelatedTags",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setIsNoResults:member",
"docComment": "/**\n * Sets the no results flag of the module.\n *\n * @param isNoResults - The new no results value.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setIsNoResults: "
},
{
"kind": "Content",
"text": "(isNoResults: boolean) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setIsNoResults",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setOrigin:member",
"docComment": "/**\n * Sets the origin of the module.\n *\n * @param origin - The new origin.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setOrigin: "
},
{
"kind": "Content",
"text": "(origin: "
},
{
"kind": "Reference",
"text": "QueryOrigin",
"canonicalReference": "@empathyco/x-components!QueryOrigin:type"
},
{
"kind": "Content",
"text": " | undefined | null) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setOrigin",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setParams:member",
"docComment": "/**\n * Sets the extra params of the module.\n *\n * @param params - The new extra params.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setParams: "
},
{
"kind": "Content",
"text": "(params: "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": "<unknown>) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setParams",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setQueries:member",
"docComment": "/**\n * Sets the queries from the streamed response.\n *\n * @param queries - The new queries.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setQueries: "
},
{
"kind": "Content",
"text": "(queries: "
},
{
"kind": "Reference",
"text": "AiSuggestionQuery",
"canonicalReference": "@empathyco/x-components!AiSuggestionQuery:interface"
},
{
"kind": "Content",
"text": "[]) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setQueries",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setResponseText:member",
"docComment": "/**\n * Sets the responseText from the streamed response.\n *\n * @param responseText - The new responseText.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setResponseText: "
},
{
"kind": "Content",
"text": "(responseText: string) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setResponseText",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setSelectedFilters:member",
"docComment": "/**\n * Sets the selected filters of the module.\n *\n * @param selectedFilters - The new selected filters to save to the state.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setSelectedFilters: "
},
{
"kind": "Content",
"text": "(selectedFilters: "
},
{
"kind": "Reference",
"text": "Filter",
"canonicalReference": "@empathyco/x-components!Filter:interface"
},
{
"kind": "Content",
"text": "[]) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setSelectedFilters",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-components!AiMutations#setSuggestionsLoading:member",
"docComment": "/**\n * Sets the loading for the suggestions response.\n *\n * @param tagging - The new tagging.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "setSuggestionsLoading: "
},
{
"kind": "Content",
"text": "(value: boolean) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "setSuggestionsLoading",
"prope