grok-search-cli 0.1.2 → 0.1.3

package/dist/src/search.d.ts

@@ -0,0 +1,34 @@
+import { getProviderKind, resolveRuntimeConfig } from './config';
+import { ApiMode, CompletedResult, GrokSearchConfig, SearchOptions, SearchResultPayload, StreamResult } from './types';
+export interface SearchExecutionContext {
+    prompt: string;
+    runtimeConfig: ReturnType<typeof resolveRuntimeConfig>;
+    apiMode: ApiMode;
+    requestApi: string;
+    providerKind: ReturnType<typeof getProviderKind>;
+    options: SearchOptions;
+    startedAt: number;
+    abortSignal: AbortSignal;
+}
+export declare function createDefaultSearchOptions(model?: string): SearchOptions;
+export declare function createSearchOptions(config: GrokSearchConfig): SearchOptions;
+export declare function ensureLocalApiKey(): string;
+export declare function shouldWarnAboutCompatFilters(apiMode: ApiMode, baseUrl: string | undefined, options: SearchOptions): boolean;
+export declare function shouldUseOpenRouterResponses(apiMode: ApiMode, providerKind: ReturnType<typeof getProviderKind>): boolean;
+export declare function getWarnings(apiMode: ApiMode, baseUrl: string | undefined, options: SearchOptions): string[];
+export declare function createExecutionContext(prompt: string, config: GrokSearchConfig): SearchExecutionContext;
+export declare function createLocalExecutionContext(prompt: string, options: SearchOptions): SearchExecutionContext;
+export declare function createPayload(params: {
+    command: "all";
+    apiMode: ApiMode;
+    model: string;
+    prompt: string;
+    result: CompletedResult;
+    verbose: boolean;
+    requestApi: string;
+    baseUrl?: string;
+    startedAt: number;
+}): SearchResultPayload;
+export declare function runStreamRequest(params: SearchExecutionContext): Promise<StreamResult>;
+export declare function runSearchRequest(params: SearchExecutionContext): Promise<CompletedResult>;
+export declare function grokSearch(query: string, config: GrokSearchConfig): Promise<SearchResultPayload>;

package/dist/src/skill.d.ts

@@ -0,0 +1,2 @@
+export declare const SKILL_NAME = "grok-search-cli";
+export declare function readSkillMarkdown(): string;

package/dist/src/types.d.ts

@@ -0,0 +1,121 @@
+export type UtilityCommandName = "skill" | "doctor";
+export type SearchCommandName = "all";
+export type CommandName = SearchCommandName | UtilityCommandName;
+export type ApiMode = "responses" | "completion";
+export type ProviderKind = "xai" | "openrouter" | "third-party";
+export interface SearchOptions {
+    model: string;
+    timeoutMs: number;
+    verbose: boolean;
+    allowedDomains: string[];
+    excludedDomains: string[];
+    allowedHandles: string[];
+    excludedHandles: string[];
+    fromDate?: string;
+    toDate?: string;
+    enableImageUnderstanding: boolean;
+    enableVideoUnderstanding: boolean;
+}
+export interface CliOptions extends SearchOptions {
+    json: boolean;
+}
+export interface GrokSearchConfig {
+    apiKey: string;
+    model?: string;
+    baseUrl?: string;
+    compatMode?: boolean | string;
+    timeoutMs?: number;
+    verbose?: boolean;
+    allowedDomains?: string[];
+    excludedDomains?: string[];
+    allowedHandles?: string[];
+    excludedHandles?: string[];
+    fromDate?: string;
+    toDate?: string;
+    enableImageUnderstanding?: boolean;
+    enableVideoUnderstanding?: boolean;
+}
+export type ParsedArgs = {
+    command: "skill";
+} | {
+    command: "doctor";
+} | {
+    command: SearchCommandName;
+    prompt: string;
+    options: CliOptions;
+};
+export interface UsageLike {
+    inputTokens?: number;
+    outputTokens?: number;
+    totalTokens?: number;
+    outputTokenDetails?: {
+        reasoningTokens?: number;
+        textTokens?: number;
+    };
+}
+export interface VerbosePayload {
+    model: string;
+    finishReason: string;
+    requestApi: string;
+    baseUrl?: string;
+    durationMs: number;
+    firstTokenLatencyMs?: number;
+    tokensPerSecond?: number;
+    usage: {
+        inputTokens?: number;
+        outputTokens?: number;
+        reasoningTokens?: number;
+        totalTokens?: number;
+    };
+}
+export interface SearchResultPayload {
+    command: SearchCommandName;
+    apiMode: ApiMode;
+    model: string;
+    prompt: string;
+    text: string;
+    finishReason: string;
+    usage: unknown;
+    sources: unknown[];
+    verbose?: VerbosePayload;
+}
+export interface StreamResult {
+    textStream: AsyncIterable<string>;
+    text: PromiseLike<string>;
+    finishReason: PromiseLike<string | undefined>;
+    usage: PromiseLike<unknown>;
+    sources: PromiseLike<unknown[]>;
+}
+export interface CompletedResult {
+    text: string;
+    finishReason?: string;
+    usage: unknown;
+    sources: unknown[];
+}
+export interface OpenRouterResponsesOutputTextAnnotation {
+    type?: string;
+    url?: string;
+    start_index?: number;
+    end_index?: number;
+}
+export interface OpenRouterResponsesOutputText {
+    type?: string;
+    text?: string;
+    annotations?: OpenRouterResponsesOutputTextAnnotation[];
+}
+export interface OpenRouterResponsesOutputItem {
+    type?: string;
+    role?: string;
+    content?: OpenRouterResponsesOutputText[];
+}
+export interface OpenRouterResponsesUsage {
+    input_tokens?: number;
+    output_tokens?: number;
+    total_tokens?: number;
+}
+export interface OpenRouterResponsesBody {
+    model?: string;
+    status?: string;
+    output?: OpenRouterResponsesOutputItem[];
+    usage?: OpenRouterResponsesUsage;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grok-search-cli",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "AI-friendly CLI for high-freshness web and X research with Grok search tool.",
   "keywords": [
     "agent",
@@ -22,6 +22,13 @@
   ],
   "license": "MIT",
   "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
   "bin": {
     "grok-search": "dist/cli.js"
   },
@@ -41,15 +48,17 @@
   "dependencies": {
     "@ai-sdk/openai-compatible": "^2.0.38",
     "@ai-sdk/xai": "^3.0.77",
-    "ai": "^6.0.145",
-    "conf": "^14.0.0"
+    "ai": "^6.0.146",
+    "conf": "^15.1.0",
+    "p-defer": "^4.0.1"
   },
   "devDependencies": {
     "@dotenvx/dotenvx": "^1.51.1",
-    "@types/node": "^24.5.2",
+    "@types/node": "^25.5.2",
     "tsx": "^4.20.6",
-    "typescript": "^5.9.2",
-    "vite": "^8.0.3"
+    "typescript": "^6.0.2",
+    "vite": "^8.0.3",
+    "vite-plugin-dts": "^4.5.4"
   },
   "scripts": {
     "build": "vite build",