@promptbook/google 0.112.0-71 → 0.112.0-73

package/umd/src/llm-providers/openai/utils/OpenAiCompatibleChatToolCaller.d.ts

@@ -0,0 +1,57 @@
+import type OpenAI from 'openai';
+import type { ChatPromptResult } from '../../../execution/PromptResult';
+import type { Usage } from '../../../execution/Usage';
+import type { Prompt } from '../../../types/Prompt';
+import type { string_date_iso8601 } from '../../../types/string_token';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from '../OpenAiCompatibleExecutionToolsOptions';
+import { OpenAiCompatibleChatProgressReporter } from './OpenAiCompatibleChatProgressReporter';
+/**
+ * Type describing streamed tool call.
+ */
+type StreamedToolCall = NonNullable<ChatPromptResult['toolCalls']>[number];
+/**
+ * Dependencies required to execute tool calls requested by an OpenAI-compatible chat response.
+ */
+type OpenAiCompatibleChatToolCallerOptions = {
+    readonly executionToolsOptions: OpenAiCompatibleExecutionToolsNonProxiedOptions;
+    readonly progressReporter: OpenAiCompatibleChatProgressReporter;
+};
+/**
+ * Executes chat-requested tools and keeps their progress snapshots in sync with streamed progress updates.
+ *
+ * @private helper of `callOpenAiCompatibleChatModel`
+ */
+export declare class OpenAiCompatibleChatToolCaller {
+    private readonly options;
+    constructor(options: OpenAiCompatibleChatToolCallerOptions);
+    /**
+     * Executes all tool calls requested in one assistant response and appends their results to the conversation.
+     */
+    handleToolCalls(options: {
+        readonly prompt: Prompt;
+        readonly start: string_date_iso8601;
+        readonly turnComplete: string_date_iso8601;
+        readonly rawPromptContent: string;
+        readonly responseMessage: OpenAI.Chat.Completions.ChatCompletionMessage;
+        readonly rawRequest: OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming;
+        readonly rawResponse: OpenAI.Chat.Completions.ChatCompletion;
+        readonly modelName: string;
+        readonly usage: Usage;
+        readonly toolCalls: Array<StreamedToolCall>;
+        readonly messages: Array<OpenAI.Chat.Completions.ChatCompletionMessageParam>;
+        readonly onProgress: (chunk: ChatPromptResult) => void;
+    }): Promise<void>;
+    /**
+     * Executes one tool call requested by the chat response and appends the tool message.
+     */
+    private executeToolCall;
+    /**
+     * Resolves the configured script tools for chat tool execution.
+     */
+    private resolveScriptTools;
+    /**
+     * Executes the configured script tool for one chat-requested function call.
+     */
+    private executeFunctionTool;
+}
+export {};

package/umd/src/remote-server/startRemoteServer/RemoteServerRuntime.d.ts

