@123toto/ai-app-assistant-server 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,141 @@
+import { D as DocsAssistant, a as DocsAssistantStreamEvent, A as AiDocsConfiguration, B as BuiltInProvider } from './managed-server-7iurKxF1.cjs';
+export { b as AiDocsAccessRule, c as AiDocsConfigurationActor, d as AiDocsConfigurationAdministration, e as AiDocsConfigurationAuditChange, f as AiDocsConfigurationAuditEntry, g as AiDocsConfigurationAuditField, h as AiDocsConfigurationChangeEvent, i as AiDocsConfigurationConflictError, j as AiDocsConfigurationManager, k as AiDocsConfigurationManagerOptions, l as AiDocsConfigurationRepository, m as AiDocsConfigurationSaveResult, n as AiDocsConfigurationSynchronizer, o as AiDocsConfigurationView, p as AiDocsGenerationEvent, q as AiDocsGenerationOperation, r as AiDocsKeyValueStore, s as AiDocsManagedConfigurationSetup, t as AiDocsManagedStorage, u as AiDocsManagementError, v as AiDocsManagementErrorCode, w as AiDocsQuotaPolicy, x as AiDocsQuotaResult, y as AiDocsQuotaStore, z as AiDocsRecentFailure, C as AiDocsRedisClient, E as AiDocsRedisQuotaClient, F as AiDocsRedisTelemetryClient, G as AiDocsRuntimeIdentity, H as AiDocsSecretProtector, I as AiDocsTelemetryStore, J as AiDocsTelemetrySummary, K as AiModelDiscoveryError, L as AiModelInfo, N as AiProviderInfo, O as CreateAiDocsConfigurationRepositoryOptions, P as CreateManagedAiDocsRuntimeOptions, Q as CreateManagedAiDocsServerOptions, R as ListAiModelsOptions, S as ManagedAiDocsFetchHandlerOptions, T as ManagedAiDocsFetchHandlers, U as ManagedAiDocsRuntime, M as ManagedAiDocsServer, V as createAes256GcmSecretProtector, W as createAiDocsConfigurationRepository, X as createAiDocsFailureEvent, Y as createDisabledSecretProtector, Z as createDocsAssistant, _ as createManagedAiDocsFetchHandlers, $ as createManagedAiDocsRuntime, a0 as createManagedAiDocsServer, a1 as createMemoryAiDocsQuotaStore, a2 as createMemoryAiDocsStore, a3 as createMemoryAiDocsTelemetryStore, a4 as createPollingAiDocsConfigurationSynchronizer, a5 as createRedisAiDocsQuotaStore, a6 as createRedisAiDocsStore, a7 as createRedisAiDocsTelemetryStore, a8 as listAiModels, a9 as listAiProviders, aa as validateAndSaveAiDocsConfiguration } from './managed-server-7iurKxF1.cjs';
+import { AskDocumentationRequest, AskDocumentationResponse } from '@123toto/ai-app-assistant-contracts';
+export { AiDocsConfigurationFieldSource, AiDocsConfigurationInput, AiDocsConfigurationOptions, AiDocsConnectionResult, AiDocsConnectionTestInput, AiDocsCredentials, AiDocsManagedConfigurationView, AiDocsModelInfoContract, AiDocsProvider, AiDocsProviderInfoContract, AiDocsRuntimeConnection, AiDocsRuntimeConnectionStatus, AskDocumentationRequest, AskDocumentationResponse, AskDocumentationStreamEvent, EvidenceSource, GeneratedAnswer, PROTOCOL_VERSION, aiDocsAccessRuleSchema, aiDocsConfigurationInputSchema, aiDocsConfigurationOptionsSchema, aiDocsConfigurationSaveResultSchema, aiDocsConnectionResultSchema, aiDocsConnectionTestInputSchema, aiDocsCredentialsSchema, aiDocsManagedConfigurationViewSchema, aiDocsModelInfoSchema, aiDocsProviderInfoSchema, aiDocsProviderSchema, askDocumentationRequestSchema, askDocumentationResponseSchema, askDocumentationStreamEventSchema } from '@123toto/ai-app-assistant-contracts';
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { A as AnswerGenerator, D as DocumentationSource, a as DocsAssistantOptions, O as OpenApiDocument } from './ai-sdk-QImICd56.cjs';
+export { b as AiSdkConfigurationError, c as AiSdkConnectionTestOptions, d as AiSdkConnectionTestResult, e as AiSdkFailureCode, f as AiSdkGenerationError, g as AiSdkGeneratorOptions, E as EvidenceBundle, h as EvidenceItem, G as GenerationOptions, i as GenerationProgress, M as ModelCapabilities, j as createAiSdkGenerator, n as normalizeAiSdkGenerationError, t as testAiSdkConnection } from './ai-sdk-QImICd56.cjs';
+import 'ai';
+
+interface AiDocsFetchHandlerOptions<TContext = undefined> {
+    assistant: DocsAssistant;
+    /** Resolves framework-specific authentication into an application context. */
+    resolveContext?: (request: Request) => Promise<TContext> | TContext;
+    /** Optional application authorization executed before assistant work. */
+    authorize?: (context: TContext, request: Request) => Promise<void> | void;
+    /** Explicit opt-in for public prototypes without authentication hooks. */
+    allowAnonymous?: boolean;
+    /** Optional privacy/input policy applied after protocol validation. */
+    transformRequest?: (input: AskDocumentationRequest, context: TContext) => Promise<AskDocumentationRequest> | AskDocumentationRequest;
+    /** Optional privacy/output policy applied before serialization. */
+    transformResponse?: (response: AskDocumentationResponse, context: TContext) => Promise<AskDocumentationResponse> | AskDocumentationResponse;
+    /** Applies privacy rules to progressive text before it leaves the backend. */
+    transformStreamEvent?: (event: DocsAssistantStreamEvent, context: TContext) => Promise<DocsAssistantStreamEvent> | DocsAssistantStreamEvent;
+    /** Maximum HTTP request size. Defaults slightly above the protocol limit. */
+    maxBodyBytes?: number;
+    /** Maps application errors without coupling the library to one framework. */
+    onError?: (error: unknown, request: Request) => Promise<Response> | Response;
+}
+interface AiDocsFetchHandlers {
+    ask(request: Request): Promise<Response>;
+    stream(request: Request): Promise<Response>;
+    /** Dispatches to `stream` when the pathname ends in `/stream`, otherwise to `ask`. */
+    handle(request: Request): Promise<Response>;
+}
+/** Explicit safe HTTP error that host authorization hooks can throw. */
+declare class AiDocsRequestError extends Error {
+    readonly status: number;
+    readonly code: string;
+    constructor(status: number, code: string, message: string);
+}
+/**
+ * Creates Fetch API handlers usable by standards-based runtimes and thin
+ * Express, Fastify, Nest, Next.js, Hono, Bun or serverless adapters.
+ */
+declare function createAiDocsFetchHandlers<TContext = undefined>(options: AiDocsFetchHandlerOptions<TContext>): AiDocsFetchHandlers;
+
+interface AiDocsNodeHttpAdapterOptions {
+    /** Used when the incoming request does not expose an absolute URL. */
+    origin?: string;
+    /** Protects the adapter before constructing a Fetch API Request. */
+    maxBodyBytes?: number;
+}
+type AiDocsNodeHttpListener = (request: IncomingMessage, response: ServerResponse) => Promise<void>;
+/** Minimal shape implemented by both basic and managed Fetch handlers. */
+interface AiDocsNodeHttpHandler {
+    handle(request: Request): Promise<Response>;
+}
+/**
+ * Bridges Node's native HTTP objects to the framework-neutral Fetch handlers.
+ * Express, Nest-on-Express and Fastify can expose their raw request/response.
+ */
+declare function createAiDocsNodeHttpListener(handlers: AiDocsNodeHttpHandler, options?: AiDocsNodeHttpAdapterOptions): AiDocsNodeHttpListener;
+
+type AssistantPolicies = NonNullable<DocsAssistantOptions["policies"]>;
+interface CreateAiDocsServerOptions<TContext = undefined> {
+    /** A custom generator takes precedence over the provider:model shortcut. */
+    generator?: AnswerGenerator;
+    /** Provider-neutral model identifier, for example `mistral:mistral-small-latest`. */
+    model?: string;
+    apiKey?: string;
+    baseURL?: string;
+    timeoutMs?: number;
+    maxRetries?: number;
+    documents?: DocumentationSource[];
+    policies?: AssistantPolicies;
+    http?: Omit<AiDocsFetchHandlerOptions<TContext>, "assistant">;
+}
+interface AiDocsServer<TContext = undefined> {
+    assistant: DocsAssistant;
+    fetch: AiDocsFetchHandlers;
+    /** Retained for consumers that want direct programmatic calls. */
+    options: Readonly<CreateAiDocsServerOptions<TContext>>;
+}
+/**
+ * Minimal framework-neutral server factory. Applications can start with a
+ * model string and documents, then opt into auth, privacy and storage hooks.
+ */
+declare function createAiDocsServer<TContext = undefined>(options: CreateAiDocsServerOptions<TContext>): AiDocsServer<TContext>;
+
+interface AiDocsDeploymentDefaultsOptions {
+    enabled: boolean;
+    /** `provider:model`, for example `mistral:mistral-small-latest`. */
+    model?: string;
+    apiKeys?: Partial<Record<BuiltInProvider, string | undefined>>;
+    baseURLs?: Partial<Record<BuiltInProvider, string | undefined>>;
+    access?: AiDocsConfiguration["access"];
+    quota?: AiDocsConfiguration["quota"];
+    maxConversationTurns?: number;
+}
+interface AiDocsDeploymentDefaults {
+    configuration?: AiDocsConfiguration;
+    resolveApiKey(provider: BuiltInProvider): string | undefined;
+}
+/** Parses deployment defaults once while retaining provider-neutral runtime configuration. */
+declare function createAiDocsDeploymentDefaults(options: AiDocsDeploymentDefaultsOptions): AiDocsDeploymentDefaults;
+
+interface FilterOpenApiContextOptions {
+    /** Path prefixes that must never be sent to the assistant. */
+    excludePathPrefixes?: string[];
+    /** Schema names that must never be sent to the assistant. */
+    excludeSchemaNames?: RegExp;
+    /** Tag names that must never be sent to the assistant. */
+    excludeTagNames?: RegExp;
+}
+/**
+ * Returns a copy of an OpenAPI document stripped of operational assistant APIs
+ * or any other host-defined paths that should not become model context.
+ */
+declare function filterOpenApiContext(document: OpenApiDocument, options?: FilterOpenApiContextOptions): OpenApiDocument;
+
+interface OpenAiCompatibleGeneratorOptions {
+    endpoint: string;
+    model: string;
+    apiKey?: string;
+    apiKeyHeader?: string;
+    apiKeyPrefix?: string;
+    modelId?: string;
+    timeoutMs?: number;
+    maxOutputTokens?: number;
+    temperature?: number;
+    responseFormat?: "json-object" | "prompt-only";
+    headers?: Record<string, string>;
+    fetch?: typeof fetch;
+}
+/**
+ * Creates a small dependency-free adapter for OpenAI-compatible chat APIs.
+ * Credentials stay in the host backend and are never read from browser input.
+ */
+declare function createOpenAiCompatibleGenerator(options: OpenAiCompatibleGeneratorOptions): AnswerGenerator;
+
+export { AiDocsConfiguration, type AiDocsDeploymentDefaults, type AiDocsDeploymentDefaultsOptions, type AiDocsFetchHandlerOptions, type AiDocsFetchHandlers, type AiDocsNodeHttpAdapterOptions, type AiDocsNodeHttpHandler, type AiDocsNodeHttpListener, AiDocsRequestError, type AiDocsServer, AnswerGenerator, BuiltInProvider, type CreateAiDocsServerOptions, DocsAssistant, DocsAssistantOptions, DocsAssistantStreamEvent, DocumentationSource, type FilterOpenApiContextOptions, type OpenAiCompatibleGeneratorOptions, OpenApiDocument, createAiDocsDeploymentDefaults, createAiDocsFetchHandlers, createAiDocsNodeHttpListener, createAiDocsServer, createOpenAiCompatibleGenerator, filterOpenApiContext };

