@promptbook/wizard 0.95.0

package/esm/typings/src/utils/sets/union.test.d.ts

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

package/esm/typings/src/utils/trimCodeBlock.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
+ *
+ * Note: This is useful for post-processing of the result of the chat LLM model
+ *       when the model wraps the result in the (markdown) code block.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function trimCodeBlock(value: string): string;

package/esm/typings/src/utils/trimCodeBlock.test.d.ts

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

package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
+ *
+ * Note: This is useful for post-processing of the result of the completion LLM model
+ *       if you want to start code block in the prompt but you don't want to end it in the result.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function trimEndOfCodeBlock(value: string): string;

package/esm/typings/src/utils/trimEndOfCodeBlock.test.d.ts

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

package/esm/typings/src/utils/unwrapResult.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Additional options for `unwrapResult`
+ */
+type UnwrapResultOptions = {
+    /**
+     * If true, the text is trimmed before processing
+     */
+    readonly isTrimmed?: boolean;
+    /**
+     * If true, the introduce sentence is removed
+     *
+     * For example:
+     * - If `true`>  'Hello, "world"' -> 'world'
+     * - If `false`> 'Hello, "world"' -> 'Hello, "world"'
+     *
+     * @default true
+     */
+    readonly isIntroduceSentenceRemoved?: boolean;
+};
+/**
+ * Removes quotes and optional introduce text from a string
+ *
+ * Tip: This is very useful for post-processing of the result of the LLM model
+ * Note: This function trims the text and removes whole introduce sentence if it is present
+ * Note: There are two similar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ * @public exported from `@promptbook/utils`
+ */
+export declare function unwrapResult(text: string, options?: UnwrapResultOptions): string;
+export {};
+/**
+ * TODO: [🧠] Should this also unwrap the (parenthesis)
+ */

package/esm/typings/src/utils/unwrapResult.test.d.ts

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

package/esm/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -0,0 +1,8 @@
+import type { string_email } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Checks if value is valid email
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidEmail(email: really_unknown): email is string_email;

package/esm/typings/src/utils/validators/email/isValidEmail.test.d.ts

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

package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts

@@ -0,0 +1,12 @@
+import type { string_dirname } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
+/**
+ * Determines if the given path is a root path.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isRootPath(value: string_dirname | string_filename): boolean;
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -0,0 +1,12 @@
+import type { string_filename } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidFilePath(filename: really_unknown): filename is string_filename;
+/**
+ * TODO: [🍏] Implement for MacOs
+ */

package/esm/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts

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

package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -0,0 +1,10 @@
+import type { string_javascript_name } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Checks if the given value is a valid JavaScript identifier name.
+ *
+ * @param javascriptName The value to check for JavaScript identifier validity.
+ * @returns `true` if the value is a valid JavaScript name, false otherwise.
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts

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

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -0,0 +1,11 @@
+import type { string_parameter_name } from '../../../types/typeAliases';
+/**
+ * Function `validateParameterName` will normalize and validate a parameter name for use in pipelines.
+ * It removes diacritics, emojis, and quotes, normalizes to camelCase, and checks for reserved names and invalid characters.
+ *
+ * @param parameterName The parameter name to validate and normalize.
+ * @returns The validated and normalized parameter name.
+ * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.
+ * @private within the repository
+ */
+export declare function validateParameterName(parameterName: string): string_parameter_name;

package/esm/typings/src/utils/validators/parameterName/validateParameterName.test.d.ts

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

package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -0,0 +1,15 @@
+import type { string_promptbook_version } from '../../../version';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Tests if given string is valid promptbook version
+ * It looks into list of known promptbook versions.
+ *
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
+ * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
+ * Note: There are two similar functions:
+ * - `isValidSemanticVersion` which tests any semantic version
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts

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

package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -0,0 +1,12 @@
+import type { string_semantic_version } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Tests if given string is valid semantic version
+ *
+ * Note: There are two similar functions:
+ * - `isValidSemanticVersion` which tests any semantic version
+ * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidSemanticVersion(version: really_unknown): version is string_semantic_version;

package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts

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

package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts

@@ -0,0 +1,11 @@
+import type { string_hostname } from '../../../types/typeAliases';
+/**
+ * Checks if an URL is reserved for private networks or localhost.
+ *
+ * Note: There are two similar functions:
+ * - `isUrlOnPrivateNetwork` which tests full URL
+ * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isHostnameOnPrivateNetwork(hostname: string_hostname): boolean;

package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts

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

package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts

@@ -0,0 +1,13 @@
+import type { string_url } from '../../../types/typeAliases';
+/**
+ * Checks if an IP address or hostname is reserved for private networks or localhost.
+ *
+ * Note: There are two similar functions:
+ * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
+ * - `isHostnameOnPrivateNetwork` which tests just hostname
+ *
+ * @param {string} ipAddress - The IP address to check.
+ * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isUrlOnPrivateNetwork(url: URL | string_url): boolean;

package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts

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

package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -0,0 +1,15 @@
+import type { string_pipeline_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Tests if given string is valid pipeline URL URL.
+ *
+ * Note: There are two similar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidPipelineUrl(url: really_unknown): url is string_pipeline_url;
+/**
+ * TODO: [🐠] Maybe more info why the URL is invalid
+ */

package/esm/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts

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

