@brave/n8n-nodes-brave-search/dist/nodes/BraveSearch/operations/news/parameters.js

A n8n node for the Brave Search API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const data_1 = require("./data");
const parameters = [];
const optional_parameters = [];
parameters.push({
    displayName: 'Query',
    name: 'query',
    type: 'string',
    default: '',
    description: 'The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.',
    required: true,
}, {
    displayName: 'Count',
    name: 'count',
    type: 'number',
    default: 20,
    description: 'The number of news results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.',
    typeOptions: {
        minValue: 1,
        maxValue: 50,
    },
});
optional_parameters.push({
    displayName: 'Country',
    name: 'country',
    type: 'options',
    default: 'US',
    description: 'The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries.',
    options: data_1.CountryCodes.map(({ country, code }) => ({ name: country, value: code })),
}, {
    displayName: 'Search Language',
    name: 'search_lang',
    type: 'options',
    default: 'en',
    description: 'The language of the search query. The language string is limited to 2 character language codes of supported languages.',
    options: data_1.LanguageCodes.map(({ language, code }) => ({ name: language, value: code })),
}, {
    displayName: 'User Interface Language',
    name: 'ui_lang',
    type: 'options',
    default: 'en-US',
    description: 'User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#name-accept-language">RFC 9110</a>.',
    options: data_1.MarketCodes.map(({ country, language, code }) => ({
        name: `${language} (${country})`,
        value: code,
    })),
}, {
    displayName: 'Offset',
    name: 'offset',
    type: 'number',
    default: 0,
    description: 'The number of result sets to skip before returning results. The default is 0. Combine this parameter with <code>count</code> to paginate search results.',
    typeOptions: {
        minValue: 0,
        maxValue: 9,
    },
}, {
    displayName: 'Spellcheck',
    name: 'spellcheck',
    type: 'boolean',
    default: true,
    description: 'Whether to enable spellcheck for the search query. The default is true.',
}, {
    displayName: 'Safe Search',
    name: 'safesearch',
    type: 'options',
    default: 'moderate',
    description: 'Whether to enable safe search for the search query. The default is moderate.',
    options: [
        {
            name: 'Off',
            value: 'off',
        },
        {
            name: 'Moderate',
            value: 'moderate',
        },
        {
            name: 'Strict',
            value: 'strict',
        },
    ],
}, {
    displayName: 'Freshness',
    name: 'freshness',
    type: 'options',
    default: '',
    description: 'The freshness of the search query results',
    options: [
        {
            name: 'All Time',
            value: '',
        },
        {
            name: 'Past 24 Hours',
            value: 'pd',
        },
        {
            name: 'Past 7 Days',
            value: 'pw',
        },
        {
            name: 'Past Month',
            value: 'pm',
        },
        {
            name: 'Past Year',
            value: 'py',
        },
    ],
}, {
    displayName: 'Extra Snippets',
    name: 'extra_snippets',
    type: 'boolean',
    default: false,
    description: 'Whether to enable extra snippets for the search query. A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. Only available under Free AI, Base AI, Pro AI, Base Data, Pro Data and Custom plans.',
}, {
    displayName: 'Goggles',
    name: 'goggles',
    type: 'string',
    typeOptions: {
        multipleValues: true,
        multipleValueButtonText: 'Add Goggle URL',
    },
    default: [],
    description: 'Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports one or more URLs where the desired Goggle(s) will be found.',
    placeholder: 'Example: https://raw.githubusercontent.com/…/tech_blogs.goggle',
});
if (optional_parameters.length > 0) {
    parameters.push({
        displayName: 'Additional Parameters',
        name: 'additionalParameters',
        type: 'collection',
        default: {},
        placeholder: 'Add Parameter',
        options: optional_parameters,
    });
}
exports.default = parameters;
//# sourceMappingURL=parameters.js.map