@promptbook/openai 0.103.0-4 → 0.103.0-41

package/esm/typings/src/llm-providers/agent/createAgentLlmExecutionTools.d.ts

@@ -1,19 +1,5 @@
-import type { string_book } from '../../book-2.0/agent-source/string_book';
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import { AgentLlmExecutionTools } from './AgentLlmExecutionTools';
-/**
- * Options for creating AgentLlmExecutionTools
- */
-export type CreateAgentLlmExecutionToolsOptions = {
-    /**
-     * The underlying LLM execution tools to wrap
-     */
-    llmTools: LlmExecutionTools;
-    /**
-     * The agent source string that defines the agent's behavior
-     */
-    agentSource: string_book;
-};
+import { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecutionToolsOptions';
 /**
  * Creates new AgentLlmExecutionTools that wrap underlying LLM tools with agent-specific behavior
  *
@@ -23,7 +9,3 @@ export declare const createAgentLlmExecutionTools: ((options: CreateAgentLlmExec
     packageName: string;
     className: string;
 };
-/**
- * TODO: [🧠] Consider adding validation for agent source format
- * TODO: [🧠] Consider adding options for caching behavior
- */

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -9,10 +9,17 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  *
  * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
  * @public exported from `@promptbook/openai`
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
     private readonly assistantId;
+    private readonly isCreatingNewAssistantsAllowed;
     /**
      * Creates OpenAI Execution Tools.
      *
@@ -25,6 +32,27 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
      * Calls OpenAI API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+    playground(): Promise<void>;
+    createNewAssistant(options: {
+        /**
+         * Name of the new assistant
+         */
+        readonly name: string_title;
+        /**
+         * Instructions for the new assistant
+         */
+        readonly instructions: string_markdown;
+    }): Promise<OpenAiAssistantExecutionTools>;
+    /**
+     * Discriminant for type guards
+     */
+    protected get discriminant(): string;
+    /**
+     * Type guard to check if given `LlmExecutionTools` are instanceof `OpenAiAssistantExecutionTools`
+     *
+     * Note: This is useful when you can possibly have multiple versions of `@promptbook/openai` installed
+     */
+    static isOpenAiAssistantExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAssistantExecutionTools;
 }
 /**
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts

@@ -7,8 +7,14 @@ import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleEx
  * @public exported from `@promptbook/openai`
  */
 export type OpenAiAssistantExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions & ClientOptions & {
+    /**
+     * Whether creating new assistants is allowed
+     *
+     * @default false
+     */
+    readonly isCreatingNewAssistantsAllowed?: boolean;
     /**
      * Which assistant to use
      */
-    assistantId: string_token;
+    readonly assistantId: string_token;
 };

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineCollection } from '../../collection/PipelineCollection';
+import type { PipelineCollection } from '../../collection/pipeline-collection/pipeline-collection/PipelineCollection';
 /**
  * Get pipeline collection for Untitled Promptbook project
  *

package/esm/typings/src/playground/permanent/_boilerplate.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/playground/permanent/agent-with-browser-playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/playground/playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

package/esm/typings/src/playground/playground1.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/esm/typings/src/remote-server/startAgentServer.d.ts

@@ -0,0 +1,23 @@
+import { TODO_any } from '../_packages/types.index';
+import { number_port } from '../types/typeAliases';
+type AgentsServerOptions = {
+    /**
+     * !!!
+     *
+     * @default 4440
+     */
+    port: number_port;
+};
+/**
+ * !!!!!
+ * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
+ *
+ * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
+ * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
+ *
+ * @see https://github.com/webgptorg/promptbook#remote-server
+ * @public exported from `@promptbook/remote-server`
+ * <- TODO: !!!! Maybe change to `@promptbook/agent-server`
+ */
+export declare function startAgentServer(options: AgentsServerOptions): Promise<TODO_any>;
+export {};

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -11,11 +11,14 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
+ * TODO !!!! Add agent
+ * TODO: !!!! Allow to chat with agents directly via remote server
+ * TODO: [🕋] Use here `aboutPromptbookInformation`
  * TODO: [🌡] Add CORS and security - probably via `helmet`
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createPipelineCollectionFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🗯] Timeout on chat to free up resources

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -1,17 +1,13 @@
 import type { Request, Response } from 'express';
 import type { Promisable } from 'type-fest';