@@ -0,0 +1,14 @@
+import type express from 'express';
+import type { ExecutionTask } from '../../execution/ExecutionTask';
+import type { StartRemoteServerConfiguration } from './StartRemoteServerConfiguration';
+/**
+ * Runtime state shared by HTTP and Socket.io handlers.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export type RemoteServerRuntime<TCustomOptions> = {
+    readonly app: express.Express;
+    readonly configuration: StartRemoteServerConfiguration<TCustomOptions>;
+    readonly runningExecutionTasks: Array<ExecutionTask>;
+    readonly startupDate: Date;
+};

package/umd/src/remote-server/startRemoteServer/SocketResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Internal representation of a socket response payload.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export type SocketResponse<TPayload> = {
+    readonly eventName: string;
+    readonly payload: TPayload;
+};

package/umd/src/remote-server/startRemoteServer/StartRemoteServerConfiguration.d.ts

@@ -0,0 +1,18 @@
+import type { ApplicationRemoteServerOptions, RemoteServerOptions } from '../types/RemoteServerOptions';
+/**
+ * Normalized configuration shared by remote-server helpers.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export type StartRemoteServerConfiguration<TCustomOptions> = {
+    readonly port: RemoteServerOptions<TCustomOptions>['port'];
+    readonly collection: ApplicationRemoteServerOptions<TCustomOptions>['collection'] | null;
+    readonly createExecutionTools: RemoteServerOptions<TCustomOptions>['createExecutionTools'];
+    readonly createLlmExecutionTools: ApplicationRemoteServerOptions<TCustomOptions>['createLlmExecutionTools'] | null;
+    readonly isAnonymousModeAllowed: boolean;
+    readonly isApplicationModeAllowed: boolean;
+    readonly isRichUi: boolean | undefined;
+    readonly isVerbose: boolean;
+    readonly login: ApplicationRemoteServerOptions<TCustomOptions>['login'] | null;
+    readonly startOptions: RemoteServerOptions<TCustomOptions>;
+};

package/umd/src/remote-server/startRemoteServer/createRemoteServerExpressApp.d.ts

@@ -0,0 +1,7 @@
+import express from 'express';
+/**
+ * Creates the base express application with shared middleware.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function createRemoteServerExpressApp(): express.Express;

package/umd/src/remote-server/startRemoteServer/createRemoteServerHandle.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import express from 'express';
+import http from 'http';
+import { Server } from 'socket.io';
+import type { RemoteServer } from '../RemoteServer';
+/**
+ * Creates the public RemoteServer handle with lazily exposed internals.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function createRemoteServerHandle(app: express.Express, httpServer: http.Server, server: Server): RemoteServer;

package/umd/src/remote-server/startRemoteServer/createSocketServer.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import http from 'http';
+import { Server } from 'socket.io';
+/**
+ * Creates the Socket.io server with the existing transport and CORS settings.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function createSocketServer(httpServer: http.Server): Server;

package/umd/src/remote-server/startRemoteServer/getExecutionToolsFromIdentification.d.ts

@@ -0,0 +1,12 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { Identification } from '../socket-types/_subtypes/Identification';
+import type { StartRemoteServerConfiguration } from './StartRemoteServerConfiguration';
+/**
+ * Builds execution tools for a single incoming identification.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function getExecutionToolsFromIdentification<TCustomOptions>(configuration: StartRemoteServerConfiguration<TCustomOptions>, identification: Identification<TCustomOptions> | null | undefined): Promise<ExecutionTools & {
+    llm: LlmExecutionTools;
+}>;

package/umd/src/remote-server/startRemoteServer/registerBookRoutes.d.ts

@@ -0,0 +1,7 @@
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers book listing and book source download routes.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerBookRoutes<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>): void;

package/umd/src/remote-server/startRemoteServer/registerExecutionRoutes.d.ts

@@ -0,0 +1,7 @@
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers execution task listing, detail, and creation routes.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerExecutionRoutes<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>): void;

package/umd/src/remote-server/startRemoteServer/registerListModelsSocketHandler.d.ts

@@ -0,0 +1,8 @@
+import type { Socket } from 'socket.io';
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers the socket list-models request handler.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerListModelsSocketHandler<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>, socket: Socket): void;

package/umd/src/remote-server/startRemoteServer/registerLoginRoute.d.ts

@@ -0,0 +1,7 @@
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers the application-mode login endpoint.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerLoginRoute<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>): void;

package/umd/src/remote-server/startRemoteServer/registerNotFoundRoute.d.ts

@@ -0,0 +1,7 @@
+import type express from 'express';
+/**
+ * Registers the catch-all 404 handler.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerNotFoundRoute(app: express.Express): void;

package/umd/src/remote-server/startRemoteServer/registerOpenAiCompatibleChatCompletionsRoute.d.ts

@@ -0,0 +1,7 @@
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers the OpenAI-compatible chat completions endpoint.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerOpenAiCompatibleChatCompletionsRoute<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>): void;

package/umd/src/remote-server/startRemoteServer/registerOpenApiRoutes.d.ts

@@ -0,0 +1,7 @@
+import type express from 'express';
+/**
+ * Registers OpenAPI validation, docs, and the raw specification route.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerOpenApiRoutes(app: express.Express): void;

package/umd/src/remote-server/startRemoteServer/registerPreparePipelineSocketHandler.d.ts

@@ -0,0 +1,8 @@
+import type { Socket } from 'socket.io';
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers the socket prepare-pipeline request handler.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerPreparePipelineSocketHandler<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>, socket: Socket): void;

package/umd/src/remote-server/startRemoteServer/registerPromptSocketHandler.d.ts

@@ -0,0 +1,8 @@
+import type { Socket } from 'socket.io';
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers the socket prompt execution request handler.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerPromptSocketHandler<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>, socket: Socket): void;

package/umd/src/remote-server/startRemoteServer/registerRemoteServerHttpRoutes.d.ts

@@ -0,0 +1,7 @@
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers all HTTP middleware and routes in the original order.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerRemoteServerHttpRoutes<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>): void;

package/umd/src/remote-server/startRemoteServer/registerRemoteServerSocketHandlers.d.ts

@@ -0,0 +1,8 @@
+import { Server } from 'socket.io';
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers socket connection lifecycle handlers and per-event request handlers.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerRemoteServerSocketHandlers<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>, server: Server): void;

package/umd/src/remote-server/startRemoteServer/registerServerIndexRoute.d.ts

@@ -0,0 +1,7 @@
+import type { RemoteServerRuntime } from './RemoteServerRuntime';
+/**
+ * Registers the server homepage route for both rich and markdown UIs.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function registerServerIndexRoute<TCustomOptions>(runtime: RemoteServerRuntime<TCustomOptions>): void;

package/umd/src/remote-server/startRemoteServer/resolveStartRemoteServerConfiguration.d.ts

@@ -0,0 +1,8 @@
+import type { RemoteServerOptions } from '../types/RemoteServerOptions';
+import type { StartRemoteServerConfiguration } from './StartRemoteServerConfiguration';
+/**
+ * Resolves option defaults once so the rest of the remote-server flow can work with a single shape.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function resolveStartRemoteServerConfiguration<TCustomOptions>(startOptions: RemoteServerOptions<TCustomOptions>): StartRemoteServerConfiguration<TCustomOptions>;

package/umd/src/remote-server/startRemoteServer/respondToSocketRequest.d.ts

@@ -0,0 +1,8 @@
+import type { Socket } from 'socket.io';
+import type { SocketResponse } from './SocketResponse';
+/**
+ * Executes one socket request and guarantees consistent error emission and cleanup.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function respondToSocketRequest<TPayload>(socket: Socket, createResponse: () => Promise<SocketResponse<TPayload>>): Promise<void>;

package/umd/src/remote-server/startRemoteServer/startListening.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import type http from 'http';
+import type { StartRemoteServerConfiguration } from './StartRemoteServerConfiguration';
+/**
+ * Starts the HTTP server and prints the startup diagnostics.
+ *
+ * @private internal utility of `startRemoteServer`
+ */
+export declare function startListening<TCustomOptions>(httpServer: http.Server, configuration: StartRemoteServerConfiguration<TCustomOptions>): void;

