@empathyco/x-components

{ "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-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!AiQuestion:interface", "docComment": "/**\n * A question is an entity generated by the AI. It contains the question text, the response text and the search queries.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiQuestion " } ], "fileUrlPath": "src/ai/question.model.ts", "releaseTag": "Public", "name": "AiQuestion", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#content:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "content: " }, { "kind": "Content", "text": "{\n responseText?: string;\n searchQueries: string[];\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "content", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#expanded:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "expanded?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "expanded", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#id:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "id: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#metadata:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "metadata: " }, { "kind": "Content", "text": "{\n origin: string;\n source: string;\n createdAt: string;\n generatedWithModel: string;\n generatedWithConfig: string;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "metadata", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#responseText:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "responseText?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "responseText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#suggestionImageUrl:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestionImageUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "suggestionImageUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#suggestionText:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestionText: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestionText", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#tagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tagging?: " }, { "kind": "Content", "text": "{\n toolingDisplay: string;\n toolingDisplayClick: string;\n searchQueries: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, {\n toolingDisplay: string;\n toolingDisplayAdd2Cart: string;\n toolingDisplayClick: string;\n }>;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestion#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest:interface", "docComment": "/**\n * Request for the question endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiQuestionsRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/request/ai/questions.model.ts", "releaseTag": "Public", "name": "AiQuestionsRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest#lang:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "lang: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "lang", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsRequest#query:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "query?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "query", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse:interface", "docComment": "/**\n * Response for the question endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiQuestionsResponse " } ], "fileUrlPath": "src/response/ai/questions.model.ts", "releaseTag": "Public", "name": "AiQuestionsResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#context:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "context: " }, { "kind": "Content", "text": "{\n query?: string;\n lang: string;\n instance: string;\n filters?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "<string, unknown>;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "context", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#items:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "items: " }, { "kind": "Reference", "text": "AiQuestion", "canonicalReference": "@empathyco/x-types!AiQuestion:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "items", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#numItems:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "numItems: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#resolved:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "resolved: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resolved", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#taskId:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "taskId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "taskId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse#totalItems:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "totalItems: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "totalItems", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch:interface", "docComment": "/**\n * Each suggestion search is a query and the results of that query.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionSearch " } ], "fileUrlPath": "src/ai/suggestion-search.model.ts", "releaseTag": "Public", "name": "AiSuggestionSearch", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#numFound:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "numFound: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "numFound", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#query:member", "docComment": "", "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-types!AiSuggestionSearch#results:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "results: " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@empathyco/x-types!Result:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "results", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch#tagging:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tagging: " }, { "kind": "Content", "text": "{\n query: " }, { "kind": "Reference", "text": "TaggingRequest", "canonicalReference": "@empathyco/x-types!TaggingRequest:interface" }, { "kind": "Content", "text": ";\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "tagging", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 4 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionsRequest:interface", "docComment": "/**\n * Request for the ai suggestions endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionsRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FilterableRequest", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "QueryableRequest", "canonicalReference": "@empathyco/x-types!QueryableRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/request/ai/suggestions.model.ts", "releaseTag": "Public", "name": "AiSuggestionsRequest", "preserveMemberOrder": false, "members": [], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 }, { "startIndex": 7, "endIndex": 8 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchRequest:interface", "docComment": "/**\n * Request for the suggestions-search endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionsSearchRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "TrackableRequest", "canonicalReference": "@empathyco/x-types!TrackableRequest:interface" }, { "kind": "Content", "text": ", " }, { "kind": "Reference", "text": "FilterableRequest", "canonicalReference": "@empathyco/x-types!FilterableRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/request/ai/suggestions-search.model.ts", "releaseTag": "Public", "name": "AiSuggestionsSearchRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchRequest#queries:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "queries: " }, { "kind": "Content", "text": "{\n query: string;\n categories: string[];\n }[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "queries", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 }, { "startIndex": 3, "endIndex": 4 }, { "startIndex": 5, "endIndex": 6 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchResponse:interface", "docComment": "/**\n * Response for the AI suggestions search endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiSuggestionsSearchResponse " } ], "fileUrlPath": "src/response/ai/suggestions-search.model.ts", "releaseTag": "Public", "name": "AiSuggestionsSearchResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiSuggestionsSearchResponse#suggestions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "suggestions: " }, { "kind": "Reference", "text": "AiSuggestionSearch", "canonicalReference": "@empathyco/x-types!AiSuggestionSearch:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "suggestions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiTasksRequest:interface", "docComment": "/**\n * Request for the task endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiTasksRequest extends " }, { "kind": "Reference", "text": "ExtraParamsRequest", "canonicalReference": "@empathyco/x-types!ExtraParamsRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/request/ai/tasks.model.ts", "releaseTag": "Public", "name": "AiTasksRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiTasksRequest#taskId:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "taskId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "taskId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Interface", "canonicalReference": "@empathyco/x-types!AiTasksResponse:interface", "docComment": "/**\n * Response for the task endpoint.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface AiTasksResponse " } ], "fileUrlPath": "src/response/ai/tasks.model.ts", "releaseTag": "Public", "name": "AiTasksResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiTasksResponse#result:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "result: " }, { "kind": "Reference", "text": "AiQuestionsResponse", "canonicalReference": "@empathyco/x-types!AiQuestionsResponse:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "result", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@empathyco/x-types!AiTasksResponse#steps:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "steps: " }, { "kind": "Reference", "text": "StepEmpathising", "canonicalReference": "@empathyco/x-types!StepEmpathising:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "steps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "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 = " },