@openserp/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,202 @@
+import { components } from './generated/oss.cjs';
+
+interface CreditInfo {
+    used?: number | undefined;
+    remaining?: number | undefined;
+}
+interface CloudAccount {
+    id?: string;
+    email?: string;
+    created_at?: string;
+    credits_remaining?: number;
+    plan?: string;
+    [key: string]: unknown;
+}
+interface Price {
+    credits?: number;
+    price_usd?: number;
+}
+interface Pricing {
+    credit_price_usd?: number;
+    search?: Price;
+    mega_search?: Price;
+    image_search?: Price;
+    any_search?: Price;
+    fast_search?: Price;
+    any_image?: Price;
+    fast_image?: Price;
+    [key: string]: unknown;
+}
+type EngineStatusValue = "operational" | "loaded" | "down" | "unknown";
+type OverallStatus = "operational" | "degraded" | "down" | "unknown";
+interface EngineStatus {
+    status?: EngineStatusValue;
+    latency_ms?: number;
+}
+type EnginesStatus = {
+    overall: OverallStatus;
+} | {
+    engines: Record<string, EngineStatus>;
+};
+interface EngineCapability {
+    web?: boolean;
+    image?: boolean;
+    fallback_web?: boolean;
+    fallback_image?: boolean;
+}
+interface ModeCapability {
+    web?: boolean;
+    image?: boolean;
+}
+interface EnginesCapabilities {
+    engines?: Record<string, EngineCapability>;
+    modes?: Record<string, ModeCapability>;
+    [key: string]: unknown;
+}
+
+type Backend = "oss" | "cloud";
+type Engine = "google" | "yandex" | "baidu" | "bing" | "duck" | "duckduckgo" | "ecosia";
+type MegaMode = "balanced" | "any" | "fast";
+type ResponseFormat = "json" | "markdown" | "text" | "ndjson";
+type SearchEnvelope = components["schemas"]["SearchEnvelope"];
+type MegaSearchEnvelope = components["schemas"]["MegaSearchEnvelope"];
+type ImageEnvelope = components["schemas"]["ImageEnvelope"];
+type ErrorResponse = components["schemas"]["ErrorResponse"];
+type HealthStatus = components["schemas"]["HealthStatus"];
+type ReadinessStatus = components["schemas"]["ReadinessStatus"];
+type StatsResponse = components["schemas"]["StatsResponse"];
+type CacheStats = components["schemas"]["CacheStats"];
+type ProxyStats = components["schemas"]["ProxyStats"];
+type CircuitBreakerStatsResponse = components["schemas"]["CircuitBreakerStatsResponse"];
+type MegaEnginesResponse = components["schemas"]["MegaEnginesResponse"];
+interface OpenSERPConfig {
+    apiKey?: string | undefined;
+    baseUrl?: string | undefined;
+    backend?: Backend | undefined;
+    timeoutMs?: number | undefined;
+    fetch?: typeof fetch | undefined;
+    headers?: HeadersInit | undefined;
+    retry?: ((err: unknown, attempt: number) => boolean | Promise<boolean>) | undefined;
+}
+interface LastResponse {
+    status: number;
+    requestId?: string | undefined;
+    credits?: CreditInfo | undefined;
+    engineUsed?: string | undefined;
+    fallbackEngine?: string | undefined;
+    cache?: string | undefined;
+    proxyMode?: string | undefined;
+    proxyTag?: string | undefined;
+    proxyUsed?: string | undefined;
+    networkBytes?: number | undefined;
+    browserProfileId?: string | undefined;
+    headers: Headers;
+}
+interface SearchParams {
+    engine: Engine;
+    text?: string;
+    lang?: string;
+    region?: string;
+    date?: string;
+    file?: string;
+    site?: string;
+    limit?: number;
+    start?: number;
+    filter?: boolean;
+    answers?: boolean;
+    format?: ResponseFormat;
+    useProxy?: string;
+    proxyUrl?: string;
+    proxyCountry?: string;
+    proxyClass?: string;
+    proxyProvider?: string;
+    proxySessionId?: string;
+    tenant?: string;
+}
+type ImageParams = SearchParams;
+interface MegaSearchParams extends Omit<SearchParams, "engine"> {
+    engines?: Engine[];
+    mode?: MegaMode;
+    dedupe?: boolean;
+    merge?: boolean;
+}
+type MegaImageParams = MegaSearchParams;
+interface ParseParams {
+    html: string;
+    format?: ResponseFormat;
+}
+
+declare class OpenSERP {
+    readonly config: OpenSERPConfig;
+    lastResponse?: LastResponse;
+    constructor(config?: OpenSERPConfig);
+    get backend(): Backend;
+    get baseUrl(): string;
+    search(params: SearchParams): Promise<SearchEnvelope | string>;
+    image(params: ImageParams): Promise<ImageEnvelope | string>;
+    megaSearch(params: MegaSearchParams): Promise<MegaSearchEnvelope | string>;
+    fastSearch(params: Omit<MegaSearchParams, "mode">): Promise<MegaSearchEnvelope | string>;
+    anySearch(params: Omit<MegaSearchParams, "mode">): Promise<MegaSearchEnvelope | string>;
+    megaImage(params: MegaImageParams): Promise<ImageEnvelope | string>;
+    fastImage(params: Omit<MegaImageParams, "mode">): Promise<ImageEnvelope | string>;
+    anyImage(params: Omit<MegaImageParams, "mode">): Promise<ImageEnvelope | string>;
+    parseGoogle(params: ParseParams): Promise<SearchEnvelope | string>;
+    parseBing(params: ParseParams): Promise<SearchEnvelope | string>;
+    health(): Promise<HealthStatus>;
+    ready(): Promise<ReadinessStatus>;
+    stats(): Promise<StatsResponse>;
+    cacheStats(): Promise<CacheStats>;
+    proxyStats(): Promise<ProxyStats>;
+    circuitBreakerStats(): Promise<CircuitBreakerStatsResponse>;
+    engines(): Promise<MegaEnginesResponse>;
+    me(): Promise<CloudAccount>;
+    pricing(): Promise<Pricing>;
+    enginesStatus(): Promise<EnginesStatus>;
+    enginesCapabilities(): Promise<EnginesCapabilities>;
+    private parse;
+    private get;
+    private requestContext;
+    private assertCloud;
+    private assertOss;
+}
+
+declare const OSS_BASE_URL = "http://localhost:7000";
+declare const CLOUD_BASE_URL = "https://api.openserp.org/v1";
+declare function normalizeBaseUrl(baseUrl: string): string;
+declare function resolveBaseUrl(config: OpenSERPConfig): string;
+declare function inferBackend(config: Pick<OpenSERPConfig, "apiKey" | "baseUrl" | "backend">): Backend;
+
+declare class SERPError extends Error {
+    readonly status: number;
+    readonly code?: string | undefined;
+    readonly reason?: string | undefined;
+    readonly requestId?: string | undefined;
+    readonly meta?: Record<string, unknown> | undefined;
+    readonly response?: ErrorResponse | unknown | undefined;
+    constructor(message: string, options?: {
+        status?: number | undefined;
+        code?: string | undefined;
+        reason?: string | undefined;
+        requestId?: string | undefined;
+        meta?: Record<string, unknown> | undefined;
+        response?: ErrorResponse | unknown | undefined;
+        cause?: unknown | undefined;
+    });
+}
+declare class RateLimitError extends SERPError {
+    constructor(message: string, options?: ConstructorParameters<typeof SERPError>[1]);
+}
+declare class CaptchaError extends SERPError {
+    constructor(message: string, options?: ConstructorParameters<typeof SERPError>[1]);
+}
+declare class CloudOnlyError extends SERPError {
+    constructor(method: string);
+}
+declare class OssOnlyError extends SERPError {
+    constructor(method: string);
+}
+declare class TimeoutError extends SERPError {
+    constructor(timeoutMs: number, cause?: unknown);
+}
+
+export { type Backend, CLOUD_BASE_URL, type CacheStats, CaptchaError, type CircuitBreakerStatsResponse, type CloudAccount, CloudOnlyError, type CreditInfo, type Engine, type EngineCapability, type EngineStatus, type EnginesCapabilities, type EnginesStatus, type ErrorResponse, type HealthStatus, type ImageEnvelope, type ImageParams, type LastResponse, type MegaEnginesResponse, type MegaImageParams, type MegaMode, type MegaSearchEnvelope, type MegaSearchParams, type ModeCapability, OSS_BASE_URL, OpenSERP, type OpenSERPConfig, OssOnlyError, type OverallStatus, type ParseParams, type Price, type Pricing, type ProxyStats, RateLimitError, type ReadinessStatus, type ResponseFormat, SERPError, type SearchEnvelope, type SearchParams, type StatsResponse, TimeoutError, inferBackend, normalizeBaseUrl, resolveBaseUrl };

