@autorag/librarian 2.1.0 → 2.2.0

package/dist/datasource/skills/obsidian/skill.d.ts

@@ -1,20 +1,43 @@
-/**
- * Obsidian vault datasource skill (issue #1314).
- *
- * Thin composition of ObsidianConnector with the shared
- * {@link ConnectorDatasourceSkill} base: descriptor, polling metadata,
- * ok/fail indexing with path/PII-opaque diagnostics, lexical retrieval via
- * the shared pipeline, opaque `/obsidian/<instance>/…` sources, and a
- * progressive-disclosure agent-skill manifest.
- */
-import { ConnectorDatasourceSkill, type ConnectorSkillDefinition, type ConnectorSkillOptions } from "../../connector-skill.js";
-import { ObsidianConnector, type ObsidianConnectorOptions } from "./connector.js";
-export declare const OBSIDIAN_SKILL_DEFINITION: ConnectorSkillDefinition;
-export interface ObsidianSkillOptions extends Omit<ConnectorSkillOptions, "connector"> {
-    /** Trusted connector configuration; a pre-built connector wins. */
-    readonly connector?: ObsidianConnector;
-    readonly connectorOptions?: ObsidianConnectorOptions;
+import type { RetrievalMethod } from "../../../retrieval/types.js";
+import type { DatasourceIndexResult, DatasourceSkill, DatasourceSkillDescriptor, DatasourceSkillManifest, PollingMetadata, SourceDescription } from "../../types.js";
+import { type ObsidianSearchClient } from "./methods.js";
+import type { QmdEmbedResult, QmdEnsureResult, QmdUpdateResult } from "./types.js";
+export interface ObsidianSkillClient extends ObsidianSearchClient {
+    ensureCollection(): Promise<QmdEnsureResult>;
+    update(): Promise<QmdUpdateResult>;
+    embed(): Promise<QmdEmbedResult>;
 }
-export declare class ObsidianSkill extends ConnectorDatasourceSkill {
+export interface ObsidianSkillOptions {
+    readonly client?: ObsidianSkillClient;
+    readonly vaultPath?: string;
+    readonly binaryPath?: string;
+    readonly instanceId?: string;
+    readonly instances?: readonly string[];
+    readonly pollingIntervalMs?: number;
+    readonly tags?: readonly string[];
+    readonly lastIndexedAt?: number;
+    readonly workspaceRoot?: string;
+    readonly collectionName?: string;
+    readonly timeoutMs?: number;
+    readonly connectorOptions?: {
+        readonly vaultPath?: string;
+    };
+}
+export declare class ObsidianSkill implements DatasourceSkill {
+    private readonly client;
+    private readonly instanceId;
+    private readonly instances;
+    private readonly pollingIntervalMs;
+    private readonly tags;
+    private readonly vaultPath;
+    private lastIndexedAt;
+    private lastError;
     constructor(options?: ObsidianSkillOptions);
+    describe(): DatasourceSkillDescriptor;
+    polling(): PollingMetadata;
+    index(): Promise<DatasourceIndexResult>;
+    retrievalMethods(): readonly RetrievalMethod[];
+    describeSources(): readonly SourceDescription[];
+    skillManifest(): DatasourceSkillManifest;
+    private fail;
 }

package/dist/datasource/skills/obsidian/types.d.ts

@@ -0,0 +1,90 @@
+import type { RetrievalOptions } from "../../../retrieval/types.js";
+/**
+ * Search modes accepted by the external `qmd` CLI.
+ *
+ * - `search`  — BM25 / FTS5 lexical search
+ * - `vsearch` — dense vector semantic search
+ */
+export type QmdSearchMode = "search" | "vsearch";
+/**
+ * Configuration for {@link QmdClient}. The client spawns the `qmd` binary as a
+ * child process and isolates config/cache under the AutoRAG workspace.
+ */
+export interface QmdOptions {
+    /** Explicit path to the `qmd` binary. Defaults to a bare `qmd` PATH lookup. */
+    readonly binaryPath?: string;
+    /** Spawn timeout in milliseconds. Default 60_000 (embed can be slow). */
+    readonly timeoutMs?: number;
+    /** Max stdout/stderr bytes retained. Default 1_048_576 (1 MiB). */
+    readonly maxBufferBytes?: number;
+    /** Absolute path to the Obsidian vault. Required for ensure/update. */
+    readonly vaultPath?: string;
+    /** AutoRAG workspace root used to isolate qmd config/cache. */
+    readonly workspaceRoot?: string;
+    /** Instance id used for source paths and collection naming. Default `default`. */
+    readonly instanceId?: string;
+    /** Explicit collection name; defaults to a sanitized instance id. */
+    readonly collectionName?: string;
+    /** Environment overrides merged on top of a restricted process env. */
+    readonly env?: Readonly<Record<string, string | undefined>>;
+}
+export declare const DEFAULT_QMD_BINARY = "qmd";
+export declare const DEFAULT_QMD_TIMEOUT_MS = 60000;
+export declare const DEFAULT_QMD_MAX_BUFFER_BYTES = 1048576;
+export type QmdFailureReason = "binary-missing" | "not-configured" | "nonzero-exit" | "spawn-error" | "timeout" | "aborted" | "stdout-too-large" | "stderr-too-large" | "invalid-json" | "invalid-shape";
+export interface QmdFailure {
+    readonly ok: false;
+    readonly reason: QmdFailureReason;
+    readonly stdout: string;
+    readonly stderr: string;
+    readonly code: number | null;
+}
+export interface QmdOk<T> {
+    readonly ok: true;
+    readonly data: T;
+    readonly stdout: string;
+    readonly stderr: string;
+    readonly code: number;
+}
+export interface QmdUpdateInfo {
+    readonly indexed: number;
+    readonly updated: number;
+    readonly unchanged: number;
+    readonly removed: number;
+    readonly needsEmbedding?: boolean;
+    readonly metadata?: Readonly<Record<string, unknown>>;
+}
+export interface QmdEmbedInfo {
+    readonly embedded: boolean;
+    readonly metadata?: Readonly<Record<string, unknown>>;
+}
+export interface QmdEnsureInfo {
+    readonly collectionName: string;
+    readonly vaultPath: string;
+    readonly configDir: string;
+}
+/** A scored search hit from `qmd search` / `qmd vsearch`. */
+export interface QmdSearchHit {
+    readonly chunkId: string;
+    readonly score: number;
+    readonly content: string;
+    readonly title?: string;
+    readonly file?: string;
+    readonly docid?: string;
+    readonly metadata?: Readonly<Record<string, unknown>>;
+}
+export interface QmdSearchOk {
+    readonly ok: true;
+    readonly hits: readonly QmdSearchHit[];
+    readonly stdout: string;
+    readonly stderr: string;
+    readonly code: number;
+    readonly data: {
+        readonly hits: readonly QmdSearchHit[];
+    };
+}
+export type QmdEnsureResult = QmdOk<QmdEnsureInfo> | QmdFailure;
+export type QmdUpdateResult = QmdOk<QmdUpdateInfo> | QmdFailure;
+export type QmdEmbedResult = QmdOk<QmdEmbedInfo> | QmdFailure;
+export type QmdSearchResult = QmdSearchOk | QmdFailure;
+export type QmdSearchOptions = RetrievalOptions;

package/dist/datasource/skills/slack/index.d.ts

@@ -1,2 +1,15 @@
-export { SlackConnector, type SlackConnectorOptions } from "./connector.js";
-export { SLACK_SKILL_DEFINITION, SlackSkill, type SlackSkillOptions } from "./skill.js";
+import { CrawlerCliClient } from "../../crawler-client.js";
+import { CrawlerDatasourceSkill, type CrawlerDatasourceSkillOptions, type CrawlerSkillClient } from "../../crawler-skill.js";
+import type { CrawlerCliOptions } from "../../crawler-types.js";
+export interface SlacrawlOptions extends CrawlerCliOptions {
+}
+export declare class SlacrawlClient extends CrawlerCliClient {
+    constructor(options?: SlacrawlOptions);
+}
+export interface SlackSkillOptions extends Omit<CrawlerDatasourceSkillOptions, "client"> {
+    readonly client?: CrawlerSkillClient;
+    readonly connectorOptions?: SlacrawlOptions;
+}
+export declare class SlackSkill extends CrawlerDatasourceSkill {
+    constructor(options?: SlackSkillOptions);
+}

package/dist/datasource/skills/telecrawl/index.d.ts

@@ -0,0 +1,15 @@
+import { CrawlerCliClient } from "../../crawler-client.js";
+import { CrawlerDatasourceSkill, type CrawlerDatasourceSkillOptions, type CrawlerSkillClient } from "../../crawler-skill.js";
+import type { CrawlerCliOptions } from "../../crawler-types.js";
+export interface TelecrawlOptions extends CrawlerCliOptions {
+}
+export declare class TelecrawlClient extends CrawlerCliClient {
+    constructor(options?: TelecrawlOptions);
+}
+export interface TelecrawlSkillOptions extends Omit<CrawlerDatasourceSkillOptions, "client"> {
+    readonly client?: CrawlerSkillClient;
+    readonly connectorOptions?: TelecrawlOptions;
+}
+export declare class TelecrawlSkill extends CrawlerDatasourceSkill {
+    constructor(options?: TelecrawlSkillOptions);
+}

package/dist/datasource/skills/wacrawl/index.d.ts

@@ -0,0 +1,15 @@
+import { CrawlerCliClient } from "../../crawler-client.js";
+import { CrawlerDatasourceSkill, type CrawlerDatasourceSkillOptions, type CrawlerSkillClient } from "../../crawler-skill.js";
+import type { CrawlerCliOptions } from "../../crawler-types.js";
+export interface WacrawlOptions extends CrawlerCliOptions {
+}
+export declare class WacrawlClient extends CrawlerCliClient {
+    constructor(options?: WacrawlOptions);
+}
+export interface WacrawlSkillOptions extends Omit<CrawlerDatasourceSkillOptions, "client"> {
+    readonly client?: CrawlerSkillClient;
+    readonly connectorOptions?: WacrawlOptions;
+}
+export declare class WacrawlSkill extends CrawlerDatasourceSkill {
+    constructor(options?: WacrawlSkillOptions);
+}