-import type { PipelineCollection } from '../../collection/PipelineCollection';
+import { really_any } from '../../_packages/types.index';
+import type { PipelineCollection } from '../../collection/pipeline-collection/PipelineCollection';
 import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_app_id } from '../../types/typeAliases';
-import type { string_email } from '../../types/typeAliases';
-import type { string_password } from '../../types/typeAliases';
-import type { string_token } from '../../types/typeAliases';
-import type { string_user_id } from '../../types/typeAliases';
-import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
-import type { Identification } from '../socket-types/_subtypes/Identification';
+import type { string_app_id, string_email, string_password, string_token, string_user_id } from '../../types/typeAliases';
+import type { ApplicationModeIdentification, Identification } from '../socket-types/_subtypes/Identification';
 /**
  * Options for configuring the Promptbook remote server.
  *
@@ -31,6 +27,24 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @property {number} port The port number the server will listen on.
      */
     readonly port: number;
+    /**
+     * CORS options to apply to all endpoints (REST, UI, socket.io, etc.).
+     * Accepts the same options as the `cors` npm package and socket.io's CORS config.
+     * If not provided, defaults to permissive CORS (origin: '*').
+     * @see https://www.npmjs.com/package/cors
+     * @see https://socket.io/docs/v4/server-options/#cors
+     */
+    readonly cors?: {
+        origin?: string | string[] | boolean;
+        methods?: string | string[];
+        allowedHeaders?: string | string[];
+        exposedHeaders?: string | string[];
+        credentials?: boolean;
+        maxAge?: number;
+        preflightContinue?: boolean;
+        optionsSuccessStatus?: number;
+        [key: string]: really_any;
+    };
     /**
      * Enable rich UI (React + Tailwind) at `/` path.
      * Default: true

package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { BoilerplateScraper } from './BoilerplateScraper';
 /**
  * Constructor of `BoilerplateScraper`
  *
  * @public exported from `@promptbook/boilerplate`
  */
-export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => BoilerplateScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createBoilerplateScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const boilerplateScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const boilerplateScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { DocumentScraper } from './DocumentScraper';
 /**
  * Creates a scraper for document content.
  *
  * @public exported from `@promptbook/documents`
  */
-export declare const createDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => DocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: "Pandoc"[];
-}>;
+export declare const createDocumentScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/document/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const documentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: "Pandoc"[];
-}>;
+export declare const documentScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { LegacyDocumentScraper } from './LegacyDocumentScraper';
 /**
  * Creates a scraper for legacy document formats (.doc, .rtf, etc).
  * Uses LibreOffice for conversion to extract content from older document formats.
  *
  * @public exported from `@promptbook/legacy-documents`
  */
-export declare const createLegacyDocumentScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => LegacyDocumentScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: ("Pandoc" | "LibreOffice")[];
-}>;
+export declare const createLegacyDocumentScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/document-legacy/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const legacyDocumentScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: ("Pandoc" | "LibreOffice")[];
-}>;
+export declare const legacyDocumentScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -1,20 +1,9 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { MarkdownScraper } from './MarkdownScraper';
 /**
  * Creates a scraper for markdown content.
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: true;
-    requiredExecutables: never[];
-}>;
+export declare const createMarkdownScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/markdown/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const markdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: true;
-    requiredExecutables: never[];
-}>;
+export declare const markdownScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/markitdown/createMarkitdownScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { MarkitdownScraper } from './MarkitdownScraper';
 /**
  * Constructor of `MarkitdownScraper`
  *
  * @public exported from `@promptbook/markitdown`
  * @public exported from `@promptbook/pdf`
  */
-export declare const createMarkitdownScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => MarkitdownScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createMarkitdownScraper: any;
 /**
  * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/scrapers/markitdown/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const markitdownScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const markitdownScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { PdfScraper } from './PdfScraper';
 /**
  * Factory function to create an instance of PdfScraper.
  * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/pdf`
  */
-export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => PdfScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createPdfScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/pdf/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const pdfScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -1,21 +1,10 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import { WebsiteScraper } from './WebsiteScraper';
 /**
  * Factory function to create an instance of WebsiteScraper.
  * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/website-crawler`
  */
-export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => WebsiteScraper) & import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const createWebsiteScraper: any;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -4,15 +4,7 @@ import type { Registration } from '../../utils/misc/$Register';
  *
  * @private within the scraper directory
  */