package/esm/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -0,0 +1,13 @@
+import type { string_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: Dataurl are considered perfectly valid.
+ * Note: There are two similar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidUrl(url: really_unknown): url is string_url;

package/esm/typings/src/utils/validators/url/isValidUrl.test.d.ts

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

package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -0,0 +1,8 @@
+import type { string_uuid } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
+/**
+ * Checks if value is valid uuid
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidUuid(value: really_unknown): value is string_uuid;

package/esm/typings/src/utils/validators/uuid/isValidUuid.test.d.ts

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

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

@@ -0,0 +1,26 @@
+import type { string_semantic_version } from './types/typeAliases';
+/**
+ * The version of the Book language
+ *
+ * @generated
+ * @see https://github.com/webgptorg/book
+ */
+export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
+/**
+ * The version of the Promptbook engine
+ *
+ * @generated
+ * @see https://github.com/webgptorg/promptbook
+ */
+export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
+/**
+ * Represents the version string of the Promptbook engine.
+ * It follows semantic versioning (e.g., `0.94.0`).
+ *
+ * @generated
+ */
+export type string_promptbook_version = string_semantic_version;
+/**
+ * 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/wizard/$getCompiledBook.d.ts

@@ -0,0 +1,16 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_filename } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * @see ./wizard.ts `getPipeline` method
+ *
+ * @private usable through `ptbk run` and `@promptbook/wizard`
+ */
+export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write unit test
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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

@@ -0,0 +1,68 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { InputParameters } from '../types/typeAliases';
+import type { string_filename } from '../types/typeAliases';
+import type { string_parameter_value } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * Wizard for simple usage of the Promptbook
+ * Look at `wizard` for more details
+ *
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
+ * @private just for single instance
+ */
+declare class Wizard {
+    /**
+     * Run the book
+     *
+     * It can be loaded from:
+     * 1) As a file ./books/write-cv.book
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
+     * 3) As a string
+     *
+     * Note: This works similar to the `ptbk run` command
+     */
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
+        /**
+         * Simple result of the execution
+         */
+        result: string_parameter_value;
+    } & PipelineExecutorResult>;
+    private executionTools;
+    /**
+     * Provides the tools automatically for the Node.js environment
+     *
+     * @param pipelineSource
+     */
+    getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
+    /**
+     * Load book from the source
+     *
+     * Pipelines can be loaded from:
+     * 1) As a file ./books/write-cv.book
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
+     * 3) As a string
+     *
+     * @param pipelineSource
+     */
+    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
+}
+/**
+ * Wizard for simple usage of the Promptbook
+ *
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
+ * @singleton
+ * @public exported from `@promptbook/wizard`
+ */
+export declare const wizard: Wizard;
+export {};
+/**
+ * TODO: [🧠] Maybe some way how to handle the progress and streaming?
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/package.json

@@ -0,0 +1,104 @@
+{
+    "name": "@promptbook/wizard",
+    "version": "0.95.0",
+    "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
+    "private": false,
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/webgptorg/promptbook"
+    },
+    "author": "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)",
+    "contributors": [
+        "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)",
+        "Jiří Jahn <jiri@ptbk.io> (https://www.ptbk.io/)"
+    ],
+    "keywords": [
+        "ai",
+        "llm",
+        "prompt",
+        "template",
+        "language-model",
+        "chatgpt",
+        "autogpt",
+        "machine-learning",
+        "natural-language-processing",
+        "nlp",
+        "openai",
+        "o3",
+        "o3-mini",
+        "deepseek",
+        "gpt-3",
+        "gpt-4",
+        "gpt-4o",
+        "gpt-4o-mini",
+        "o1",
+        "o1-mini",
+        "o1-preview",
+        "anthropic",
+        "claude",
+        "claude-3",
+        "claude-3-opus",
+        "claude-3-sonnet",
+        "claude-3-haiku",
+        "gemini",
+        "gemini-pro",
+        "gemini-flash",
+        "mixtral",
+        "mistral",
+        "ollama",
+        "ai-orchestration",
+        "prompt-engineering",
+        "llmops",
+        "multimodal",
+        "reasoning",
+        "rag",
+        "embeddings",
+        "function-calling",
+        "large-language-models",
+        "ai-application-framework",
+        "text-generation",
+        "ai-agents",
+        "LLMOps"
+    ],
+    "license": "BUSL-1.1",
+    "bugs": {
+        "url": "https://github.com/webgptorg/promptbook/issues"
+    },
+    "homepage": "https://ptbk.io/",
+    "engines": {
+        "node": ">=16.0.0",
+        "npm": ">=8.0.0"
+    },
+    "main": "./umd/index.umd.js",
+    "module": "./esm/index.es.js",
+    "typings": "./esm/typings/src/_packages/wizard.index.d.ts",
+    "peerDependencies": {
+        "@promptbook/core": "0.95.0"
+    },
+    "dependencies": {
+        "@ai-sdk/deepseek": "0.1.6",
+        "@ai-sdk/google": "1.0.5",
+        "@anthropic-ai/sdk": "0.26.1",
+        "@azure/openai": "1.0.0-beta.12",
+        "@mozilla/readability": "0.6.0",
+        "bottleneck": "^2.19.5",
+        "colors": "1.4.0",
+        "crypto": "1.0.1",
+        "crypto-js": "4.2.0",
+        "dotenv": "16.3.1",
+        "jsdom": "25.0.1",
+        "jszip": "3.10.1",
+        "markitdown-ts": "0.0.4",
+        "openai": "4.63.0",
+        "papaparse": "5.4.1",
+        "prettier": "2.8.1",
+        "rxjs": "7.8.1",
+        "showdown": "2.1.0",
+        "socket.io-client": "4.7.2",
+        "spacetrim": "0.11.59",
+        "type-fest": "4.5.0",
+        "userhome": "1.0.1",
+        "waitasecond": "1.11.83"
+    }
+}