@empathyco/x-components
Version:
Empathy X Components
1,460 lines (1,459 loc) • 277 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.39.0",
"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-types!",
"docComment": "/**\n * Search-types library with the search API models. It also includes model schemas for testing purpose.\n *\n * @remarks\n *\n * Entry point to export search-type models and testing schemas in a unified api-extractor model.\n *\n * @packageDocumentation\n */\n",
"name": "@empathyco/x-types",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@empathyco/x-types!",
"name": "",
"preserveMemberOrder": false,
"members": [
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!Banner:interface",
"docComment": "/**\n * A banner is an image with a title, that when clicked redirect the user to an URL. Often it is represented as a 100% wide element that appears on top of the results inside the grid or between rows.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Banner extends "
},
{
"kind": "Reference",
"text": "NamedModel",
"canonicalReference": "@empathyco/x-types!NamedModel:interface"
},
{
"kind": "Content",
"text": "<'Banner'>"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Identifiable",
"canonicalReference": "@empathyco/x-types!Identifiable:interface"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Taggable",
"canonicalReference": "@empathyco/x-types!Taggable:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/banner.model.ts",
"releaseTag": "Public",
"name": "Banner",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Banner#image:member",
"docComment": "/**\n * Banner image.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "image: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "image",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Banner#position:member",
"docComment": "/**\n * Banner position (= row) inside the grid.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "position?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "position",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Banner#title:member",
"docComment": "/**\n * Banner title.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "title?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "title",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Banner#url:member",
"docComment": "/**\n * URL to redirect.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "url?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "url",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
},
{
"startIndex": 4,
"endIndex": 5
},
{
"startIndex": 6,
"endIndex": 7
}
]
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!BannerSchema:var",
"docComment": "/**\n * Jest schema for validating Banner entities.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "BannerSchema: "
},
{
"kind": "Reference",
"text": "Banner",
"canonicalReference": "@empathyco/x-types!Banner:interface"
}
],
"fileUrlPath": "src/schemas/banner.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "BannerSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!BooleanFilter:interface",
"docComment": "/**\n * A boolean filter used in a {@link FacetFilter}, which status can be selected or not and it may contains the total results number that the filter should return.\n *\n * @remarks\n *\n * It is like an \"abstract\" interface because it is not going to be implemented but it is extended by other interfaces. There will never be an object with this type.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface BooleanFilter extends "
},
{
"kind": "Reference",
"text": "FacetFilter",
"canonicalReference": "@empathyco/x-types!FacetFilter:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/facet/filter/boolean-filter.model.ts",
"releaseTag": "Public",
"name": "BooleanFilter",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!BooleanFilter#label:member",
"docComment": "/**\n * Text to render the filter label.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "label: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!BooleanFilter#modelName:member",
"docComment": "/**\n * Type to narrow {@link ModelNameType} from the extended Filter for the known subtypes.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "modelName: "
},
{
"kind": "Reference",
"text": "BooleanFilterModelName",
"canonicalReference": "@empathyco/x-types!BooleanFilterModelName:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "modelName",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!BooleanFilter#totalResults:member",
"docComment": "/**\n * Amount of matching results.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "totalResults?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "totalResults",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-types!BooleanFilterModelName:type",
"docComment": "/**\n * Type to ease the usage of a model name in a {@link BooleanFilter} with autocomplete suggestions.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type BooleanFilterModelName = "
},
{
"kind": "Content",
"text": "(typeof "
},
{
"kind": "Reference",
"text": "BooleanFilterModelNames",
"canonicalReference": "@empathyco/x-types!BooleanFilterModelNames:var"
},
{
"kind": "Content",
"text": ")[number]"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/named-model.model.ts",
"releaseTag": "Public",
"name": "BooleanFilterModelName",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!BooleanFilterModelNames:var",
"docComment": "/**\n * Const to use in the {@link BooleanFilterModelName} Type definition and also in Type Guards.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "BooleanFilterModelNames: "
},
{
"kind": "Content",
"text": "readonly [\"SimpleFilter\", \"HierarchicalFilter\", \"NumberRangeFilter\"]"
}
],
"fileUrlPath": "src/named-model.model.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "BooleanFilterModelNames",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!BooleanFilterSchema:var",
"docComment": "/**\n * Jest schema for validating BooleanFilter entities.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "BooleanFilterSchema: "
},
{
"kind": "Reference",
"text": "BooleanFilter",
"canonicalReference": "@empathyco/x-types!BooleanFilter:interface"
}
],
"fileUrlPath": "src/schemas/filter.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "BooleanFilterSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet:interface",
"docComment": "/**\n * Editable Number Range Facet is a trait for filtering results using user editable {@link RangeValue}.Editable means that the value max and min can be changed by the user instead of havingseveral boolean filters with different values. It extends from {@link Facet},changes the modelName and uses {@link EditableNumberRangeFilter} as filters.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EditableNumberRangeFacet extends "
},
{
"kind": "Reference",
"text": "Facet",
"canonicalReference": "@empathyco/x-types!Facet:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/facet/editable-number-range-facet.model.ts",
"releaseTag": "Public",
"name": "EditableNumberRangeFacet",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet#filters:member",
"docComment": "/**\n * Filters available for the facet.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "filters: "
},
{
"kind": "Reference",
"text": "EditableNumberRangeFilter",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "filters",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet#modelName:member",
"docComment": "/**\n * Model name to indicate the facet type.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "modelName: "
},
{
"kind": "Content",
"text": "'EditableNumberRangeFacet'"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "modelName",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFacetSchema:var",
"docComment": "/**\n * Jest schema for validating EditableNumberRangeFacet entity.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "EditableNumberRangeFacetSchema: "
},
{
"kind": "Reference",
"text": "EditableNumberRangeFacet",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFacet:interface"
}
],
"fileUrlPath": "src/schemas/facet.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "EditableNumberRangeFacetSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface",
"docComment": "/**\n * A type of filter used in {@link EditableNumberRangeFacet} and extends from {@link FacetFilter}. This filter has the particularity that its {@link RangeValue} is editable by the user. Editable means that the value max and min can be changed by the user instead of having several boolean filters with different values.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EditableNumberRangeFilter extends "
},
{
"kind": "Reference",
"text": "FacetFilter",
"canonicalReference": "@empathyco/x-types!FacetFilter:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/facet/filter/editable-number-range-filter.model.ts",
"releaseTag": "Public",
"name": "EditableNumberRangeFilter",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter#modelName:member",
"docComment": "/**\n * Model name to indicate the filter type.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "modelName: "
},
{
"kind": "Content",
"text": "'EditableNumberRangeFilter'"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "modelName",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter#range:member",
"docComment": "/**\n * Filter range to use in the frontend.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "range: "
},
{
"kind": "Reference",
"text": "RangeValue",
"canonicalReference": "@empathyco/x-types!RangeValue:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "range",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFilterSchema:var",
"docComment": "/**\n * Jest schema for validating EditableNumberRangeFilterSchema entity.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "EditableNumberRangeFilterSchema: "
},
{
"kind": "Reference",
"text": "EditableNumberRangeFilter",
"canonicalReference": "@empathyco/x-types!EditableNumberRangeFilter:interface"
}
],
"fileUrlPath": "src/schemas/filter.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "EditableNumberRangeFilterSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!ExperienceControlsRequest:interface",
"docComment": "/**\n * Request for Experience Controls endpoint.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ExperienceControlsRequest extends "
},
{
"kind": "Reference",
"text": "ExtraParamsRequest",
"canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/request/experience-controls-request.model.ts",
"releaseTag": "Public",
"name": "ExperienceControlsRequest",
"preserveMemberOrder": false,
"members": [],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!ExperienceControlsResponse:interface",
"docComment": "/**\n * Response for the experience controls endpoint.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ExperienceControlsResponse "
}
],
"fileUrlPath": "src/response/experience-controls-response.model.ts",
"releaseTag": "Public",
"name": "ExperienceControlsResponse",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!ExperienceControlsResponse#controls:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "controls: "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": "<unknown>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "controls",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!ExperienceControlsResponse#events:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "events: "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@empathyco/x-utils!Dictionary:type"
},
{
"kind": "Content",
"text": "<unknown>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "events",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface",
"docComment": "/**\n * Interface to support extra params in any request.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ExtraParamsRequest "
}
],
"fileUrlPath": "src/request/request.model.ts",
"releaseTag": "Public",
"name": "ExtraParamsRequest",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!ExtraParamsRequest#extraParams:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "extraParams?: "
},
{
"kind": "Content",
"text": "{\n [key: string]: unknown;\n }"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "extraParams",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!Facet:interface",
"docComment": "/**\n * Facet is a trait for filtering results. It uses {@link Filter} as filters.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Facet extends "
},
{
"kind": "Reference",
"text": "NamedModel",
"canonicalReference": "@empathyco/x-types!NamedModel:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FacetModelName",
"canonicalReference": "@empathyco/x-types!FacetModelName:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Identifiable",
"canonicalReference": "@empathyco/x-types!Identifiable:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/facet/facet.model.ts",
"releaseTag": "Public",
"name": "Facet",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Facet#filters:member",
"docComment": "/**\n * Filters available for the facet.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "filters: "
},
{
"kind": "Reference",
"text": "Filter",
"canonicalReference": "@empathyco/x-types!Filter:interface"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "filters",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Facet#label:member",
"docComment": "/**\n * Label that represents the facet text.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "label: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "label",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 5
},
{
"startIndex": 6,
"endIndex": 7
}
]
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!FacetFilter:interface",
"docComment": "/**\n * A filter which is associated with a {@link Facet}.\n *\n * @remarks\n *\n * It is like an \"abstract\" interface because it is not going to be implemented but it is extended by other interfaces. There will never be an object with this type.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface FacetFilter extends "
},
{
"kind": "Reference",
"text": "Filter",
"canonicalReference": "@empathyco/x-types!Filter:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/facet/filter/facet-filter.model.ts",
"releaseTag": "Public",
"name": "FacetFilter",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!FacetFilter#facetId:member",
"docComment": "/**\n * An unique ID that identifies the facet that uses this filter.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "facetId: "
},
{
"kind": "Reference",
"text": "Facet",
"canonicalReference": "@empathyco/x-types!Facet:interface"
},
{
"kind": "Content",
"text": "['id']"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "facetId",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!FacetFilter#modelName:member",
"docComment": "/**\n * The filter {@link ModelNameType | model name} excluding {@link RawFilter | RawFilter} model name.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "modelName: "
},
{
"kind": "Reference",
"text": "Exclude",
"canonicalReference": "!Exclude:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FilterModelName",
"canonicalReference": "@empathyco/x-types!FilterModelName:type"
},
{
"kind": "Content",
"text": ", 'RawFilter'>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "modelName",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 2
}
]
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!FacetFilterSchema:var",
"docComment": "/**\n * Jest schema for validating FacetFilter entities.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "FacetFilterSchema: "
},
{
"kind": "Reference",
"text": "FacetFilter",
"canonicalReference": "@empathyco/x-types!FacetFilter:interface"
}
],
"fileUrlPath": "src/schemas/filter.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "FacetFilterSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-types!FacetModelName:type",
"docComment": "/**\n * Facets model names type. It can be: SimpleFacet, HierarchicalFacet, NumberRangeFacet or EditableNumberRangeFacet.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type FacetModelName = "
},
{
"kind": "Content",
"text": "'SimpleFacet' | 'HierarchicalFacet' | 'NumberRangeFacet' | 'EditableNumberRangeFacet'"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/named-model.model.ts",
"releaseTag": "Public",
"name": "FacetModelName",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!FacetSchema:var",
"docComment": "/**\n * Jest schema for validating Facet entities.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "FacetSchema: "
},
{
"kind": "Reference",
"text": "Facet",
"canonicalReference": "@empathyco/x-types!Facet:interface"
}
],
"fileUrlPath": "src/schemas/facet.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "FacetSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!Filter:interface",
"docComment": "/**\n * A basic filter.\n *\n * @remarks\n *\n * It is like an \"abstract\" interface because it is not going to be implemented but it is extended by other interfaces. There will never be an object with this type.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Filter extends "
},
{
"kind": "Reference",
"text": "NamedModel",
"canonicalReference": "@empathyco/x-types!NamedModel:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "FilterModelName",
"canonicalReference": "@empathyco/x-types!FilterModelName:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "Identifiable",
"canonicalReference": "@empathyco/x-types!Identifiable:interface"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "src/facet/filter/filter.model.ts",
"releaseTag": "Public",
"name": "Filter",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!Filter#selected:member",
"docComment": "/**\n * Flag if the filter is selected or not.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "selected: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "selected",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 5
},
{
"startIndex": 6,
"endIndex": 7
}
]
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!FilterableRequest:interface",
"docComment": "/**\n * Interface for any Request with a `filters` parameter.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface FilterableRequest "
}
],
"fileUrlPath": "src/request/request.model.ts",
"releaseTag": "Public",
"name": "FilterableRequest",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@empathyco/x-types!FilterableRequest#filters:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "filters?: "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<string, "
},
{
"kind": "Reference",
"text": "Filter",
"canonicalReference": "@empathyco/x-types!Filter:interface"
},
{
"kind": "Content",
"text": "[]>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "filters",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@empathyco/x-types!FilterModelName:type",
"docComment": "/**\n * Filters model names type. It can be: {@link BooleanFilterModelName}, RawFilter or EditableNumberRangeFilter.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type FilterModelName = "
},
{
"kind": "Reference",
"text": "BooleanFilterModelName",
"canonicalReference": "@empathyco/x-types!BooleanFilterModelName:type"
},
{
"kind": "Content",
"text": " | 'EditableNumberRangeFilter' | 'RawFilter'"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "src/named-model.model.ts",
"releaseTag": "Public",
"name": "FilterModelName",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Variable",
"canonicalReference": "@empathyco/x-types!FilterSchema:var",
"docComment": "/**\n * Jest schema for validating Filter entities.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "FilterSchema: "
},
{
"kind": "Reference",
"text": "Filter",
"canonicalReference": "@empathyco/x-types!Filter:interface"
}
],
"fileUrlPath": "src/schemas/filter.schema.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "FilterSchema",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@empathyco/x-types!HierarchicalFacet:interface",
"docComment": "/**\n * Hierarchical facet is a trait for filtering results. It extends from {@link Facet} changes the modelName and uses {@link HierarchicalFilter} as filters.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface HierarchicalFacet extends "
},
{
"kind": "Reference",
"text": "Facet",
"canonicalReference": "@empathyco/x-types!Facet:interface"
},
{
"kind": "Content",