-export declare const websiteScraperMetadata: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    title: string;
-    packageName: string;
-    className: string;
-    mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvailableInBrowser: false;
-    requiredExecutables: never[];
-}>;
+export declare const websiteScraperMetadata: any;
 /**
  * Registration of known scraper metadata
  *

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -1,4 +1,5 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Stores data in .env variables
  *
@@ -29,7 +30,7 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
     /**
      * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
      */
-    setItem(key: string, value: TItem): Promise<void>;
+    setItem(key: string, value: TItem): Promise<$side_effect>;
     /**
      * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
      */

package/esm/typings/src/transpilers/_common/BookTranspiler.d.ts

@@ -0,0 +1,29 @@
+import { Promisable } from 'type-fest';
+import { BookTranspilerOptions, ExecutionTools, Registered, string_book, string_name, string_script, string_title } from '../../_packages/types.index';
+/**
+ * Transpiler takes a book and transpiles it into another format (e.g., Langchain).
+ */
+export type BookTranspiler = Registered & {
+    /**
+     * The name of the transpiler.
+     * It is used to identify the transpiler in the register.
+     *
+     * @example 'python-langchain'
+     */
+    readonly name: string_name;
+    /**
+     * The title of the transpiler.
+     * It is used to display the transpiler in the UI.
+     *
+     * @example 'Python Langchain'
+     */
+    readonly title: string_title;
+    /**
+     * Transpiles a book.
+     *
+     * @param book book to transpile
+     * @param options additional options for the transpiler
+     * @returns transpiled book
+     */
+    transpileBook(book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions): Promisable<string_script>;
+};

package/esm/typings/src/transpilers/_common/BookTranspilerOptions.d.ts

@@ -0,0 +1,18 @@
+import { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+/**
+ * Options for the BookTranspiler.
+ */
+export type BookTranspilerOptions = Omit<CommonToolsOptions, 'maxRequestsPerMinute'> & {
+    /**
+     * If true, the transpiler will log verbose information to the console.
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+    /**
+     * If true, the transpiler will include comments in the output.
+     *
+     * @default true
+     */
+    readonly shouldIncludeComments?: boolean;
+};

package/esm/typings/src/transpilers/_common/register/$bookTranspilersRegister.d.ts

@@ -0,0 +1,15 @@
+import { $Register } from '../../../utils/misc/$Register';
+import { BookTranspiler } from '../BookTranspiler';
+/**
+ * Register for book transpilers.
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope
+ * @singleton Only one instance of each register is created per build, but there can be more instances across different builds or environments.
+ * @see https://github.com/webgptorg/promptbook/issues/249
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const $bookTranspilersRegister: $Register<BookTranspiler>;
+/**
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/transpilers/formatted-book-in-markdown/FormattedBookInMarkdownTranspiler.d.ts

@@ -0,0 +1,13 @@
+import { BookTranspilerOptions, ExecutionTools, string_book, string_markdown } from '../../_packages/types.index';
+/**
+ * Converts a book into a 1:1 formatted markdown
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const FormattedBookInMarkdownTranspiler: {
+    readonly name: "formatted-book-in-markdown";
+    readonly title: "Formatted Book in Markdown";
+    readonly packageName: "@promptbook/core";
+    readonly className: "FormattedBookInMarkdownTranspiler";
+    readonly transpileBook: (book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions) => string_markdown;
+};

package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts

@@ -0,0 +1,15 @@
+import { Registration } from '../../_packages/types.index';
+/**
+ * Registration of transpiler
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/wizard`
+ * @public exported from `@promptbook/cli`
+ *
+ * TODO: !!! Which package should export this?
+ */
+export declare const _FormattedBookInMarkdownTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.d.ts

@@ -0,0 +1,13 @@
+import { BookTranspilerOptions, ExecutionTools, string_book, string_script } from '../../_packages/types.index';
+/**
+ * Transpiler to Javascript code using OpenAI SDK.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const OpenAiSdkTranspiler: {
+    readonly name: "openai-sdk";
+    readonly title: "OpenAI SDK";
+    readonly packageName: "@promptbook/core";
+    readonly className: "OpenAiSdkTranspiler";
+    readonly transpileBook: (book: string_book, tools: ExecutionTools, options?: BookTranspilerOptions) => Promise<string_script>;
+};

package/esm/typings/src/transpilers/openai-sdk/OpenAiSdkTranspiler.test.d.ts

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

package/esm/typings/src/transpilers/openai-sdk/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */