@j-o-r/hello-dave 0.0.0

package/types/API/brave.com/search.d.ts

@@ -0,0 +1,156 @@
+export type ToolSet = import("../../ToolSet.js").default;
+export type BraveRequest = {
+    headers: BRSearchAPIHeaders;
+    url: string;
+};
+export type BRSearchOptions = {
+    /**
+     * - question
+     */
+    q?: string | undefined;
+    /**
+     * - Country Code
+     */
+    country?: string | undefined;
+    /**
+     * - The 2 or more character language code for which the search results are provided.
+     */
+    search_lang?: string | undefined;
+    /**
+     * - Usually of the format <language_code>-<country_code> RFC 9110
+     */
+    ui_lang?: string | undefined;
+    /**
+     * - The number of search results returned in response. The maximum is 20
+     */
+    count?: number | undefined;
+    /**
+     * - The zero based offset that indicates number of search results per page (count) to skip before returning the result.
+     */
+    offset?: number | undefined;
+    /**
+     * - off, moderate, strict
+     */
+    safesearch?: string | undefined;
+    /**
+     * - pd (24 h) pw (1 week) pm (1 month) py (1 year) , YYYY-MM-DDtoYYYY-MM-DD (range 2022-04-01to2022-07-30)
+     */
+    freshness?: string | undefined;
+    /**
+     * - Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters).
+     */
+    text_decoration?: boolean | undefined;
+    /**
+     * - Whether to spellcheck provided query.
+     */
+    spellcheck?: boolean | undefined;
+    /**
+     * - discussions,faq,infobox,news,query,summarizer,videos,web
+     */
+    result_filter?: string | undefined;
+    /**
+     * - Goggles act as a custom re-ranking on top of Brave’s search index
+     */
+    goggles_id?: string | undefined;
+    /**
+     * - metric , imperial
+     */
+    units?: string | undefined;
+    /**
+     * - (only pro plan) A snippet is an excerpt from a page you get as a result of the query
+     */
+    extra_snippets?: boolean | undefined;
+    /**
+     * - 1 | 0 (only pro plan) This parameter enables summary key generation in web search results.
+     */
+    summary?: number | undefined;
+};
+export type BRSearchAPIHeaders = {
+    /**
+     * - The default supported media type is application/json.
+     */
+    Accept?: string | undefined;
+    /**
+     * - The supported compression type is gzip.
+     */
+    AcceptEncoding?: string | undefined;
+    /**
+     * -
+     */
+    ContentType?: string | undefined;
+    /**
+     * - The Brave Web Search API version to use, denoted by the format YYYY-MM-DD. The latest version is used by default.
+     */
+    ApiVersion?: string | undefined;
+    /**
+     * - Search will return cached web search results by default. To prevent caching, set the Cache-Control header to no-cache.
+     */
+    CacheControl?: string | undefined;
+    /**
+     * - The user agent of the client sending the request. Search can utilize the user agent to provide a different experience depending on the client.
+     */
+    UserAgent?: string | undefined;
+    /**
+     * - The latitude of the client's geographical location in degrees, to provide relevant local results. Must be >= -90.0 and <= +90.0 degrees.
+     */
+    XLocLat?: number | undefined;
+    /**
+     * - The longitude of the client's geographical location in degrees, to provide relevant local results. Must be >= -180.0 and <= +180.0 degrees.
+     */
+    XLocLong?: number | undefined;
+    /**
+     * - The IANA timezone for the client's device.
+     */
+    XLocTimezone?: string | undefined;
+    /**
+     * - The generic name of the client city.
+     */
+    XLocCity?: string | undefined;
+    /**
+     * - The code representing the client’s state/region, can be up to 3 characters long.
+     */
+    XLocState?: string | undefined;
+    /**
+     * - The name of the client's state/region.
+     */
+    XLocStateName?: string | undefined;
+    /**
+     * - The two-letter code for the client's country.
+     */
+    XLocCountry?: string | undefined;
+    /**
+     * - The client's postal code.
+     */
+    XLocPostalCode?: string | undefined;
+    /**
+     * - The secret token for the subscribed plan to authenticate the request. Can be obtained from API Keys.
+     */
+    XSubscriptionToken?: string | undefined;
+};
+/**
+* Create an brave search request
+* It will use the last message as the search query to stay compatible with the prompt/records logic
+* @param {string} query
+* @param {BRSearchOptions} [opts] overwrite default request settings
+* @param {BRSearchAPIHeaders} [hdrs] - optional headers to pass
+* @returns {BraveRequest}
+* @throws {Error}
+*/
+export function generateRequest(query: string, opts?: BRSearchOptions, hdrs?: BRSearchAPIHeaders): BraveRequest;
+/**
+* Process an openai response
+* @param {object} response
+* @returns {string}
+* @throws {Error}
+*/
+export function parseResponse(response: object): string;
+/**
+* Create an brave search request
+* It will use the last message as the search query to stay compatible with the prompt/records logic
+* @param {string} query
+* @param {BRSearchOptions} [opts] overwrite default request settings
+* @param {BRSearchAPIHeaders} [hdrs] - optional headers to pass
+* @throws {Error}
+* @returns {Promise<import('../../ToolSet.js').TSCallResponse>}
+*/
+export function request(query: string, opts?: BRSearchOptions, hdrs?: BRSearchAPIHeaders): Promise<import("../../ToolSet.js").TSCallResponse>;

