dsh-search-enhance 0.1.0

package/lib/web-config/contracts.d.ts

@@ -0,0 +1,129 @@
+export declare const WEB_CONFIG_PATH = "/dsh-search-enhance/config";
+export declare const WEB_CREDENTIALS_PATH = "/dsh-search-enhance/credentials";
+export declare const WEB_BASE_URL_MAX_CHARACTERS = 8192;
+export declare const WEB_MODEL_MAX_CHARACTERS = 4096;
+export declare const WEB_CREDENTIAL_REF_MAX_CHARACTERS = 256;
+export declare const WEB_CREDENTIAL_VALUE_MAX_CHARACTERS: number;
+export declare const WEB_CREDENTIAL_SLOTS: readonly ["searchApi", "context7", "exa", "tavily", "firecrawl"];
+export type WebCredentialSlot = (typeof WEB_CREDENTIAL_SLOTS)[number];
+export declare const WEB_EDITABLE_PATHS: readonly [readonly ["defaultProfile"], readonly ["defaultDepth"], readonly ["toolTimeoutMs"], readonly ["toolDiscovery", "mode"], readonly ["searchApi", "baseUrl"], readonly ["searchApi", "protocol"], readonly ["searchApi", "model"], readonly ["searchApi", "thinkingLevel"], readonly ["searchApi", "credentialRef"], readonly ["searchApi", "timeoutMs"], readonly ["providers", "context7", "baseUrl"], readonly ["providers", "context7", "credentialRef"], readonly ["providers", "context7", "timeoutMs"], readonly ["providers", "exa", "baseUrl"], readonly ["providers", "exa", "credentialRef"], readonly ["providers", "exa", "timeoutMs"], readonly ["providers", "tavily", "baseUrl"], readonly ["providers", "tavily", "credentialRef"], readonly ["providers", "tavily", "timeoutMs"], readonly ["providers", "firecrawl", "baseUrl"], readonly ["providers", "firecrawl", "credentialRef"], readonly ["providers", "firecrawl", "timeoutMs"], readonly ["webExtract", "smartDirect", "proxyUrl"], readonly ["webExtract", "direct", "proxyUrl"]];
+export interface WebSearchApiConfig {
+    baseUrl: string;
+    protocol: string;
+    model: string;
+    thinkingLevel: string;
+    credentialRef: string;
+    timeoutMs: number;
+}
+export interface WebDiscoveryProviderConfig {
+    baseUrl: string;
+    credentialRef: string;
+    timeoutMs: number;
+}
+export interface WebProxyConfig {
+    proxyUrl: string;
+}
+export interface WebEditableConfig {
+    defaultProfile: string;
+    defaultDepth: string;
+    toolTimeoutMs: number;
+    toolDiscovery: {
+        mode: string;
+    };
+    searchApi: WebSearchApiConfig;
+    providers: {
+        context7: WebDiscoveryProviderConfig;
+        exa: WebDiscoveryProviderConfig;
+        tavily: WebDiscoveryProviderConfig;
+        firecrawl: WebDiscoveryProviderConfig;
+    };
+    webExtract: {
+        smartDirect: WebProxyConfig;
+        direct: WebProxyConfig;
+    };
+}
+export type WebConfigLayer = {
+    [Key in keyof WebEditableConfig]?: WebEditableConfig[Key] extends object ? {
+        [Nested in keyof WebEditableConfig[Key]]?: WebEditableConfig[Key][Nested] extends object ? {
+            [Leaf in keyof WebEditableConfig[Key][Nested]]?: WebEditableConfig[Key][Nested][Leaf];
+        } : WebEditableConfig[Key][Nested];
+    } : WebEditableConfig[Key];
+};
+export interface WebConfigOptions {
+    profiles: readonly string[];
+    depths: readonly string[];
+    protocols: readonly string[];
+    thinkingLevels: readonly string[];
+    toolDiscoveryModes: readonly string[];
+    proxyUrlMaxCharacters: number;
+}
+export interface WebCredentialState {
+    ref: string;
+    configured: boolean;
+    writable: boolean;
+    available: boolean;
+    source?: string;
+}
+export interface WebDiagnosticProviderStatus {
+    provider: string;
+    state: string;
+}
+export interface WebDiagnosticCapabilityStatus {
+    capability: string;
+    available: boolean;
+    required: boolean;
+    providers: readonly WebDiagnosticProviderStatus[];
+}
+export interface WebDiagnosticStatus {
+    capabilities: readonly WebDiagnosticCapabilityStatus[];
+    minimumProfile: {
+        profile: string;
+        satisfied: boolean;
+    };
+    missingProviders: number;
+    unavailableProviders: number;
+}
+export interface WebConfigSnapshot {
+    namespace: 'search-enhance';
+    revision: number;
+    applies: 'restart';
+    writable: boolean;
+    value: WebEditableConfig;
+    base?: WebConfigLayer;
+    user?: WebConfigLayer;
+    options: WebConfigOptions;
+    credentials: Record<WebCredentialSlot, WebCredentialState>;
+    diagnostics: WebDiagnosticStatus;
+}
+export type WebSettingsMutation = {
+    op: 'set';
+    path: readonly string[];
+    value: string | number;
+} | {
+    op: 'unset';
+    path: readonly string[];
+};
+export interface WebSettingsMutationRequest {
+    expectedRevision: number;
+    mutations: readonly WebSettingsMutation[];
+}
+export interface WebCredentialWriteRequest {
+    credential: WebCredentialSlot;
+    value: string;
+}
+export interface WebCredentialDeleteRequest {
+    credential: WebCredentialSlot;
+}
+export interface WebCredentialWriteResult {
+    credential: WebCredentialSlot;
+    state: WebCredentialState;
+    changed: boolean;
+}
+export interface WebBridgeErrorBody {
+    error: {
+        code: string;
+        message: string;
+        actualRevision?: number;
+    };
+}
+//# sourceMappingURL=contracts.d.ts.map

