@promptbook/vercel 0.103.0-23 → 0.103.0-25

package/esm/index.es.js

@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-23';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-25';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/cli.index.d.ts

@@ -30,6 +30,8 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { _LangchainTranspilerRegistration } from '../transpilers/langchain/register';
+import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai/register';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _CLI };
 export { _AnthropicClaudeMetadataRegistration };
@@ -62,3 +64,5 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { _LangchainTranspilerRegistration };
+export { _OpenAiSdkTranspilerRegistration };

package/esm/typings/src/_packages/core.index.d.ts

@@ -171,6 +171,7 @@ import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/registe
 import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
 import { MemoryStorage } from '../storage/memory/MemoryStorage';
 import { PrefixStorage } from '../storage/utils/PrefixStorage';
+import { $bookTranspilersRegister } from '../transpilers/_common/register/$bookTranspilersRegister';
 import { MODEL_VARIANTS } from '../types/ModelVariant';
 import { NonTaskSectionTypes } from '../types/SectionType';
 import { SectionTypes } from '../types/SectionType';
@@ -349,6 +350,7 @@ export { _WebsiteScraperMetadataRegistration };
 export { BlackholeStorage };
 export { MemoryStorage };
 export { PrefixStorage };
+export { $bookTranspilersRegister };
 export { MODEL_VARIANTS };
 export { NonTaskSectionTypes };
 export { SectionTypes };

package/esm/typings/src/_packages/types.index.d.ts

@@ -167,6 +167,9 @@ import type { PostprocessingFunction } from '../scripting/javascript/JavascriptE
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
 import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
+import type { BookTranspiler } from '../transpilers/_common/BookTranspiler';
+import type { BookTranspilerDefinition } from '../transpilers/_common/BookTranspilerDefinition';
+import type { BookTranspilerOptions } from '../transpilers/_common/BookTranspilerOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
@@ -501,6 +504,9 @@ export type { PostprocessingFunction };
 export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
 export type { IndexedDbStorageOptions };
+export type { BookTranspiler };
+export type { BookTranspilerDefinition };
+export type { BookTranspilerOptions };
 export type { IntermediateFilesStrategy };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };

package/esm/typings/src/_packages/wizard.index.d.ts

@@ -29,6 +29,8 @@ import { _PdfScraperRegistration } from '../scrapers/pdf/register-constructor';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperRegistration } from '../scrapers/website/register-constructor';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { _LangchainTranspilerRegistration } from '../transpilers/langchain/register';
+import { _OpenAiSdkTranspilerRegistration } from '../transpilers/openai/register';
 import { wizard } from '../wizard/wizard';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { _AnthropicClaudeMetadataRegistration };
@@ -61,4 +63,6 @@ export { _PdfScraperRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { _LangchainTranspilerRegistration };
+export { _OpenAiSdkTranspilerRegistration };
 export { wizard };

package/esm/typings/src/book-components/Chat/MockedChat/MockedChat.d.ts

@@ -42,6 +42,11 @@ export type MockedChatDelayConfig = {
      * If true, disables typing effect and shows full message at once (BLOCKY_FLOW)
      */
     blocky?: boolean;
+    /**
+     * This prop will allow to show N first messages immediately, while the rest will be typed out with delays
+     * @default 0
+     */
+    showIntermediateMessages?: number;
 };
 /**
  * Props for MockedChat component

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

@@ -0,0 +1,19 @@
+import type { BookTranspilerOptions } from './BookTranspilerOptions';
+/**
+ * Transpiler takes a book and transpiles it into another format.
+ */
+export type BookTranspiler = 
+/**
+ * Transpiles a book.
+ *
+ * @param book book to transpile
+ * @param options additional options for the transpiler
+ * @returns transpiled book
+ */
+(book: string, options: BookTranspilerOptions) => Promise<string>;
+/**
+ * TODO: [🧠] Should there be a BookTranspiler class or just a function?
+ *       Maybe a class with a constructor that takes ExecutionTools.
+ *       Then the instance would be a function.
+ *       @see LlmExecutionTools
+ */

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

@@ -0,0 +1,37 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_name, string_title } from '../../types/typeAliases';
+import type { Registered } from '../../utils/misc/$Register';
+import type { BookTranspiler } from './BookTranspiler';
+/**
+ * Definition of a book transpiler.
+ *
+ * @see https://github.com/webgptorg/promptbook/issues/249
+ */
+export type BookTranspilerDefinition = 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;
+    /**
+     * The factory function to create a transpiler instance.
+     * It can be async.
+     *
+     * @param tools the execution tools that can be used by the transpiler
+     * @returns the transpiler instance
+     */
+    readonly new: (tools: ExecutionTools) => BookTranspiler | Promise<BookTranspiler>;
+};
+/**
+ * TODO: [🧠] What other information should be in the public profile of the transpiler?
+ *      - input format, output format, version, description, icon, etc.
+ */

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

@@ -0,0 +1,19 @@
+/**
+ * Options for the BookTranspiler.
+ *
+ * @see https://github.com/webgptorg/promptbook/issues/249
+ */
+export type BookTranspilerOptions = {
+    /**
+     * 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 type { BookTranspilerDefinition } from '../BookTranspilerDefinition';
+/**
+ * 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<BookTranspilerDefinition>;
+/**
+ * TODO: [®] DRY Register logic
+ */

package/esm/typings/src/transpilers/langchain/LangchainTranspiler.d.ts

@@ -0,0 +1,7 @@
+import type { BookTranspilerDefinition } from '../_common/BookTranspilerDefinition';
+/**
+ * Transpiler to Python code using LangChain library.
+ *
+ * @private TODO: !!!! Which package should export this?
+ */
+export declare const LangchainTranspiler: BookTranspilerDefinition;

package/esm/typings/src/transpilers/langchain/register.d.ts

@@ -0,0 +1,15 @@
+import { Registration } from '../../_packages/types.index';
+/**
+ * Registration of LLM provider
+ *
+ * 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 _LangchainTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,13 @@
+import type { BookTranspilerDefinition } from '../_common/BookTranspilerDefinition';
+/**
+ * Transpiler to Javascript code using OpenAI SDK.
+ *
+ * @private TODO: !!!! Which package should export this?
+ */
+export declare const OpenAiSdkTranspiler: BookTranspilerDefinition;
+/**
+ * TODO: [🧠] What should be the scope of the transpiled code?
+ * - Just a single function?
+ * - A class?
+ * - A whole package?
+ */

package/esm/typings/src/transpilers/openai/register.d.ts

@@ -0,0 +1,15 @@
+import { Registration } from '../../_packages/types.index';
+/**
+ * Registration of LLM provider
+ *
+ * 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 _OpenAiSdkTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/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.103.0-22`).
+ * It follows semantic versioning (e.g., `0.103.0-24`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/vercel",
-    "version": "0.103.0-23",
+    "version": "0.103.0-25",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -94,7 +94,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-23"
+        "@promptbook/core": "0.103.0-25"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-23';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-25';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name