package/types/API/openai.com/reponses/text.d.ts

@@ -0,0 +1,225 @@
+export type Prompt = import("../../../Prompt.js").default;
+export type ToolSet = import("../../../ToolSet.js").default;
+export type Includes = "code_interpreter_call.outputs" | "computer_call_output.output.image_url" | "file_search_call.results" | "message.input_image.image_url" | "message.output_text.logprobs" | "reasoning.encrypted_conten";
+export type OAOptions = {
+    /**
+     * - Whether to run in the background.
+     */
+    background?: boolean | undefined;
+    /**
+     * - Optional include parameter.
+     */
+    include?: string | null | undefined;
+    /**
+     * - Array of input objects.
+     */
+    input?: OAInput[] | undefined;
+    /**
+     * - Instructions for the model.
+     */
+    instructions?: string | undefined;
+    /**
+     * - Maximum number of output tokens.
+     */
+    max_output_tokens?: number | undefined;
+    /**
+     * - Maximum number of tool calls allowed.
+     */
+    max_tool_calls?: number | undefined;
+    /**
+     * - Optional metadata object.
+     */
+    metadata?: Object | null | undefined;
+    /**
+     * - Model version to use.
+     */
+    model?: "gpt-4.1" | "GPT-4o" | "o3" | "o3-mini" | "o4-mini" | "o1" | "o3-pro" | undefined;
+    /**
+     * - Reusable prompt string.
+     */
+    prompt?: string | null | undefined;
+    /**
+     * - Reasoning configuration.
+     */
+    reasoning?: {
+        /**
+         * - Effort level for reasoning.
+         */
+        effort: "low" | "medium" | "high" | null;
+        /**
+         * - Summary type for reasoning.
+         */
+        summary: "auto" | "concise" | "detailed";
+    } | undefined;
+    search?: "low" | "high" | "medium" | undefined;
+    /**
+     * - Service tier option, default is auto-selected.
+     */
+    service_tier?: "auto" | undefined;
+    /**
+     * - Whether to store the response or not.
+     */
+    store?: boolean | undefined;
+    /**
+     * - Whether to stream the response or not.
+     */
+    stream?: boolean | undefined;
+    /**
+     * - Sampling temperature between 0 and 2.
+     */
+    temperature?: number | undefined;
+    /**
+     * - text format
+     */
+    text?: {
+        /**
+         * - Summary type for reasoning.
+         */
+        format: "text" | "json_schema";
+    } | undefined;
+    /**
+     * - Allow parallel tool calls if true.
+     */
+    parallel_tool_calls?: boolean | undefined;
+    /**
+     * - Tool choice setting, default is auto-selected.
+     */
+    tool_choice?: "auto" | undefined;
+    /**
+     * =[] Array of tool call objects.
+     */
+    tools: OAToolCall[];
+    /**
+     * =null An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
+     */
+    top_logprobs: number | null;
+    /**
+     * =1 Top-p sampling value between 0 and 1.
+     */
+    top_p: number | null;
+    /**
+     * - Needed reponse_id to validate tool calls on the next request
+     */
+    previous_response_id?: string | null | undefined;
+};
+export type OAToolCall = {
+    /**
+     * - The type of the tool call, e.g., "function".
+     */
+    type: string;
+    /**
+     * - The name of the function.
+     */
+    name: string;
+    /**
+     * - A brief description of what the function does.
+     */
+    description: string;
+    /**
+     * - The parameters required by the function.
+     */
+    parameters: {
+        type: string;
+        properties: {
+            [x: string]: OAParameterProperty;
+        };
+        required?: string[] | undefined;
+    };
+};
+export type OAParameterProperty = {
+    /**
+     * - The data type of the parameter, e.g., "string".
+     */
+    type: string;
+    /**
+     * - A brief description of the parameter.
+     */
+    description: string;
+};
+export type OAMessage = {
+    /**
+     * - The role of the participant (e.g., "assistant", "user").
+     */
+    role: "assistant" | "user";
+    /**
+     * - The content of the message.
+     */
+    content: Array<OAContent>;
+};
+export type OAContent = {
+    /**
+     * - The type of content (e.g., "output_text", "input_text").
+     */
+    type: "output_text" | "input_text";
+    /**
+     * - The text content.
+     */
+    text: string;
+};
+export type OAFunctionCall = {
+    /**
+     * - Unique identifier for the function call.
+     */
+    id: string;
+    /**
+     * - Indicates this is a function call (e.g., "function_call").
+     */
+    type: "function_call";
+    /**
+     * - Unique identifier for the specific function call instance.
+     */
+    call_id: string;
+    /**
+     * - The name of the function being called.
+     */
+    name: string;
+    /**
+     * - JSON string representing arguments passed to the function.
+     */
+    arguments: string;
+};
+export type OAFunctionCallOutput = {
+    /**
+     * - Indicates this is a function call output (e.g., "function_call_output").
+     */
+    type: "function_call_output";
+    /**
+     * - Identifier linking to the related function call.
+     */
+    call_id: string;
+    /**
+     * - JSON string representing the output from the function call.
+     */
+    output: string;
+};
+/**
+ * Represents an OpenAI API response request INPUT structure.
+ */
+export type OAInput = (OAMessage | OAFunctionCall | OAFunctionCallOutput);
+/**
+* @param {Prompt} prompt
+* @param {ToolSet} [toolset]
+* @param {OAOptions} [options]
+*/
+export function generateRequest(prompt: Prompt, toolset?: ToolSet, options?: OAOptions): {
+    url: string;
+    headers: object;
+    body: OAOptions;
+};
+/**
+* Parse a response
+* @param {number} duration - Fetch time in MS
+* @param {Prompt} prompt
+* @param {import('../../../request.js').FetchResponse} res
+* @param {import('../../../ToolSet.js').default} [toolset]
+*/
+export function parseResponse(duration: number, prompt: Prompt, res: any, toolset?: import("../../../ToolSet.js").default): Promise<void>;
+/**
+* Do a request
+* @param {Prompt} prompt
+* @param {ToolSet|null} toolset
+* @param {OAOptions} [options]:
+* @param {number} [counter] - leave empty this counts the number of requests when doing recursive request calls
+* @return {Promise<import('../../../Session.js').Message>}
+*/
+export function request(prompt: Prompt, toolset?: ToolSet | null, options?: OAOptions, counter?: number): Promise<import("../../../Session.js").Message>;