package/lib/web-config/contracts.js

@@ -0,0 +1,40 @@
+export const WEB_CONFIG_PATH = '/dsh-search-enhance/config';
+export const WEB_CREDENTIALS_PATH = '/dsh-search-enhance/credentials';
+export const WEB_BASE_URL_MAX_CHARACTERS = 8192;
+export const WEB_MODEL_MAX_CHARACTERS = 4096;
+export const WEB_CREDENTIAL_REF_MAX_CHARACTERS = 256;
+export const WEB_CREDENTIAL_VALUE_MAX_CHARACTERS = 16 * 1024;
+export const WEB_CREDENTIAL_SLOTS = [
+    'searchApi',
+    'context7',
+    'exa',
+    'tavily',
+    'firecrawl',
+];
+export const WEB_EDITABLE_PATHS = [
+    ['defaultProfile'],
+    ['defaultDepth'],
+    ['toolTimeoutMs'],
+    ['toolDiscovery', 'mode'],
+    ['searchApi', 'baseUrl'],
+    ['searchApi', 'protocol'],
+    ['searchApi', 'model'],
+    ['searchApi', 'thinkingLevel'],
+    ['searchApi', 'credentialRef'],
+    ['searchApi', 'timeoutMs'],
+    ['providers', 'context7', 'baseUrl'],
+    ['providers', 'context7', 'credentialRef'],
+    ['providers', 'context7', 'timeoutMs'],
+    ['providers', 'exa', 'baseUrl'],
+    ['providers', 'exa', 'credentialRef'],
+    ['providers', 'exa', 'timeoutMs'],
+    ['providers', 'tavily', 'baseUrl'],
+    ['providers', 'tavily', 'credentialRef'],
+    ['providers', 'tavily', 'timeoutMs'],
+    ['providers', 'firecrawl', 'baseUrl'],
+    ['providers', 'firecrawl', 'credentialRef'],
+    ['providers', 'firecrawl', 'timeoutMs'],
+    ['webExtract', 'smartDirect', 'proxyUrl'],
+    ['webExtract', 'direct', 'proxyUrl'],
+];
+//# sourceMappingURL=contracts.js.map

package/lib/web-config/host.d.ts

@@ -0,0 +1,12 @@
+import type { IncomingMessage } from 'node:http';
+import type { Context } from '@deepseek-ai/cordis';
+import { type WebConfigSnapshot } from './contracts.js';
+export declare const WEB_CONFIG_REQUEST_MAX_BYTES: number;
+export declare const WEB_CONFIG_RESPONSE_MAX_BYTES: number;
+export declare function readWebConfigSnapshot(ctx: Context, signal: AbortSignal): Promise<WebConfigSnapshot>;
+export declare function isTrustedWebConfigRequest(request: Pick<IncomingMessage, 'headers' | 'socket'>, requireOrigin: boolean): boolean;
+/** Register the plugin-owned Web configuration routes and return a quiescent disposer. */
+export declare function mountWebConfigBridge(ctx: Context): () => Promise<void>;
+/** Attach the optional Web bridge whenever the public webServer service is present. */
+export declare function installWebConfigBridge(ctx: Context): void;
+//# sourceMappingURL=host.d.ts.map