@neottia/searchable-core 0.2.0

package/dist/config.d.ts

@@ -0,0 +1,423 @@
+import { z } from 'zod';
+export declare const SEARCHABLE_CONFIG_FILE_ENV = "NEOTTIA_CONFIG_FILE";
+export declare const SEARCHABLE_MODULE_CONFIG_FILE_ENV = "NEOTTIA_SEARCHABLE_CONFIG_FILE";
+export declare const SEARCHABLE_SHARD_PATH_ENV = "NEOTTIA_CONFIG_SEARCHABLE_PATH";
+export declare const DEFAULT_SEARCHABLE_SHARD_PATH = "skills.searchable";
+export declare const DEFAULT_SEARCHABLE_CONFIG_FILE = ".neottia/config.yml";
+export declare const searchableConfigSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    root: z.ZodDefault<z.ZodString>;
+    search: z.ZodPrefault<z.ZodObject<{
+        provider: z.ZodDefault<z.ZodEnum<{
+            duckduckgo: "duckduckgo";
+            google: "google";
+            bing: "bing";
+            brave: "brave";
+        }>>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        timeout_ms: z.ZodDefault<z.ZodNumber>;
+        credentials: z.ZodPrefault<z.ZodObject<{
+            google_api_key: z.ZodOptional<z.ZodString>;
+            google_cse_id: z.ZodOptional<z.ZodString>;
+            bing_api_key: z.ZodOptional<z.ZodString>;
+            brave_api_key: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        bing_api_endpoint: z.ZodDefault<z.ZodURL>;
+    }, z.core.$strict>>;
+    fetch: z.ZodPrefault<z.ZodObject<{
+        strategies: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            direct: "direct";
+            jina: "jina";
+            wayback: "wayback";
+        }>>>;
+        timeout_ms: z.ZodDefault<z.ZodNumber>;
+        overall_timeout_ms: z.ZodDefault<z.ZodNumber>;
+        max_response_bytes: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    grep: z.ZodPrefault<z.ZodObject<{
+        limit: z.ZodDefault<z.ZodNumber>;
+        snippet_bytes: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ask: z.ZodPrefault<z.ZodObject<{
+        limit: z.ZodDefault<z.ZodNumber>;
+        context_bytes: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ollama: z.ZodPrefault<z.ZodObject<{
+        endpoint: z.ZodDefault<z.ZodURL>;
+        model: z.ZodDefault<z.ZodString>;
+        timeout_ms: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    cache: z.ZodPrefault<z.ZodObject<{
+        max_age_ms: z.ZodDefault<z.ZodNumber>;
+        stale_policy: z.ZodDefault<z.ZodEnum<{
+            prompt: "prompt";
+            rebuild: "rebuild";
+            fail: "fail";
+        }>>;
+    }, z.core.$strip>>;
+    security: z.ZodPrefault<z.ZodObject<{
+        limits: z.ZodPrefault<z.ZodObject<{
+            max_query_bytes: z.ZodDefault<z.ZodNumber>;
+            max_url_bytes: z.ZodDefault<z.ZodNumber>;
+            max_title_bytes: z.ZodDefault<z.ZodNumber>;
+            max_content_bytes: z.ZodDefault<z.ZodNumber>;
+            max_results: z.ZodDefault<z.ZodNumber>;
+            max_result_bytes: z.ZodDefault<z.ZodNumber>;
+            max_storage_bytes: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const searchableConfigFileSchema: z.ZodObject<{
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    root: z.ZodDefault<z.ZodString>;
+    search: z.ZodPrefault<z.ZodObject<{
+        provider: z.ZodDefault<z.ZodEnum<{
+            duckduckgo: "duckduckgo";
+            google: "google";
+            bing: "bing";
+            brave: "brave";
+        }>>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        timeout_ms: z.ZodDefault<z.ZodNumber>;
+        credentials: z.ZodPrefault<z.ZodObject<{
+            google_api_key: z.ZodOptional<z.ZodString>;
+            google_cse_id: z.ZodOptional<z.ZodString>;
+            bing_api_key: z.ZodOptional<z.ZodString>;
+            brave_api_key: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        bing_api_endpoint: z.ZodDefault<z.ZodURL>;
+    }, z.core.$strict>>;
+    fetch: z.ZodPrefault<z.ZodObject<{
+        strategies: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            direct: "direct";
+            jina: "jina";
+            wayback: "wayback";
+        }>>>;
+        timeout_ms: z.ZodDefault<z.ZodNumber>;
+        overall_timeout_ms: z.ZodDefault<z.ZodNumber>;
+        max_response_bytes: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    grep: z.ZodPrefault<z.ZodObject<{
+        limit: z.ZodDefault<z.ZodNumber>;
+        snippet_bytes: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ask: z.ZodPrefault<z.ZodObject<{
+        limit: z.ZodDefault<z.ZodNumber>;
+        context_bytes: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ollama: z.ZodPrefault<z.ZodObject<{
+        endpoint: z.ZodDefault<z.ZodURL>;
+        model: z.ZodDefault<z.ZodString>;
+        timeout_ms: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    cache: z.ZodPrefault<z.ZodObject<{
+        max_age_ms: z.ZodDefault<z.ZodNumber>;
+        stale_policy: z.ZodDefault<z.ZodEnum<{
+            prompt: "prompt";
+            rebuild: "rebuild";
+            fail: "fail";
+        }>>;
+    }, z.core.$strip>>;
+    security: z.ZodPrefault<z.ZodObject<{
+        limits: z.ZodPrefault<z.ZodObject<{
+            max_query_bytes: z.ZodDefault<z.ZodNumber>;
+            max_url_bytes: z.ZodDefault<z.ZodNumber>;
+            max_title_bytes: z.ZodDefault<z.ZodNumber>;
+            max_content_bytes: z.ZodDefault<z.ZodNumber>;
+            max_results: z.ZodDefault<z.ZodNumber>;
+            max_result_bytes: z.ZodDefault<z.ZodNumber>;
+            max_storage_bytes: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const searchableConfigFilePatchSchema: z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    root: z.ZodOptional<z.ZodString>;
+    search: z.ZodOptional<z.ZodObject<{
+        provider: z.ZodOptional<z.ZodEnum<{
+            duckduckgo: "duckduckgo";
+            google: "google";
+            bing: "bing";
+            brave: "brave";
+        }>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        timeout_ms: z.ZodOptional<z.ZodNumber>;
+        credentials: z.ZodOptional<z.ZodObject<{
+            google_api_key: z.ZodOptional<z.ZodString>;
+            google_cse_id: z.ZodOptional<z.ZodString>;
+            bing_api_key: z.ZodOptional<z.ZodString>;
+            brave_api_key: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        bing_api_endpoint: z.ZodOptional<z.ZodURL>;
+    }, z.core.$strict>>;
+    fetch: z.ZodOptional<z.ZodObject<{
+        strategies: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            direct: "direct";
+            jina: "jina";
+            wayback: "wayback";
+        }>>>;
+        timeout_ms: z.ZodOptional<z.ZodNumber>;
+        overall_timeout_ms: z.ZodOptional<z.ZodNumber>;
+        max_response_bytes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    grep: z.ZodOptional<z.ZodObject<{
+        limit: z.ZodOptional<z.ZodNumber>;
+        snippet_bytes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ask: z.ZodOptional<z.ZodObject<{
+        limit: z.ZodOptional<z.ZodNumber>;
+        context_bytes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ollama: z.ZodOptional<z.ZodObject<{
+        endpoint: z.ZodOptional<z.ZodURL>;
+        model: z.ZodOptional<z.ZodString>;
+        timeout_ms: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    cache: z.ZodOptional<z.ZodObject<{
+        max_age_ms: z.ZodOptional<z.ZodNumber>;
+        stale_policy: z.ZodOptional<z.ZodEnum<{
+            prompt: "prompt";
+            rebuild: "rebuild";
+            fail: "fail";
+        }>>;
+    }, z.core.$strip>>;
+    security: z.ZodOptional<z.ZodObject<{
+        limits: z.ZodOptional<z.ZodObject<{
+            max_query_bytes: z.ZodOptional<z.ZodNumber>;
+            max_url_bytes: z.ZodOptional<z.ZodNumber>;
+            max_title_bytes: z.ZodOptional<z.ZodNumber>;
+            max_content_bytes: z.ZodOptional<z.ZodNumber>;
+            max_results: z.ZodOptional<z.ZodNumber>;
+            max_result_bytes: z.ZodOptional<z.ZodNumber>;
+            max_storage_bytes: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export declare const searchableConfigRuntimePatchSchema: z.ZodObject<{
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    root: z.ZodOptional<z.ZodString>;
+    search: z.ZodOptional<z.ZodObject<{
+        provider: z.ZodOptional<z.ZodEnum<{
+            duckduckgo: "duckduckgo";
+            google: "google";
+            bing: "bing";
+            brave: "brave";
+        }>>;
+        limit: z.ZodOptional<z.ZodNumber>;
+        timeout_ms: z.ZodOptional<z.ZodNumber>;
+        credentials: z.ZodOptional<z.ZodObject<{
+            google_api_key: z.ZodOptional<z.ZodString>;
+            google_cse_id: z.ZodOptional<z.ZodString>;
+            bing_api_key: z.ZodOptional<z.ZodString>;
+            brave_api_key: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        bing_api_endpoint: z.ZodOptional<z.ZodURL>;
+    }, z.core.$strict>>;
+    fetch: z.ZodOptional<z.ZodObject<{
+        strategies: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+            direct: "direct";
+            jina: "jina";
+            wayback: "wayback";
+        }>>>;
+        timeout_ms: z.ZodOptional<z.ZodNumber>;
+        overall_timeout_ms: z.ZodOptional<z.ZodNumber>;
+        max_response_bytes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    grep: z.ZodOptional<z.ZodObject<{
+        limit: z.ZodOptional<z.ZodNumber>;
+        snippet_bytes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ask: z.ZodOptional<z.ZodObject<{
+        limit: z.ZodOptional<z.ZodNumber>;
+        context_bytes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    ollama: z.ZodOptional<z.ZodObject<{
+        endpoint: z.ZodOptional<z.ZodURL>;
+        model: z.ZodOptional<z.ZodString>;
+        timeout_ms: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>;
+    cache: z.ZodOptional<z.ZodObject<{
+        max_age_ms: z.ZodOptional<z.ZodNumber>;
+        stale_policy: z.ZodOptional<z.ZodEnum<{
+            prompt: "prompt";
+            rebuild: "rebuild";
+            fail: "fail";
+        }>>;
+    }, z.core.$strip>>;
+    security: z.ZodOptional<z.ZodObject<{
+        limits: z.ZodOptional<z.ZodObject<{
+            max_query_bytes: z.ZodOptional<z.ZodNumber>;
+            max_url_bytes: z.ZodOptional<z.ZodNumber>;
+            max_title_bytes: z.ZodOptional<z.ZodNumber>;
+            max_content_bytes: z.ZodOptional<z.ZodNumber>;
+            max_results: z.ZodOptional<z.ZodNumber>;
+            max_result_bytes: z.ZodOptional<z.ZodNumber>;
+            max_storage_bytes: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type SearchableConfig = z.output<typeof searchableConfigSchema>;
+export type SearchableConfigInput = z.input<typeof searchableConfigSchema>;
+export type SearchableLimits = SearchableConfig['security']['limits'];
+interface SearchableEnvironmentBinding {
+    readonly path: string;
+    readonly names: readonly string[];
+    readonly kind: 'boolean' | 'integer' | 'string';
+}
+export declare const SEARCHABLE_ENV_BINDINGS: readonly SearchableEnvironmentBinding[];
+export declare const searchableConfigContribution: import("@neottia/config").ConfigContribution<{
+    enabled?: boolean | undefined;
+    root?: string | undefined;
+    search?: {
+        provider?: "duckduckgo" | "google" | "bing" | "brave" | undefined;
+        limit?: number | undefined;
+        timeout_ms?: number | undefined;
+        credentials?: {
+            google_api_key?: string | undefined;
+            google_cse_id?: string | undefined;
+            bing_api_key?: string | undefined;
+            brave_api_key?: string | undefined;
+        } | undefined;
+        bing_api_endpoint?: string | undefined;
+    } | undefined;
+    fetch?: {
+        strategies?: ("direct" | "jina" | "wayback")[] | undefined;
+        timeout_ms?: number | undefined;
+        overall_timeout_ms?: number | undefined;
+        max_response_bytes?: number | undefined;
+    } | undefined;
+    grep?: {
+        limit?: number | undefined;
+        snippet_bytes?: number | undefined;
+    } | undefined;
+    ask?: {
+        limit?: number | undefined;
+        context_bytes?: number | undefined;
+    } | undefined;
+    ollama?: {
+        endpoint?: string | undefined;
+        model?: string | undefined;
+        timeout_ms?: number | undefined;
+    } | undefined;
+    cache?: {
+        max_age_ms?: number | undefined;
+        stale_policy?: "prompt" | "rebuild" | "fail" | undefined;
+    } | undefined;
+    security?: {
+        limits?: {
+            max_query_bytes?: number | undefined;
+            max_url_bytes?: number | undefined;
+            max_title_bytes?: number | undefined;
+            max_content_bytes?: number | undefined;
+            max_results?: number | undefined;
+            max_result_bytes?: number | undefined;
+            max_storage_bytes?: number | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    enabled?: boolean | undefined;
+    root?: string | undefined;
+    search?: {
+        provider?: "duckduckgo" | "google" | "bing" | "brave" | undefined;
+        limit?: number | undefined;
+        timeout_ms?: number | undefined;
+        credentials?: {
+            google_api_key?: string | undefined;
+            google_cse_id?: string | undefined;
+            bing_api_key?: string | undefined;
+            brave_api_key?: string | undefined;
+        } | undefined;
+        bing_api_endpoint?: string | undefined;
+    } | undefined;
+    fetch?: {
+        strategies?: ("direct" | "jina" | "wayback")[] | undefined;
+        timeout_ms?: number | undefined;
+        overall_timeout_ms?: number | undefined;
+        max_response_bytes?: number | undefined;
+    } | undefined;
+    grep?: {
+        limit?: number | undefined;
+        snippet_bytes?: number | undefined;
+    } | undefined;
+    ask?: {
+        limit?: number | undefined;
+        context_bytes?: number | undefined;
+    } | undefined;
+    ollama?: {
+        endpoint?: string | undefined;
+        model?: string | undefined;
+        timeout_ms?: number | undefined;
+    } | undefined;
+    cache?: {
+        max_age_ms?: number | undefined;
+        stale_policy?: "prompt" | "rebuild" | "fail" | undefined;
+    } | undefined;
+    security?: {
+        limits?: {
+            max_query_bytes?: number | undefined;
+            max_url_bytes?: number | undefined;
+            max_title_bytes?: number | undefined;
+            max_content_bytes?: number | undefined;
+            max_results?: number | undefined;
+            max_result_bytes?: number | undefined;
+            max_storage_bytes?: number | undefined;
+        } | undefined;
+    } | undefined;
+}, {
+    enabled: boolean;
+    root: string;
+    search: {
+        provider: "duckduckgo" | "google" | "bing" | "brave";
+        limit: number;
+        timeout_ms: number;
+        credentials: {
+            google_api_key?: string | undefined;
+            google_cse_id?: string | undefined;
+            bing_api_key?: string | undefined;
+            brave_api_key?: string | undefined;
+        };
+        bing_api_endpoint: string;
+    };
+    fetch: {
+        strategies: ("direct" | "jina" | "wayback")[];
+        timeout_ms: number;
+        overall_timeout_ms: number;
+        max_response_bytes: number;
+    };
+    grep: {
+        limit: number;
+        snippet_bytes: number;
+    };
+    ask: {
+        limit: number;
+        context_bytes: number;
+    };
+    ollama: {
+        endpoint: string;
+        model: string;
+        timeout_ms: number;
+    };
+    cache: {
+        max_age_ms: number;
+        stale_policy: "prompt" | "rebuild" | "fail";
+    };
+    security: {
+        limits: {
+            max_query_bytes: number;
+            max_url_bytes: number;
+            max_title_bytes: number;
+            max_content_bytes: number;
+            max_results: number;
+            max_result_bytes: number;
+            max_storage_bytes: number;
+        };
+    };
+}>;
+export type LoadSearchableConfigOptions = Partial<SearchableConfigInput> & {
+    env?: NodeJS.ProcessEnv;
+};
+export declare function loadSearchableConfig(cwd: string, options?: LoadSearchableConfigOptions): SearchableConfig;
+export declare function resolveConfigFile(cwd: string, env?: NodeJS.ProcessEnv): string;
+export declare function resolveShardPath(env?: NodeJS.ProcessEnv): string;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAKxB,eAAO,MAAM,0BAA0B,wBAAwB,CAAC;AAEhE,eAAO,MAAM,iCAAiC,mCAAmC,CAAC;AAElF,eAAO,MAAM,yBAAyB,mCAAmC,CAAC;AAE1E,eAAO,MAAM,6BAA6B,sBAAsB,CAAC;AAEjE,eAAO,MAAM,8BAA8B,wBAAwB,CAAC;AAqLpE,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAgD,CAAC;AAEpF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAoD,CAAC;AAE5F,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAyD,CAAC;AAEtG,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAAqD,CAAC;AAErG,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAC;AACvE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAC3E,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEtE,UAAU,4BAA4B;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;CACjD;AAGD,eAAO,MAAM,uBAAuB,EAAE,SAAS,4BAA4B,EAmC1E,CAAC;AAaF,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsBvC,CAAC;AAGH,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC,qBAAqB,CAAC,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;CAAE,CAAC;AAOvG,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,2BAAgC,GAAG,gBAAgB,CA2B7G;AAGD,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,CAG3F;AAGD,wBAAgB,gBAAgB,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,CAU7E"}