@oomol-lab/open-connector 1.9.1 → 1.9.3

package/src/providers/cloro/inputs.js

@@ -0,0 +1,680 @@
+const countryCodeSchema = {
+    description: "ISO 3166-1 alpha-2 country code.",
+    type: "string",
+    enum: [
+        "AD",
+        "AE",
+        "AF",
+        "AG",
+        "AI",
+        "AL",
+        "AM",
+        "AO",
+        "AQ",
+        "AR",
+        "AS",
+        "AT",
+        "AU",
+        "AW",
+        "AX",
+        "AZ",
+        "BA",
+        "BB",
+        "BD",
+        "BE",
+        "BF",
+        "BG",
+        "BH",
+        "BI",
+        "BJ",
+        "BL",
+        "BM",
+        "BN",
+        "BO",
+        "BQ",
+        "BR",
+        "BS",
+        "BT",
+        "BV",
+        "BW",
+        "BY",
+        "BZ",
+        "CA",
+        "CC",
+        "CD",
+        "CF",
+        "CG",
+        "CH",
+        "CI",
+        "CK",
+        "CL",
+        "CM",
+        "CN",
+        "CO",
+        "CR",
+        "CU",
+        "CV",
+        "CW",
+        "CX",
+        "CY",
+        "CZ",
+        "DE",
+        "DJ",
+        "DK",
+        "DM",
+        "DO",
+        "DZ",
+        "EC",
+        "EE",
+        "EG",
+        "EH",
+        "ER",
+        "ES",
+        "ET",
+        "FI",
+        "FJ",
+        "FK",
+        "FM",
+        "FO",
+        "FR",
+        "GA",
+        "GB",
+        "GD",
+        "GE",
+        "GF",
+        "GG",
+        "GH",
+        "GI",
+        "GL",
+        "GM",
+        "GN",
+        "GP",
+        "GQ",
+        "GR",
+        "GS",
+        "GT",
+        "GU",
+        "GW",
+        "GY",
+        "HK",
+        "HM",
+        "HN",
+        "HR",
+        "HT",
+        "HU",
+        "ID",
+        "IE",
+        "IL",
+        "IM",
+        "IN",
+        "IO",
+        "IQ",
+        "IR",
+        "IS",
+        "IT",
+        "JE",
+        "JM",
+        "JO",
+        "JP",
+        "KE",
+        "KG",
+        "KH",
+        "KI",
+        "KM",
+        "KN",
+        "KP",
+        "KR",
+        "KW",
+        "KY",
+        "KZ",
+        "LA",
+        "LB",
+        "LC",
+        "LI",
+        "LK",
+        "LR",
+        "LS",
+        "LT",
+        "LU",
+        "LV",
+        "LY",
+        "MA",
+        "MC",
+        "MD",
+        "ME",
+        "MF",
+        "MG",
+        "MH",
+        "MK",
+        "ML",
+        "MM",
+        "MN",
+        "MO",
+        "MP",
+        "MQ",
+        "MR",
+        "MS",
+        "MT",
+        "MU",
+        "MV",
+        "MW",
+        "MX",
+        "MY",
+        "MZ",
+        "NA",
+        "NC",
+        "NE",
+        "NF",
+        "NG",
+        "NI",
+        "NL",
+        "NO",
+        "NP",
+        "NR",
+        "NU",
+        "NZ",
+        "OM",
+        "PA",
+        "PE",
+        "PF",
+        "PG",
+        "PH",
+        "PK",
+        "PL",
+        "PM",
+        "PN",
+        "PR",
+        "PS",
+        "PT",
+        "PW",
+        "PY",
+        "QA",
+        "RE",
+        "RO",
+        "RS",
+        "RU",
+        "RW",
+        "SA",
+        "SB",
+        "SC",
+        "SD",
+        "SE",
+        "SG",
+        "SH",
+        "SI",
+        "SJ",
+        "SK",
+        "SL",
+        "SM",
+        "SN",
+        "SO",
+        "SR",
+        "SS",
+        "ST",
+        "SV",
+        "SX",
+        "SY",
+        "SZ",
+        "TC",
+        "TD",
+        "TF",
+        "TG",
+        "TH",
+        "TJ",
+        "TK",
+        "TL",
+        "TM",
+        "TN",
+        "TO",
+        "TR",
+        "TT",
+        "TV",
+        "TW",
+        "TZ",
+        "UA",
+        "UG",
+        "UM",
+        "US",
+        "UY",
+        "UZ",
+        "VA",
+        "VC",
+        "VE",
+        "VG",
+        "VI",
+        "VN",
+        "VU",
+        "WF",
+        "WS",
+        "XK",
+        "YE",
+        "YT",
+        "ZA",
+        "ZM",
+        "ZW",
+    ],
+};
+const stateParameterSchema = {
+    description: 'State code for sub-country geo-targeting (e.g., "CA"). Only valid with country "US". Paid add-on: +2 credits, on top of the base cost and any other add-on ([pricing](/guides/providers#state-level-targeting)).',
+    type: "string",
+    enum: [
+        "AL",
+        "AK",
+        "AZ",
+        "AR",
+        "CA",
+        "CO",
+        "CT",
+        "DE",
+        "DC",
+        "FL",
+        "GA",
+        "HI",
+        "ID",
+        "IL",
+        "IN",
+        "IA",
+        "KS",
+        "KY",
+        "LA",
+        "ME",
+        "MD",
+        "MA",
+        "MI",
+        "MN",
+        "MS",
+        "MO",
+        "MT",
+        "NE",
+        "NV",
+        "NH",
+        "NJ",
+        "NM",
+        "NY",
+        "NC",
+        "ND",
+        "OH",
+        "OK",
+        "OR",
+        "PA",
+        "RI",
+        "SC",
+        "SD",
+        "TN",
+        "TX",
+        "UT",
+        "VT",
+        "VA",
+        "WA",
+        "WV",
+        "WI",
+        "WY",
+    ],
+    minLength: 2,
+    maxLength: 2,
+    pattern: "^[A-Z]{2}$",
+};
+const glParameterSchema = {
+    description: "Alternative to `country`, using Google's own parameter name for the result geography. Same ISO 3166-1 alpha-2 codes, accepted in either case (`us` or `US`), and must be a country the endpoint supports — see `GET /v1/countries`. Provide `country` or `gl`; sending both with different values is a `400`.",
+    type: "string",
+};
+const hlParameterSchema = {
+    description: "Interface language, as Google's own `hl` parameter (e.g. `en`, `de`, `pt-BR`). Free-form and case-insensitive — Google owns the list of codes. Overrides the language cloro derives from the country, so the interface language and the result geography can differ.",
+    type: "string",
+};
+export const chatGPTMonitorRequest = {
+    required: ["prompt", "country"],
+    type: "object",
+    properties: {
+        prompt: {
+            description: "The prompt to send to ChatGPT, or an array of up to 5 prompts for a multi-turn conversation. With an array, ChatGPT answers the prompts in order, in the same conversation, and `result` is an array with one response for each prompt. Each prompt after the first costs +1 credit ([pricing](/guides/providers#chatgpt-additional-features)).",
+            oneOf: [
+                { type: "string", minLength: 1, maxLength: 10000, description: "prompt details. option." },
+                {
+                    type: "array",
+                    minItems: 1,
+                    maxItems: 5,
+                    items: {
+                        type: "string",
+                        minLength: 1,
+                        maxLength: 10000,
+                        description: "prompt details. option. item.",
+                    },
+                    description: "prompt details. option.",
+                },
+            ],
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "Country/region code for localized response, using ISO 3166-1 alpha-2 country codes.",
+        },
+        include: {
+            description: "Optional flags for including additional response formats",
+            type: "object",
+            properties: {
+                html: { description: "Include a URL to the full HTML of the response", type: "boolean" },
+                markdown: {
+                    description: "Include markdown-formatted response in the result",
+                    type: "boolean",
+                },
+                rawResponse: {
+                    description: "Include ChatGPT's raw response payload. Paid add-on: one flat +2 credits covers any combination of `rawResponse`, `searchQueries`, `ads` and `shopping` ([pricing](/guides/providers#chatgpt-additional-features)).",
+                    type: "boolean",
+                },
+                searchQueries: {
+                    description: "Include the query fan-out ChatGPT used to generate the response. Paid add-on: one flat +2 credits covers any combination of `rawResponse`, `searchQueries`, `ads` and `shopping` ([pricing](/guides/providers#chatgpt-additional-features)).",
+                    type: "boolean",
+                },
+                ads: {
+                    description: "Include ads displayed in ChatGPT response. ChatGPT currently shows ads only in answers to a follow-up prompt, and far more often on the legacy interface: send `prompt` as an array with `legacy: true`. Paid add-on: one flat +2 credits covers any combination of `rawResponse`, `searchQueries`, `ads` and `shopping` ([pricing](/guides/providers#chatgpt-additional-features)).",
+                    type: "boolean",
+                },
+                shopping: {
+                    description: "Include shopping cards and inline products with pricing and offers. Paid add-on: one flat +2 credits covers any combination of `rawResponse`, `searchQueries`, `ads` and `shopping` ([pricing](/guides/providers#chatgpt-additional-features)).",
+                    type: "boolean",
+                },
+            },
+            required: [],
+            additionalProperties: false,
+        },
+        legacy: {
+            description: "Serve ChatGPT's legacy desktop interface instead of the default mobile-web one. The legacy interface streams the answer as an event stream, so `result.model`, `result.searchQueries` and `result.mapSearchQueries` are populated. ChatGPT shows ads far more often on this interface. Best-effort and temporary: OpenAI controls which interface it serves and can retire the legacy one at any time, so a request can still come back in the mobile-web shape. Handle both. Defaults to false.",
+            type: "boolean",
+        },
+        disableWebSearch: {
+            description: "Do not force ChatGPT's web search. cloro returns the answer ChatGPT gives on its own, which uses web search only when ChatGPT decides to, so `result.sources`, `result.citationPills` and `result.searchQueries` are often empty. Defaults to false: web search is forced on every request.",
+            type: "boolean",
+        },
+        state: stateParameterSchema,
+    },
+    additionalProperties: false,
+    description: "ChatGPT monitoring parameters.",
+    allOf: [{ if: { required: ["state"] }, then: { properties: { country: { const: "US" } } } }],
+};
+export const geminiMonitorRequest = {
+    required: ["prompt", "country"],
+    type: "object",
+    properties: {
+        prompt: {
+            description: "The prompt to send to Gemini",
+            type: "string",
+            minLength: 1,
+            maxLength: 10000,
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "Country/region code for localized response, using ISO 3166-1 alpha-2 country codes.",
+        },
+        include: {
+            description: "Optional flags for including additional response formats",
+            type: "object",
+            properties: {
+                markdown: {
+                    description: "Include markdown-formatted response in the result",
+                    type: "boolean",
+                },
+                html: { description: "Include HTML-formatted response in the result", type: "boolean" },
+                rawResponse: { description: "Include raw streaming response events", type: "boolean" },
+            },
+            required: [],
+            additionalProperties: false,
+        },
+        state: stateParameterSchema,
+    },
+    additionalProperties: false,
+    description: "Gemini monitoring parameters.",
+    allOf: [{ if: { required: ["state"] }, then: { properties: { country: { const: "US" } } } }],
+};
+export const googleMonitorRequest = {
+    anyOf: [{ required: ["query", "country"] }, { required: ["query", "gl"] }, { required: ["url"] }],
+    type: "object",
+    properties: {
+        query: {
+            description: "The search query to execute on Google. Required unless you supply 'url' instead — the two are mutually exclusive.",
+            type: "string",
+            minLength: 1,
+            maxLength: 10000,
+        },
+        url: {
+            description: "A complete Google web search URL to run instead of building the request from 'query' and the targeting fields. Must be an absolute http(s) URL on a Google web search host (google.com, google.co.uk, www.google.de, ...), with the path '/search' and a non-empty 'q'. Mutually exclusive with 'query', 'location', 'uule' and 'pages' — the URL owns those values. cloro applies a fixed set of query parameters — 'q', 'gl', 'hl', 'uule', 'num' (read as result depth), 'start', 'tbs' and 'safe' — and drops anything else. URLs carrying 'tbm' are rejected, because they target a Google vertical with its own endpoint and pricing (use POST /v1/monitor/google/news for tbm=nws).",
+            type: "string",
+            format: "uri",
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "ISO 3166-1 alpha-2 country code for localized search results. See [List of countries](/api-reference/endpoint/countries) for the codes each provider supports. Required in the standard request shape unless you send `gl`. When you supply 'url' instead, country is derived from the URL's 'gl' — pass it explicitly to override that, or when the URL has no 'gl'.",
+        },
+        gl: glParameterSchema,
+        hl: hlParameterSchema,
+        location: {
+            ...glParameterSchema,
+            description: "Google canonical location name for geo-targeted results, in comma-separated format: 'City,Region,Country' (see https://developers.google.com/google-ads/api/reference/data/geotargets for all ~100,000 supported locations). Use alongside 'country' for city-level precision. Mutually exclusive with 'uule' — provide one or the other, not both. Cannot be combined with 'url'. When both `location` and `uule` are omitted, cloro pins results to the country's canonical location (e.g. `Portugal` for `PT`) where it has one; otherwise Google geolocates from the proxy's exit IP.",
+        },
+        uule: {
+            ...glParameterSchema,
+            description: "Pre-encoded Google UULE string for precise geo-targeting. Use this when you have a pre-built UULE value instead of a location name. Mutually exclusive with 'location' — provide one or the other, not both. Cannot be combined with 'url'; put 'uule' in the URL's query string instead.",
+        },
+        device: {
+            description: "Device the search is run from. 'desktop' returns the desktop SERP; 'ios' (Safari on iPhone), 'android' (Chrome on Android) and 'mobile' (alias for 'android') all return the mobile SERP.",
+            type: "string",
+            enum: ["desktop", "mobile", "ios", "android"],
+        },
+        pages: {
+            description: "Number of search results pages to scrape (1-10). Paid add-on: +2 credits per page after the first ([pricing](/guides/providers#google-search-multi-page-pricing)). Cannot be combined with 'url' — in that shape, depth comes from the URL's 'num' (rounded up to whole pages of 10, capped at 10 pages).",
+            type: "integer",
+            minimum: 1,
+            maximum: 10,
+        },
+        include: {
+            description: "Optional flags for including additional response data",
+            type: "object",
+            properties: {
+                html: { description: "Include raw HTML response from Google search", type: "boolean" },
+                aioverview: {
+                    description: "Include Google AI Overview in the response. Paid add-on: one flat +2 credits covers `aioverview` and `paaAioverview`, alone or together ([pricing](/guides/providers#google-search-multi-page-pricing)).",
+                    type: "object",
+                    properties: {
+                        markdown: { description: "Include AI Overview formatted as markdown", type: "boolean" },
+                    },
+                    additionalProperties: false,
+                },
+                paaAioverview: {
+                    description: "Hydrate AI-Overview-type People Also Ask items with markdown content and sources. Paid add-on: one flat +2 credits covers `aioverview` and `paaAioverview`, alone or together ([pricing](/guides/providers#google-search-multi-page-pricing)). Each hydrated item adds one scraper fetch (typically 1-2 per page), so responses take longer.",
+                    type: "boolean",
+                },
+            },
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+    description: "Google monitoring parameters.",
+    not: {
+        anyOf: [
+            { required: ["location", "uule"] },
+            { required: ["url", "query"] },
+            { required: ["url", "location"] },
+            { required: ["url", "uule"] },
+            { required: ["url", "pages"] },
+        ],
+    },
+};
+export const googleNewsMonitorRequest = {
+    required: ["query"],
+    type: "object",
+    properties: {
+        query: {
+            description: "The search query to execute on Google News",
+            type: "string",
+            minLength: 1,
+            maxLength: 10000,
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "ISO 3166-1 alpha-2 country code for localized news results. See [List of countries](/api-reference/endpoint/countries) for the codes each provider supports.",
+        },
+        gl: glParameterSchema,
+        hl: hlParameterSchema,
+        device: {
+            description: "Device the search is run from. 'desktop' returns the desktop news SERP; 'ios' (Safari on iPhone), 'android' (Chrome on Android) and 'mobile' (alias for 'android') all return the mobile news SERP.",
+            type: "string",
+            enum: ["desktop", "mobile", "ios", "android"],
+        },
+        pages: {
+            description: "Number of news results pages to scrape (1-10). Paid add-on: +2 credits per page after the first ([pricing](/guides/providers#google-search-multi-page-pricing)).",
+            type: "integer",
+            minimum: 1,
+            maximum: 10,
+        },
+        include: {
+            description: "Optional flags for including additional response data",
+            type: "object",
+            properties: {
+                html: { description: "Include raw HTML response from Google News", type: "boolean" },
+            },
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+    anyOf: [{ required: ["country"] }, { required: ["gl"] }],
+    description: "GoogleNews monitoring parameters.",
+};
+export const copilotMonitorRequest = {
+    required: ["prompt", "country"],
+    type: "object",
+    properties: {
+        prompt: {
+            description: "The prompt to send to Copilot",
+            type: "string",
+            minLength: 1,
+            maxLength: 10000,
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "Country/region code for localized response, using ISO 3166-1 alpha-2 country codes.",
+        },
+        include: {
+            description: "Optional flags for including additional response formats",
+            type: "object",
+            properties: {
+                html: { description: "Include a URL to the full HTML of the response", type: "boolean" },
+                markdown: {
+                    description: "Include markdown-formatted response in the result",
+                    type: "boolean",
+                },
+                rawResponse: { description: "Include raw streaming response events", type: "boolean" },
+            },
+            additionalProperties: false,
+        },
+        state: stateParameterSchema,
+    },
+    additionalProperties: false,
+    description: "Copilot monitoring parameters.",
+    allOf: [{ if: { required: ["state"] }, then: { properties: { country: { const: "US" } } } }],
+};
+export const perplexityMonitorRequest = {
+    required: ["prompt", "country"],
+    type: "object",
+    properties: {
+        prompt: {
+            description: "The prompt to send to Perplexity",
+            type: "string",
+            minLength: 1,
+            maxLength: 10000,
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "Country/region code for localized response, using ISO 3166-1 alpha-2 country codes.",
+        },
+        include: {
+            description: "Optional flags for including additional response formats",
+            type: "object",
+            properties: {
+                html: { description: "Include a URL to the full HTML of the response", type: "boolean" },
+                markdown: {
+                    description: "Include markdown-formatted response in the result",
+                    type: "boolean",
+                },
+                rawResponse: { description: "Include raw streaming response events", type: "boolean" },
+            },
+            additionalProperties: false,
+        },
+        state: stateParameterSchema,
+    },
+    additionalProperties: false,
+    description: "Perplexity monitoring parameters.",
+    allOf: [{ if: { required: ["state"] }, then: { properties: { country: { const: "US" } } } }],
+};
+export const aiModeMonitorRequest = {
+    required: ["prompt"],
+    type: "object",
+    properties: {
+        prompt: {
+            description: "The prompt to send to AI Mode",
+            type: "string",
+            minLength: 1,
+            maxLength: 10000,
+        },
+        country: {
+            ...countryCodeSchema,
+            description: "Country/region code for localized response, using ISO 3166-1 alpha-2 country codes.",
+        },
+        gl: glParameterSchema,
+        hl: hlParameterSchema,
+        location: {
+            ...glParameterSchema,
+            description: "Google canonical location name for geo-targeted results, in comma-separated format: 'City,Region,Country' (see https://developers.google.com/google-ads/api/reference/data/geotargets for all ~100,000 supported locations). Use alongside 'country' for city-level precision. Mutually exclusive with 'uule' — provide one or the other, not both. When both `location` and `uule` are omitted, cloro pins results to the country's canonical location (e.g. `Portugal` for `PT`) where it has one; otherwise Google geolocates from the proxy's exit IP.",
+        },
+        uule: {
+            ...glParameterSchema,
+            description: "Pre-encoded Google UULE string for precise geo-targeting. Use this when you have a pre-built UULE value instead of a location name. Mutually exclusive with 'location' — provide one or the other, not both.",
+        },
+        device: {
+            description: "Device type for search results",
+            type: "string",
+            enum: ["desktop", "mobile"],
+        },
+        include: {
+            description: "Optional flags for including additional response formats",
+            type: "object",
+            properties: {
+                html: { description: "Include a URL to the full HTML of the response", type: "boolean" },
+                markdown: {
+                    description: "Include markdown-formatted response in the result",
+                    type: "boolean",
+                },
+            },
+            additionalProperties: false,
+        },
+    },
+    additionalProperties: false,
+    anyOf: [{ required: ["country"] }, { required: ["gl"] }],
+    description: "AiMode monitoring parameters.",
+    not: { anyOf: [{ required: ["location", "uule"] }] },
+};
+export const googleProductRequest = {
+    required: ["productResultToken"],
+    type: "object",
+    properties: {
+        productResultToken: {
+            description: "The `productResultToken` from a Google Search shopping card, or from a Google AI Mode shopping card or inline product. The token carries the query, locale and location of the request that issued it, so the request takes no other field.",
+            type: "string",
+            minLength: 1,
+            maxLength: 512,
+        },
+    },
+    additionalProperties: false,
+    description: "GoogleProduct request parameters.",
+};
+export const googleGotoRequest = {
+    required: ["url"],
+    type: "object",
+    properties: {
+        url: {
+            description: "The Google redirect link to resolve, as an absolute URL. Must be a `google.com` or `www.google.com` link with a `/goto` or `/url` path — the form shipped as `redirectLink` beside every resolved link on Google Search, Google News, and AI Mode responses.",
+            type: "string",
+            format: "uri",
+        },
+    },
+    additionalProperties: false,
+    description: "GoogleGoto request parameters.",
+};