@x12i/sdk 0.4.0 → 1.1.0

package/dist/client.d.ts

@@ -1,197 +1,76 @@
-import { ParserRegistry, type ClassifyCandidate, type FetchResult, type ParsedResult, type Parser } from "@x12i/core";
-import { type FetchOptions, type RetrieveOptions, type RetrieveBatchItem, type FetchCache, type SnapshotStore, type CachedRetrieveOptions, type ChangeCheckRequest, type ChangeCheckResult } from "@x12i/fetcher";
-import { type IngestOptions, type IngestResult } from "@x12i/ingest";
-import { type SearchConfig, type SearchProvider, type WebSearchRequest, type WebSearchResponse } from "@x12i/search";
-import { type CrawlRequest, type CrawlResult } from "@x12i/crawl";
-import { type ResearchPacket, type ResearchRequest } from "@x12i/research";
-import { type ExtractRequest, type ExtractResult, type ExtractionAdapter } from "@x12i/extract";
-import { type RunRecord, type RunStore, type ListItemsOptions, type ListItemsResult } from "@x12i/runs";
-import { type AnalyzeWebChangesRequest, type AnalyzeWebSourceRequest, type AnswerFromWebRequest, type AuditWebResearchRequest, type CompareWebSubjectsRequest, type FuncxExecutor, type WebFunctionBinding } from "@x12i/web-functions";
-export interface WebAgentClientOptions {
-    registry?: ParserRegistry;
-    fetchOptions?: FetchOptions;
-    reuseBrowser?: boolean;
-    search?: SearchProvider | SearchConfig | null;
-    fetchCache?: FetchCache;
-    snapshotStore?: SnapshotStore;
-    runStore?: RunStore;
-    extractionAdapter?: ExtractionAdapter;
-    /** When true, client owns and closes default in-memory stores it created. */
-    ownsDefaultStores?: boolean;
-    /** Injected FuncX executor. When omitted, built from env (default mode: disabled). */
-    funcxExecutor?: FuncxExecutor;
-    /** Operator-approved web function bindings. */
-    webFunctionBindings?: WebFunctionBinding[];
-    aiProfiles?: {
-        source?: "auto" | "remote" | "bundled";
-        catalogLane?: "text";
-    };
-    /** When true, SDK owns and may close an executor it constructed. Injected executors are never closed. */
-    ownsFuncxExecutor?: boolean;
+import { type StoredIdentity } from "./identity.js";
+import { type RankedPackage } from "./rank.js";
+import { type UsageFields } from "./protocol.js";
+export declare const SDK_VERSION: string;
+/** Catalog service. Override with X12I_SDK_URL. */
+export declare const DEFAULT_SERVICE_URL = "https://x12i-sdk.x12i.com";
+export declare class SdkError extends Error {
+    readonly status: number;
+    readonly code: string;
+    constructor(message: string, status?: number, code?: string);
 }
-export interface FetchSearchResultsOptions {
-    positions?: number[];
-    urls?: string[];
-    concurrency?: number;
-    continueOnError?: boolean;
-    fetchOptions?: FetchOptions;
-    signal?: AbortSignal;
+export type SearchResult = {
+    source: "service" | "registry";
+    ranked: boolean;
+    task: string;
+    results: RankedPackage[];
+};
+export type ReviewInput = {
+    package: string;
+    packageVersion: string;
+    agent: UsageFields["agent"];
+    outcome: UsageFields["outcome"];
+    rating: number;
+    worked?: string;
+    failed?: string;
+    needed?: string;
+    improve?: string;
+};
+export type ReportInput = Omit<ReviewInput, "rating">;
+export type ClientOptions = {
+    baseUrl?: string;
+    fetch?: typeof fetch;
+    identityPath?: string;
+};
+export type ReadmeStatus = "missing" | "stale" | "fresh";
+export type CachedPackage = {
+    readme: string;
+    readmeStatus: ReadmeStatus;
+    version: string | null;
+    description: string;
+    modifiedAt: string | null;
+    refreshedAt: string | null;
+};
+export type PackageView = {
+    name: string;
+    readme: string;
+    readmeStatus: ReadmeStatus;
+    version: string | null;
+    description: string;
+    modifiedAt: string | null;
+    refreshedAt: string | null;
+    updated: boolean;
+    source: "service" | "registry";
+    cached: CachedPackage;
+    detail: Record<string, unknown>;
+    refreshError?: string;
+};
+export declare class X12iClient {
+    readonly baseUrl: string;
+    readonly identityPath: string;
+    private readonly fetchImpl;
+    constructor(options?: ClientOptions);
+    search(task: string): Promise<SearchResult>;
+    catalog(cursor?: string, limit?: number): Promise<unknown>;
+    package(name: string): Promise<PackageView>;
+    readme(name: string): Promise<PackageView>;
+    reviews(name: string): Promise<unknown>;
+    report(input: ReportInput): Promise<unknown>;
+    review(input: ReviewInput): Promise<unknown>;
+    status(): Promise<unknown>;
+    ensureEnrolled(): Promise<StoredIdentity>;
+    private signedPost;
+    private readThrough;
+    private readmeFromRegistry;
+    private send;
 }
-export interface FetchedSearchPage {
-    position?: number;
-    url: string;
-    title?: string;
-    fetch?: FetchResult;
-    error?: string;
-}
-export interface SearchAndFetchRequest extends WebSearchRequest {
-    top?: number;
-    positions?: number[];
-    urls?: string[];
-    concurrency?: number;
-    continueOnError?: boolean;
-    fetchOptions?: FetchOptions;
-    signal?: AbortSignal;
-}
-export interface SearchAndFetchResult {
-    search: WebSearchResponse;
-    pages: FetchedSearchPage[];
-}
-/**
- * Canonical programmatic surface: fetch/retrieve/research/crawl/extract/runs.
- * CLI, REST, and MCP are thin adapters around this client.
- */
-export declare class WebAgentClient {
-    readonly registry: ParserRegistry;
-    private readonly defaultFetchOptions;
-    private readonly reuseBrowser;
-    private readonly searchProvider;
-    private browserPromise;
-    readonly fetchCache: FetchCache;
-    readonly snapshotStore: SnapshotStore;
-    readonly runStore: RunStore;
-    private readonly extractionAdapter?;
-    private readonly ownsCache;
-    private readonly ownsSnapshots;
-    private readonly ownsRuns;
-    private readonly funcxExecutor;
-    private readonly ownsFuncxExecutor;
-    private webFunctionBindings;
-    private readonly hostPolicy;
-    private readonly aiProfilesSource;
-    private readonly functionCheckpoints;
-    private activeRunEventSink?;
-    constructor(options?: WebAgentClientOptions);
-    private loadBindingsFromEnv;
-    private webFunctionsDeps;
-    private buildResearchFunctionHooks;
-    use<T>(parser: Parser<T>): this;
-    /** Download a URL via Playwright (compatibility default: browser strategy). */
-    fetch(url: string, options?: FetchOptions): Promise<FetchResult>;
-    /** Strategy-aware multi-format retrieval (default strategy: auto). */
-    retrieve(url: string, options?: RetrieveOptions): Promise<FetchResult>;
-    fetchBatch(request: {
-        urls: string[];
-        concurrency?: number;
-        continueOnError?: boolean;
-        retrieveOptions?: RetrieveOptions;
-        signal?: AbortSignal;
-    }): Promise<RetrieveBatchItem[]>;
-    retrieveCached(url: string, options?: CachedRetrieveOptions): Promise<FetchResult>;
-    classify(url: string, options?: FetchOptions): Promise<ClassifyCandidate[]>;
-    parse<T = unknown>(url: string, options?: FetchOptions): Promise<ParsedResult<T>>;
-    parseAs<T = unknown>(type: string, url: string, options?: FetchOptions): Promise<ParsedResult<T>>;
-    listParsers(): {
-        type: string;
-        description?: string;
-        version?: string;
-    }[];
-    ingest(rootUrl: string, options?: IngestOptions): Promise<IngestResult>;
-    search(request: WebSearchRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<WebSearchResponse>;
-    searchConfigured(): boolean;
-    fetchSearchResults(searchResult: WebSearchResponse, options?: FetchSearchResultsOptions): Promise<FetchedSearchPage[]>;
-    searchAndFetch(request: SearchAndFetchRequest): Promise<SearchAndFetchResult>;
-    research(request: ResearchRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<ResearchPacket>;
-    startResearch(request: ResearchRequest, opts?: {
-        idempotencyKey?: string;
-    }): Promise<RunRecord>;
-    private runResearchJob;
-    crawl(request: CrawlRequest, options?: {
-        signal?: AbortSignal;
-    }): Promise<CrawlResult>;
-    startCrawl(request: CrawlRequest, opts?: {
-        idempotencyKey?: string;
-    }): Promise<RunRecord>;
-    private runCrawlJob;
-    extract(request: ExtractRequest): Promise<ExtractResult>;
-    checkChanges(request: ChangeCheckRequest & {
-        url?: string;
-    }): Promise<ChangeCheckResult>;
-    analyze(request: AnalyzeWebSourceRequest, opts?: {
-        signal?: AbortSignal;
-    }): Promise<import("@x12i/web-functions").AnalyzeWebSourceResult>;
-    answer(request: AnswerFromWebRequest, opts?: {
-        signal?: AbortSignal;
-    }): Promise<import("@x12i/web-functions").GroundedAnswer>;
-    compare(request: CompareWebSubjectsRequest, opts?: {
-        signal?: AbortSignal;
-    }): Promise<import("@x12i/web-functions").WebComparison>;
-    analyzeChanges(request: AnalyzeWebChangesRequest, opts?: {
-        signal?: AbortSignal;
-    }): Promise<import("@x12i/web-functions").AnalyzeWebChangesResult>;
-    auditResearch(request: AuditWebResearchRequest, opts?: {
-        signal?: AbortSignal;
-    }): Promise<import("@x12i/web-functions").ResearchAuditResult>;
-    listWebFunctions(options?: {
-        role?: WebFunctionBinding["role"];
-    }): Promise<{
-        mode: import("@x12i/web-functions").FuncxExecutorMode;
-        bindings: {
-            status: "available" | "unavailable" | "incompatible" | "disabled";
-            reasons: string[];
-            warnings: string[];
-            functionVersion?: string;
-            catalogSource?: string;
-            effectiveSlots?: import("@x12i/web-functions").WebFunctionModelConfig;
-            binding: WebFunctionBinding;
-        }[];
-    }>;
-    listWebAIProfiles(options?: {
-        role?: string;
-    }): Promise<{
-        profiles: import("@x12i/ai-profiles").AIProfileSummary[];
-        choices: import("@x12i/ai-profiles").AIProfileChoiceSummary[];
-        catalogLane: "text";
-        source: import("@x12i/ai-profiles").RegistrySourceMode;
-        roleHint: string | undefined;
-    }>;
-    previewWebAIProfile(request: {
-        profileChoice: string;
-        bindingId?: string;
-    }): Promise<{
-        profileChoice: string;
-        resolved: import("@x12i/ai-profiles").ResolvedAIProfile;
-        note: string;
-        bindingId: string | undefined;
-        slots: import("@x12i/web-functions").WebFunctionModelConfig | undefined;
-    }>;
-    startAnswer(request: AnswerFromWebRequest, opts?: {
-        idempotencyKey?: string;
-    }): Promise<RunRecord>;
-    private runAnswerJob;
-    startCompare(request: CompareWebSubjectsRequest, opts?: {
-        idempotencyKey?: string;
-    }): Promise<RunRecord>;
-    private runCompareJob;
-    getRun(runId: string): Promise<RunRecord | undefined>;
-    listRunItems(runId: string, options?: ListItemsOptions): Promise<ListItemsResult>;
-    cancelRun(runId: string): Promise<RunRecord>;
-    resumeRun(runId: string): Promise<RunRecord>;
-    private getBrowser;
-    close(): Promise<void>;
-}
-//# sourceMappingURL=client.d.ts.map