package/dist/index.d.ts

@@ -0,0 +1,141 @@
+import { D as DocsAssistant, a as DocsAssistantStreamEvent, A as AiDocsConfiguration, B as BuiltInProvider } from './managed-server-CrZumvVU.js';
+export { b as AiDocsAccessRule, c as AiDocsConfigurationActor, d as AiDocsConfigurationAdministration, e as AiDocsConfigurationAuditChange, f as AiDocsConfigurationAuditEntry, g as AiDocsConfigurationAuditField, h as AiDocsConfigurationChangeEvent, i as AiDocsConfigurationConflictError, j as AiDocsConfigurationManager, k as AiDocsConfigurationManagerOptions, l as AiDocsConfigurationRepository, m as AiDocsConfigurationSaveResult, n as AiDocsConfigurationSynchronizer, o as AiDocsConfigurationView, p as AiDocsGenerationEvent, q as AiDocsGenerationOperation, r as AiDocsKeyValueStore, s as AiDocsManagedConfigurationSetup, t as AiDocsManagedStorage, u as AiDocsManagementError, v as AiDocsManagementErrorCode, w as AiDocsQuotaPolicy, x as AiDocsQuotaResult, y as AiDocsQuotaStore, z as AiDocsRecentFailure, C as AiDocsRedisClient, E as AiDocsRedisQuotaClient, F as AiDocsRedisTelemetryClient, G as AiDocsRuntimeIdentity, H as AiDocsSecretProtector, I as AiDocsTelemetryStore, J as AiDocsTelemetrySummary, K as AiModelDiscoveryError, L as AiModelInfo, N as AiProviderInfo, O as CreateAiDocsConfigurationRepositoryOptions, P as CreateManagedAiDocsRuntimeOptions, Q as CreateManagedAiDocsServerOptions, R as ListAiModelsOptions, S as ManagedAiDocsFetchHandlerOptions, T as ManagedAiDocsFetchHandlers, U as ManagedAiDocsRuntime, M as ManagedAiDocsServer, V as createAes256GcmSecretProtector, W as createAiDocsConfigurationRepository, X as createAiDocsFailureEvent, Y as createDisabledSecretProtector, Z as createDocsAssistant, _ as createManagedAiDocsFetchHandlers, $ as createManagedAiDocsRuntime, a0 as createManagedAiDocsServer, a1 as createMemoryAiDocsQuotaStore, a2 as createMemoryAiDocsStore, a3 as createMemoryAiDocsTelemetryStore, a4 as createPollingAiDocsConfigurationSynchronizer, a5 as createRedisAiDocsQuotaStore, a6 as createRedisAiDocsStore, a7 as createRedisAiDocsTelemetryStore, a8 as listAiModels, a9 as listAiProviders, aa as validateAndSaveAiDocsConfiguration } from './managed-server-CrZumvVU.js';
+import { AskDocumentationRequest, AskDocumentationResponse } from '@123toto/ai-app-assistant-contracts';
+export { AiDocsConfigurationFieldSource, AiDocsConfigurationInput, AiDocsConfigurationOptions, AiDocsConnectionResult, AiDocsConnectionTestInput, AiDocsCredentials, AiDocsManagedConfigurationView, AiDocsModelInfoContract, AiDocsProvider, AiDocsProviderInfoContract, AiDocsRuntimeConnection, AiDocsRuntimeConnectionStatus, AskDocumentationRequest, AskDocumentationResponse, AskDocumentationStreamEvent, EvidenceSource, GeneratedAnswer, PROTOCOL_VERSION, aiDocsAccessRuleSchema, aiDocsConfigurationInputSchema, aiDocsConfigurationOptionsSchema, aiDocsConfigurationSaveResultSchema, aiDocsConnectionResultSchema, aiDocsConnectionTestInputSchema, aiDocsCredentialsSchema, aiDocsManagedConfigurationViewSchema, aiDocsModelInfoSchema, aiDocsProviderInfoSchema, aiDocsProviderSchema, askDocumentationRequestSchema, askDocumentationResponseSchema, askDocumentationStreamEventSchema } from '@123toto/ai-app-assistant-contracts';
+import { IncomingMessage, ServerResponse } from 'node:http';
+import { A as AnswerGenerator, D as DocumentationSource, a as DocsAssistantOptions, O as OpenApiDocument } from './ai-sdk-QImICd56.js';
+export { b as AiSdkConfigurationError, c as AiSdkConnectionTestOptions, d as AiSdkConnectionTestResult, e as AiSdkFailureCode, f as AiSdkGenerationError, g as AiSdkGeneratorOptions, E as EvidenceBundle, h as EvidenceItem, G as GenerationOptions, i as GenerationProgress, M as ModelCapabilities, j as createAiSdkGenerator, n as normalizeAiSdkGenerationError, t as testAiSdkConnection } from './ai-sdk-QImICd56.js';
+import 'ai';
+
+interface AiDocsFetchHandlerOptions<TContext = undefined> {
+    assistant: DocsAssistant;
+    /** Resolves framework-specific authentication into an application context. */
+    resolveContext?: (request: Request) => Promise<TContext> | TContext;
+    /** Optional application authorization executed before assistant work. */
+    authorize?: (context: TContext, request: Request) => Promise<void> | void;
+    /** Explicit opt-in for public prototypes without authentication hooks. */
+    allowAnonymous?: boolean;
+    /** Optional privacy/input policy applied after protocol validation. */
+    transformRequest?: (input: AskDocumentationRequest, context: TContext) => Promise<AskDocumentationRequest> | AskDocumentationRequest;
+    /** Optional privacy/output policy applied before serialization. */
+    transformResponse?: (response: AskDocumentationResponse, context: TContext) => Promise<AskDocumentationResponse> | AskDocumentationResponse;
+    /** Applies privacy rules to progressive text before it leaves the backend. */
+    transformStreamEvent?: (event: DocsAssistantStreamEvent, context: TContext) => Promise<DocsAssistantStreamEvent> | DocsAssistantStreamEvent;
+    /** Maximum HTTP request size. Defaults slightly above the protocol limit. */
+    maxBodyBytes?: number;
+    /** Maps application errors without coupling the library to one framework. */
+    onError?: (error: unknown, request: Request) => Promise<Response> | Response;
+}
+interface AiDocsFetchHandlers {
+    ask(request: Request): Promise<Response>;
+    stream(request: Request): Promise<Response>;
+    /** Dispatches to `stream` when the pathname ends in `/stream`, otherwise to `ask`. */
+    handle(request: Request): Promise<Response>;
+}
+/** Explicit safe HTTP error that host authorization hooks can throw. */
+declare class AiDocsRequestError extends Error {
+    readonly status: number;
+    readonly code: string;
+    constructor(status: number, code: string, message: string);
+}
+/**
+ * Creates Fetch API handlers usable by standards-based runtimes and thin
+ * Express, Fastify, Nest, Next.js, Hono, Bun or serverless adapters.
+ */
+declare function createAiDocsFetchHandlers<TContext = undefined>(options: AiDocsFetchHandlerOptions<TContext>): AiDocsFetchHandlers;
+
+interface AiDocsNodeHttpAdapterOptions {
+    /** Used when the incoming request does not expose an absolute URL. */
+    origin?: string;
+    /** Protects the adapter before constructing a Fetch API Request. */
+    maxBodyBytes?: number;
+}
+type AiDocsNodeHttpListener = (request: IncomingMessage, response: ServerResponse) => Promise<void>;
+/** Minimal shape implemented by both basic and managed Fetch handlers. */
+interface AiDocsNodeHttpHandler {
+    handle(request: Request): Promise<Response>;
+}
+/**
+ * Bridges Node's native HTTP objects to the framework-neutral Fetch handlers.
+ * Express, Nest-on-Express and Fastify can expose their raw request/response.
+ */
+declare function createAiDocsNodeHttpListener(handlers: AiDocsNodeHttpHandler, options?: AiDocsNodeHttpAdapterOptions): AiDocsNodeHttpListener;
+
+type AssistantPolicies = NonNullable<DocsAssistantOptions["policies"]>;
+interface CreateAiDocsServerOptions<TContext = undefined> {
+    /** A custom generator takes precedence over the provider:model shortcut. */
+    generator?: AnswerGenerator;
+    /** Provider-neutral model identifier, for example `mistral:mistral-small-latest`. */
+    model?: string;
+    apiKey?: string;
+    baseURL?: string;
+    timeoutMs?: number;
+    maxRetries?: number;
+    documents?: DocumentationSource[];
+    policies?: AssistantPolicies;
+    http?: Omit<AiDocsFetchHandlerOptions<TContext>, "assistant">;
+}
+interface AiDocsServer<TContext = undefined> {
+    assistant: DocsAssistant;
+    fetch: AiDocsFetchHandlers;
+    /** Retained for consumers that want direct programmatic calls. */
+    options: Readonly<CreateAiDocsServerOptions<TContext>>;
+}
+/**
+ * Minimal framework-neutral server factory. Applications can start with a
+ * model string and documents, then opt into auth, privacy and storage hooks.
+ */
+declare function createAiDocsServer<TContext = undefined>(options: CreateAiDocsServerOptions<TContext>): AiDocsServer<TContext>;
+
+interface AiDocsDeploymentDefaultsOptions {
+    enabled: boolean;
+    /** `provider:model`, for example `mistral:mistral-small-latest`. */
+    model?: string;
+    apiKeys?: Partial<Record<BuiltInProvider, string | undefined>>;
+    baseURLs?: Partial<Record<BuiltInProvider, string | undefined>>;
+    access?: AiDocsConfiguration["access"];
+    quota?: AiDocsConfiguration["quota"];
+    maxConversationTurns?: number;
+}
+interface AiDocsDeploymentDefaults {
+    configuration?: AiDocsConfiguration;
+    resolveApiKey(provider: BuiltInProvider): string | undefined;
+}
+/** Parses deployment defaults once while retaining provider-neutral runtime configuration. */
+declare function createAiDocsDeploymentDefaults(options: AiDocsDeploymentDefaultsOptions): AiDocsDeploymentDefaults;
+
+interface FilterOpenApiContextOptions {
+    /** Path prefixes that must never be sent to the assistant. */
+    excludePathPrefixes?: string[];
+    /** Schema names that must never be sent to the assistant. */
+    excludeSchemaNames?: RegExp;
+    /** Tag names that must never be sent to the assistant. */
+    excludeTagNames?: RegExp;
+}
+/**
+ * Returns a copy of an OpenAPI document stripped of operational assistant APIs
+ * or any other host-defined paths that should not become model context.
+ */
+declare function filterOpenApiContext(document: OpenApiDocument, options?: FilterOpenApiContextOptions): OpenApiDocument;
+
+interface OpenAiCompatibleGeneratorOptions {
+    endpoint: string;
+    model: string;
+    apiKey?: string;
+    apiKeyHeader?: string;
+    apiKeyPrefix?: string;
+    modelId?: string;
+    timeoutMs?: number;
+    maxOutputTokens?: number;
+    temperature?: number;
+    responseFormat?: "json-object" | "prompt-only";
+    headers?: Record<string, string>;
+    fetch?: typeof fetch;
+}
+/**
+ * Creates a small dependency-free adapter for OpenAI-compatible chat APIs.
+ * Credentials stay in the host backend and are never read from browser input.
+ */
+declare function createOpenAiCompatibleGenerator(options: OpenAiCompatibleGeneratorOptions): AnswerGenerator;
+
+export { AiDocsConfiguration, type AiDocsDeploymentDefaults, type AiDocsDeploymentDefaultsOptions, type AiDocsFetchHandlerOptions, type AiDocsFetchHandlers, type AiDocsNodeHttpAdapterOptions, type AiDocsNodeHttpHandler, type AiDocsNodeHttpListener, AiDocsRequestError, type AiDocsServer, AnswerGenerator, BuiltInProvider, type CreateAiDocsServerOptions, DocsAssistant, DocsAssistantOptions, DocsAssistantStreamEvent, DocumentationSource, type FilterOpenApiContextOptions, type OpenAiCompatibleGeneratorOptions, OpenApiDocument, createAiDocsDeploymentDefaults, createAiDocsFetchHandlers, createAiDocsNodeHttpListener, createAiDocsServer, createOpenAiCompatibleGenerator, filterOpenApiContext };