package/dist/index.d.ts

@@ -0,0 +1,202 @@
+import { components } from './generated/oss.js';
+
+interface CreditInfo {
+    used?: number | undefined;
+    remaining?: number | undefined;
+}
+interface CloudAccount {
+    id?: string;
+    email?: string;
+    created_at?: string;
+    credits_remaining?: number;
+    plan?: string;
+    [key: string]: unknown;
+}
+interface Price {
+    credits?: number;
+    price_usd?: number;
+}
+interface Pricing {
+    credit_price_usd?: number;
+    search?: Price;
+    mega_search?: Price;
+    image_search?: Price;
+    any_search?: Price;
+    fast_search?: Price;
+    any_image?: Price;
+    fast_image?: Price;
+    [key: string]: unknown;
+}
+type EngineStatusValue = "operational" | "loaded" | "down" | "unknown";
+type OverallStatus = "operational" | "degraded" | "down" | "unknown";
+interface EngineStatus {
+    status?: EngineStatusValue;
+    latency_ms?: number;
+}
+type EnginesStatus = {
+    overall: OverallStatus;
+} | {
+    engines: Record<string, EngineStatus>;
+};
+interface EngineCapability {
+    web?: boolean;
+    image?: boolean;
+    fallback_web?: boolean;
+    fallback_image?: boolean;
+}
+interface ModeCapability {
+    web?: boolean;
+    image?: boolean;
+}
+interface EnginesCapabilities {
+    engines?: Record<string, EngineCapability>;
+    modes?: Record<string, ModeCapability>;
+    [key: string]: unknown;
+}
+
+type Backend = "oss" | "cloud";
+type Engine = "google" | "yandex" | "baidu" | "bing" | "duck" | "duckduckgo" | "ecosia";
+type MegaMode = "balanced" | "any" | "fast";
+type ResponseFormat = "json" | "markdown" | "text" | "ndjson";
+type SearchEnvelope = components["schemas"]["SearchEnvelope"];
+type MegaSearchEnvelope = components["schemas"]["MegaSearchEnvelope"];
+type ImageEnvelope = components["schemas"]["ImageEnvelope"];
+type ErrorResponse = components["schemas"]["ErrorResponse"];
+type HealthStatus = components["schemas"]["HealthStatus"];
+type ReadinessStatus = components["schemas"]["ReadinessStatus"];
+type StatsResponse = components["schemas"]["StatsResponse"];
+type CacheStats = components["schemas"]["CacheStats"];
+type ProxyStats = components["schemas"]["ProxyStats"];
+type CircuitBreakerStatsResponse = components["schemas"]["CircuitBreakerStatsResponse"];
+type MegaEnginesResponse = components["schemas"]["MegaEnginesResponse"];
+interface OpenSERPConfig {
+    apiKey?: string | undefined;
+    baseUrl?: string | undefined;
+    backend?: Backend | undefined;
+    timeoutMs?: number | undefined;
+    fetch?: typeof fetch | undefined;
+    headers?: HeadersInit | undefined;
+    retry?: ((err: unknown, attempt: number) => boolean | Promise<boolean>) | undefined;
+}
+interface LastResponse {
+    status: number;
+    requestId?: string | undefined;
+    credits?: CreditInfo | undefined;
+    engineUsed?: string | undefined;
+    fallbackEngine?: string | undefined;
+    cache?: string | undefined;
+    proxyMode?: string | undefined;
+    proxyTag?: string | undefined;
+    proxyUsed?: string | undefined;
+    networkBytes?: number | undefined;
+    browserProfileId?: string | undefined;
+    headers: Headers;
+}
+interface SearchParams {
+    engine: Engine;
+    text?: string;
+    lang?: string;
+    region?: string;
+    date?: string;
+    file?: string;
+    site?: string;
+    limit?: number;
+    start?: number;
+    filter?: boolean;
+    answers?: boolean;
+    format?: ResponseFormat;
+    useProxy?: string;
+    proxyUrl?: string;
+    proxyCountry?: string;
+    proxyClass?: string;
+    proxyProvider?: string;
+    proxySessionId?: string;
+    tenant?: string;
+}
+type ImageParams = SearchParams;
+interface MegaSearchParams extends Omit<SearchParams, "engine"> {
+    engines?: Engine[];
+    mode?: MegaMode;
+    dedupe?: boolean;
+    merge?: boolean;
+}
+type MegaImageParams = MegaSearchParams;
+interface ParseParams {
+    html: string;
+    format?: ResponseFormat;
+}
+
+declare class OpenSERP {
+    readonly config: OpenSERPConfig;
+    lastResponse?: LastResponse;
+    constructor(config?: OpenSERPConfig);
+    get backend(): Backend;
+    get baseUrl(): string;
+    search(params: SearchParams): Promise<SearchEnvelope | string>;
+    image(params: ImageParams): Promise<ImageEnvelope | string>;
+    megaSearch(params: MegaSearchParams): Promise<MegaSearchEnvelope | string>;
+    fastSearch(params: Omit<MegaSearchParams, "mode">): Promise<MegaSearchEnvelope | string>;
+    anySearch(params: Omit<MegaSearchParams, "mode">): Promise<MegaSearchEnvelope | string>;
+    megaImage(params: MegaImageParams): Promise<ImageEnvelope | string>;
+    fastImage(params: Omit<MegaImageParams, "mode">): Promise<ImageEnvelope | string>;
+    anyImage(params: Omit<MegaImageParams, "mode">): Promise<ImageEnvelope | string>;
+    parseGoogle(params: ParseParams): Promise<SearchEnvelope | string>;
+    parseBing(params: ParseParams): Promise<SearchEnvelope | string>;
+    health(): Promise<HealthStatus>;
+    ready(): Promise<ReadinessStatus>;
+    stats(): Promise<StatsResponse>;
+    cacheStats(): Promise<CacheStats>;
+    proxyStats(): Promise<ProxyStats>;
+    circuitBreakerStats(): Promise<CircuitBreakerStatsResponse>;
+    engines(): Promise<MegaEnginesResponse>;
+    me(): Promise<CloudAccount>;
+    pricing(): Promise<Pricing>;
+    enginesStatus(): Promise<EnginesStatus>;
+    enginesCapabilities(): Promise<EnginesCapabilities>;
+    private parse;
+    private get;
+    private requestContext;
+    private assertCloud;
+    private assertOss;
+}
+
+declare const OSS_BASE_URL = "http://localhost:7000";
+declare const CLOUD_BASE_URL = "https://api.openserp.org/v1";
+declare function normalizeBaseUrl(baseUrl: string): string;
+declare function resolveBaseUrl(config: OpenSERPConfig): string;
+declare function inferBackend(config: Pick<OpenSERPConfig, "apiKey" | "baseUrl" | "backend">): Backend;
+
+declare class SERPError extends Error {
+    readonly status: number;
+    readonly code?: string | undefined;
+    readonly reason?: string | undefined;
+    readonly requestId?: string | undefined;
+    readonly meta?: Record<string, unknown> | undefined;
+    readonly response?: ErrorResponse | unknown | undefined;
+    constructor(message: string, options?: {
+        status?: number | undefined;
+        code?: string | undefined;
+        reason?: string | undefined;
+        requestId?: string | undefined;
+        meta?: Record<string, unknown> | undefined;
+        response?: ErrorResponse | unknown | undefined;
+        cause?: unknown | undefined;
+    });
+}
+declare class RateLimitError extends SERPError {
+    constructor(message: string, options?: ConstructorParameters<typeof SERPError>[1]);
+}
+declare class CaptchaError extends SERPError {
+    constructor(message: string, options?: ConstructorParameters<typeof SERPError>[1]);
+}
+declare class CloudOnlyError extends SERPError {
+    constructor(method: string);
+}
+declare class OssOnlyError extends SERPError {
+    constructor(method: string);
+}
+declare class TimeoutError extends SERPError {
+    constructor(timeoutMs: number, cause?: unknown);
+}
+
+export { type Backend, CLOUD_BASE_URL, type CacheStats, CaptchaError, type CircuitBreakerStatsResponse, type CloudAccount, CloudOnlyError, type CreditInfo, type Engine, type EngineCapability, type EngineStatus, type EnginesCapabilities, type EnginesStatus, type ErrorResponse, type HealthStatus, type ImageEnvelope, type ImageParams, type LastResponse, type MegaEnginesResponse, type MegaImageParams, type MegaMode, type MegaSearchEnvelope, type MegaSearchParams, type ModeCapability, OSS_BASE_URL, OpenSERP, type OpenSERPConfig, OssOnlyError, type OverallStatus, type ParseParams, type Price, type Pricing, type ProxyStats, RateLimitError, type ReadinessStatus, type ResponseFormat, SERPError, type SearchEnvelope, type SearchParams, type StatsResponse, TimeoutError, inferBackend, normalizeBaseUrl, resolveBaseUrl };