package/umd/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -3,6 +3,18 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { KnowledgeSourceJson } from '../../../pipeline/PipelineJson/KnowledgeSourceJson';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { ScraperSourceHandler } from '../Scraper';
+/**
+ * Tools needed for knowledge source handler creation.
+ *
+ * @private internal utility of `makeKnowledgeSourceHandler`
+ */
+type MakeKnowledgeSourceHandlerTools = Pick<ExecutionTools, 'fs' | 'fetch'>;
+/**
+ * Options relevant for knowledge source handler creation.
+ *
+ * @private internal utility of `makeKnowledgeSourceHandler`
+ */
+type MakeKnowledgeSourceHandlerOptions = Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>;
 /**
  * Factory function that creates a handler for processing knowledge sources.
  * Provides standardized processing of different types of knowledge sources
@@ -10,4 +22,5 @@ import type { ScraperSourceHandler } from '../Scraper';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: Pick<ExecutionTools, 'fs' | 'fetch'>, options?: Pick<PrepareAndScrapeOptions, 'rootDirname' | 'isVerbose'>): Promise<ScraperSourceHandler>;
+export declare function makeKnowledgeSourceHandler(knowledgeSource: SetOptional<KnowledgeSourceJson, 'name'>, tools: MakeKnowledgeSourceHandlerTools, options?: MakeKnowledgeSourceHandlerOptions): Promise<ScraperSourceHandler>;
+export {};

package/umd/src/utils/serialization/serializeToPromptbookJavascript.d.ts

@@ -2,6 +2,8 @@ import type { string_javascript } from '../../types/string_markdown';
 import type { TODO_any } from '../organization/TODO_any';
 /**
  * Type describing serialize to promptbook javascript return.
+ *
+ * @private Internal return type for `serializeToPromptbookJavascript`.
  */
 type SerializeToPromptbookJavascriptReturn = {
     /**

package/umd/src/utils/serialization/serializeToPromptbookJavascript.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.112.0-70`).
+ * It follows semantic versioning (e.g., `0.112.0-72`).
  *
  * @generated
  */