@empathyco/x-components
Version:
Empathy X Components
1,466 lines (1,465 loc) • 309 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.58.7",
"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": "@jsx",
"syntaxKind": "block"
},
{
"tagName": "@jsxRuntime",
"syntaxKind": "block"
},
{
"tagName": "@jsxFrag",
"syntaxKind": "block"
},
{
"tagName": "@jsxImportSource",
"syntaxKind": "block"
},
{
"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-adapter-platform!",
"docComment": "",
"name": "@empathyco/x-adapter-platform",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@empathyco/x-adapter-platform!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionSearchSchema:var",
"docComment": "/**\n * Default implementation for the AiSuggestionSearchSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionSearchSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionSearch",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionSearch:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiSuggestionSearch",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionSearch:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/models/ai/suggestion-search.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionSearchSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsEndpointAdapter:var",
"docComment": "/**\n * Default adapter for the Overview suggestions v1 endpoint.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsEndpointAdapter: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "ExtendableEndpointAdapter",
"canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiSuggestionsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Response",
"canonicalReference": "!Response:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/endpoint-adapters/ai/suggestions.endpoint-adapter.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsEndpointAdapter",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsRequestMapper:var",
"docComment": "/**\n * Default implementation for the aiSuggestionsRequestMapper.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsRequestMapper: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "Mapper",
"canonicalReference": "@empathyco/x-adapter!Mapper:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiSuggestionsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionsRequest:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/mappers/requests/ai/suggestions-request.mapper.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsRequestMapper",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsSearchEndpointAdapter:var",
"docComment": "/**\n * Default adapter for the ai suggestions search endpoint.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsSearchEndpointAdapter: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "ExtendableEndpointAdapter",
"canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchRequest",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/endpoint-adapters/ai/suggestions-search.endpoint-adapter.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsSearchEndpointAdapter",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsSearchRequestMapper:var",
"docComment": "/**\n * Default implementation for the aiSuggestionsSearchRequestMapper.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsSearchRequestMapper: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "Mapper",
"canonicalReference": "@empathyco/x-adapter!Mapper:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchRequest",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionsSearchRequest",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionsSearchRequest:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/mappers/requests/ai/suggestions-search-request.mapper.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsSearchRequestMapper",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsSearchRequestSchema:var",
"docComment": "/**\n * Default implementation for the AiOverviewSuggestionsSearchRequestSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsSearchRequestSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchRequest",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionsSearchRequest",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionsSearchRequest:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/requests/ai/suggestions-search-request.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsSearchRequestSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsSearchResponseMapper:var",
"docComment": "/**\n * Default implementation for the AiSuggestionsSearchResponseMapper.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsSearchResponseMapper: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "Mapper",
"canonicalReference": "@empathyco/x-adapter!Mapper:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/mappers/responses/ai/suggestions-search-response.mapper.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsSearchResponseMapper",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsSearchResponseSchema:var",
"docComment": "/**\n * Default implementation for the AIOverviewSuggestionsSearchResponseSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsSearchResponseSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/responses/ai/suggestions-search-response.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsSearchResponseSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!aiSuggestionsSearchSchema:var",
"docComment": "/**\n * Default implementation for the AIOverviewSuggestionsSearchSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "aiSuggestionsSearchSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformAiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformAiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "AiSuggestionsSearchResponse",
"canonicalReference": "@empathyco/x-adapter-platform!AiSuggestionsSearchResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/models/ai/suggestions-search.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "aiSuggestionsSearchSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!bannerSchema:var",
"docComment": "/**\n * Default implementation for the BannerSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "bannerSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformBanner",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformBanner:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Banner",
"canonicalReference": "@empathyco/x-adapter-platform!Banner:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/models/banner.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "bannerSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!experienceControlsEndpointAdapter:var",
"docComment": "/**\n * . Default adapter for the experience controls endpoint.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "experienceControlsEndpointAdapter: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "ExtendableEndpointAdapter",
"canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ExperienceControlsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ExperienceControlsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/endpoint-adapters/experience-controls.endpoint-adapter.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "experienceControlsEndpointAdapter",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!experienceControlsRequestMapper:var",
"docComment": "/**\n * Default implementation for the ExperienceControlsRequestMapper.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "experienceControlsRequestMapper: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "Mapper",
"canonicalReference": "@empathyco/x-adapter!Mapper:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ExperienceControlsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "PlatformExperienceControlsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsRequest:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/mappers/requests/experience-controls-request.mapper.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "experienceControlsRequestMapper",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!experienceControlsRequestSchema:var",
"docComment": "/**\n * Default implementation for the ExperienceControlsRequestSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "experienceControlsRequestSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ExperienceControlsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "PlatformExperienceControlsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsRequest:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/requests/experience-controls-request.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "experienceControlsRequestSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!experienceControlsResponseMapper:var",
"docComment": "/**\n * Default implementation for the ExperienceControlsResponseMapper.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "experienceControlsResponseMapper: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "Mapper",
"canonicalReference": "@empathyco/x-adapter!Mapper:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformExperienceControlsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsResponse:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ExperienceControlsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/mappers/responses/experience-controls-response.mapper.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "experienceControlsResponseMapper",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!experienceControlsResponseSchema:var",
"docComment": "/**\n * Default implementation for the ExperienceControlsResponseSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "experienceControlsResponseSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformExperienceControlsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformExperienceControlsResponse:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "ExperienceControlsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!ExperienceControlsResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/responses/experience-controls-response.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "experienceControlsResponseSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Function",
"canonicalReference": "@empathyco/x-adapter-platform!extractUrlParameters:function(1)",
"docComment": "/**\n * Returns the base url path and an object with the query parameters.\n *\n * @param url - The url string to manipulate.\n *\n * @returns The object with the url information.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function extractUrlParameters(url: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "{\n url: string;\n params?: "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, string[] | string>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/types/mappers/url.utils.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "url",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "extractUrlParameters"
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-adapter-platform!FacetConfig:interface",
"docComment": "/**\n * Facet configuration containing the model name and the schema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface FacetConfig "
}
],
"fileUrlPath": "dist/types/schemas/facets/types.d.ts",
"releaseTag": "Public",
"name": "FacetConfig",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-adapter-platform!FacetConfig#modelName:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "modelName: "
},
{
"kind": "Reference",
"text": "FacetModelName",
"canonicalReference": "@empathyco/x-adapter-platform!FacetModelName:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "modelName",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-adapter-platform!FacetConfig#schema:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "schema: "
},
{
"kind": "Reference",
"text": "Schema",
"canonicalReference": "@empathyco/x-adapter!Schema:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "schema",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!facetSchema:var",
"docComment": "/**\n * Default implementation for the FacetSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "facetSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformFacet",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformFacet:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "HierarchicalFacet",
"canonicalReference": "@empathyco/x-adapter-platform!HierarchicalFacet:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "NumberRangeFacet",
"canonicalReference": "@empathyco/x-adapter-platform!NumberRangeFacet:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "SimpleFacet",
"canonicalReference": "@empathyco/x-adapter-platform!SimpleFacet:interface"
},
{
"kind": "Content",
"text": " | "
},
{
"kind": "Reference",
"text": "EditableNumberRangeFacet",
"canonicalReference": "@empathyco/x-adapter-platform!EditableNumberRangeFacet:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/models/facet.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "facetSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 14
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!facetsEndpointAdapter:var",
"docComment": "/**\n * Default adapter for the search endpoint.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "facetsEndpointAdapter: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "ExtendableEndpointAdapter",
"canonicalReference": "@empathyco/x-adapter!ExtendableEndpointAdapter:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FacetsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!FacetsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "FacetsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!FacetsResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/endpoint-adapters/facets.endpoint-adapter.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "facetsEndpointAdapter",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!facetsRequestSchema:var",
"docComment": "/**\n * Default implementation for the FacetsRequestSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "facetsRequestSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FacetsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!FacetsRequest:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "PlatformFacetsRequest",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformFacetsRequest:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/schemas/requests/facets-request.schema.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "facetsRequestSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!facetsResponseMapper:var",
"docComment": "/**\n * Default implementation for the FacetsResponseMapper.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "facetsResponseMapper: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "Mapper",
"canonicalReference": "@empathyco/x-adapter!Mapper:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformFacetsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformFacetsResponse:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "FacetsResponse",
"canonicalReference": "@empathyco/x-adapter-platform!FacetsResponse:interface"
},
{
"kind": "Content",
"text": ">"
}
],
"fileUrlPath": "dist/types/mappers/responses/facets-response.mapper.d.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "facetsResponseMapper",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 8
}
},
{
"kind": "Function",
"canonicalReference": "@empathyco/x-adapter-platform!getDisplayTaggingInfoFromUrl:function(1)",
"docComment": "/**\n * Generates the displayClick tagging info.\n *\n * @param displayTaggingUrl - The url containing the displayClick tagging info.\n *\n * @returns The object with the tagging info.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getDisplayTaggingInfoFromUrl(displayTaggingUrl: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TaggingRequest",
"canonicalReference": "@empathyco/x-adapter-platform!TaggingRequest:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/types/mappers/url.utils.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "displayTaggingUrl",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "getDisplayTaggingInfoFromUrl"
},
{
"kind": "Function",
"canonicalReference": "@empathyco/x-adapter-platform!getFacetConfig:function(1)",
"docComment": "/**\n * Returns the facet's config.\n *\n * @param type - The facet type to resolve the configuration.\n *\n * @returns The facet's config.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getFacetConfig(type: "
},
{
"kind": "Reference",
"text": "PlatformFacetType",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformFacetType:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "FacetConfig",
"canonicalReference": "@empathyco/x-adapter-platform!FacetConfig:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/types/schemas/facets/utils.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "type",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "getFacetConfig"
},
{
"kind": "Function",
"canonicalReference": "@empathyco/x-adapter-platform!getTaggingInfoFromUrl:function(1)",
"docComment": "/**\n * Extracts the tagging info from a URL.\n *\n * @param taggingUrl - The url containing the tagging info.\n *\n * @returns The object with the tagging info.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getTaggingInfoFromUrl(taggingUrl: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "TaggingRequest",
"canonicalReference": "@empathyco/x-adapter-platform!TaggingRequest:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "dist/types/mappers/url.utils.d.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "taggingUrl",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "getTaggingInfoFromUrl"
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-adapter-platform!hierarchicalFilterSchema:var",
"docComment": "/**\n * Default implementation for the HierarchicalFilterSchema.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "hierarchicalFilterSchema: "
},
{
"kind": "Content",
"text": "import(\"@empathyco/x-adapter\")."
},
{
"kind": "Reference",
"text": "MutableSchema",
"canonicalReference": "@empathyco/x-adapter!MutableSchema:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PlatformHierarchicalFilter",
"canonicalReference": "@empathyco/x-adapter-platform!PlatformHierarchicalFilter:interface"
},
{
"kind": "Content",
"text": ", "
},