package/types/API/x.ai/text.d.ts

@@ -0,0 +1,286 @@
+export type Prompt = import("../../Prompt.js").default;
+export type ToolSet = import("../../ToolSet.js").default;
+export type grokModels = "grok-4" | "grok-3" | "grok-3-mini" | "grok-3-fast" | "grok-3-mini-fast";
+export type grokReason = "low" | "high";
+export type SearchParameters = {
+    mode: "on" | "auto";
+    /**
+     * ISO-8601 date (YYYY-MM-DD)
+     */
+    from_date?: string | undefined;
+    /**
+     * ISO-8601 date (YYYY-MM-DD)
+     */
+    to_date?: string | undefined;
+    sources?: (RssSource | WebSource | NewsSource | XSource)[] | undefined;
+};
+export type RssSource = {
+    type: "rss";
+    links: string[];
+};
+export type WebSource = {
+    type: "web";
+    /**
+     * ISO-3166-1 alpha-2
+     */
+    country?: string | undefined;
+    safe_search?: boolean | undefined;
+    allowed_websites?: string[] | undefined;
+    excluded_websites?: string[] | undefined;
+};
+export type NewsSource = {
+    type: "news";
+    country?: string | undefined;
+    safe_search?: boolean | undefined;
+    allowed_websites?: string[] | undefined;
+    excluded_websites?: string[] | undefined;
+};
+export type XSource = {
+    type: "x";
+};
+export type XRequest = {
+    body: XOptions;
+    headers: Headers;
+    /**
+     * -
+     */
+    url: string;
+};
+export type XFunctionCall = {
+    /**
+     * - The name of the function to call.
+     */
+    name: string;
+    /**
+     * - The arguments for the function call in JSON string format.
+     */
+    arguments: string;
+};
+export type XToolCall = {
+    /**
+     * - The unique identifier for the tool call.
+     */
+    id: string;
+    /**
+     * - The type of the tool call, e.g., "function".
+     */
+    type: string;
+    /**
+     * - The function call details.
+     */
+    function: XFunctionCall;
+};
+export type XFunctionResponse = {
+    /**
+     * - must be 'tool'
+     */
+    role: string;
+    /**
+     * - The arguments for the function call in JSON string format.
+     */
+    content: string;
+    /**
+     * - The unique identifier for the tool call.
+     */
+    tool_call_id: string;
+};
+export type XMessageResponse = {
+    /**
+     * - The index of the message.
+     */
+    index: number;
+    /**
+     * - The message details.
+     */
+    message: {
+        role: string;
+        content: string;
+        reasoning_content?: string | undefined;
+        refusal: string | null;
+    };
+    /**
+     * - The reason for finishing (e.g., "stop").
+     */
+    finish_reason: string;
+    /**
+     * - The reason for finishing (e.g., "stop").
+     */
+    tools_calls: XToolCall[];
+};
+/**
+ * https://docs.x.ai/api/endpoints#chat-completions
+ */
+export type XOptions = {
+    /**
+     * - What model to use
+     */
+    model?: grokModels | undefined;
+    /**
+     * - the actual prompt
+     */
+    messages?: any[] | undefined;
+    /**
+     * , callable functions
+     */
+    tools?: XToolCall[] | undefined;
+    /**
+     * - Default 'none' when no function, 'auto' when present, or required
+     */
+    tool_choice?: string | undefined;
+    /**
+     * - Response format
+     */
+    response_format?: {
+        /**
+         * - The role of the sender (e.g., "assistant").
+         */
+        type?: string | undefined;
+    } | undefined;
+    /**
+     * -  What sampling temperature to use, between 0 and 2.
+     */
+    temperature?: number | undefined;
+    /**
+     * -  The maximum number of tokens allowed for the generated answer.
+     */
+    max_completion_tokens?: number | undefined;
+    /**
+     * -  Number between -2.0 and 2.0.
+     */
+    presence_penalty?: number | undefined;
+    /**
+     * - Number between -2.0 and 2.0.
+     */
+    frequency_penalty?: number | undefined;
+    /**
+     * -  Number between -2.0 and 2.0.
+     */
+    top_p?: number | undefined;
+    /**
+     * - How many chat completion choices to generate for each input message. default 1
+     */
+    n?: number | undefined;
+    /**
+     * - Chunk/stream request default null
+     */
+    stream?: boolean | undefined;
+    /**
+     * - Multiple calls at once
+     */
+    parallel_tool_calls?: boolean | undefined;
+    /**
+     * - Who i am
+     */
+    reasoning_effort?: grokReason | undefined;
+    /**
+     * - Who i am
+     */
+    user?: string | undefined;
+    /**
+     * - see options
+     */
+    seed?: number | undefined;
+    /**
+     * - live search
+     */
+    search_parameters?: SearchParameters | undefined;
+    /**
+     * - Up to 4 sequences where the API will stop generating further tokens.
+     */
+    stop?: string[] | undefined;
+};
+export type XResponse = {
+    /**
+     * - The unique identifier for the response.
+     */
+    id: string;
+    /**
+     * - The type of object returned, typically "chat.completion".
+     */
+    object: string;
+    /**
+     * - The timestamp of when the response was created.
+     */
+    created: number;
+    /**
+     * - The model used to generate the response.
+     */
+    model: string;
+    /**
+     * - An array of choice objects containing the response details.
+     */
+    choices: Array<XChoice>;
+    /**
+     * - An object containing token usage information.
+     */
+    usage: XUsage;
+    /**
+     * - The system fingerprint for the response.
+     */
+    system_fingerprint: string;
+    /**
+     * - HTTP headers associated with the response.
+     */
+    http_headers: Object;
+};
+export type XChoice = {
+    /**
+     * - The index of the choice in the response.
+     */
+    index: number;
+    /**
+     * - The message object containing the role and content.
+     */
+    message: XMessageResponse;
+    /**
+     * - Log probabilities, typically null.
+     */
+    logprobs: null;
+    /**
+     * - The reason why the response finished.
+     */
+    finish_reason: string;
+};
+export type XUsage = {
+    /**
+     * - The number of tokens in the prompt.
+     */
+    prompt_tokens: number;
+    /**
+     * - The number of tokens in the completion.
+     */
+    completion_tokens: number;
+    /**
+     * - The total number of tokens used.
+     */
+    total_tokens: number;
+};
+/**
+* Create an anthropic request
+* @param {Prompt} prompt
+* @param {ToolSet|void} [tools]
+* @param {XOptions} [opts] overwrite default request settings
+* @param {object} [hdrs] - optional headers to pass
+* @returns {XRequest}
+* @throws {Error}
+*/
+export function generateRequest(prompt: Prompt, tools?: void | import("../../ToolSet.js").default | undefined, opts?: XOptions, hdrs?: object): XRequest;
+/**
+* Process an openai response
+* @param {number} duration - the time is MS before and after the request
+* @param {import('lib/request.js').FetchResponse} res
+* @param {Prompt} prompt
+* @param {ToolSet} [toolset]
+* @returns {Promise<void>}
+* @throws {Error}
+*/
+export function parseResponse(duration: number, prompt: Prompt, res: any, toolset?: ToolSet): Promise<void>;
+/**
+* Do a request
+* @param {Prompt} prompt
+* @param {ToolSet|null} toolset
+* @param {XOptions} [options]:
+* @param {number} [counter] - leave empty this counts the number of requests when doing recursive request calls
+* @return {Promise<import('../../Session.js').Message>}
+*/
+export function request(prompt: Prompt, toolset?: ToolSet | null, options?: XOptions, counter?: number): Promise<import("../../Session.js").Message>;