@promptbook/azure-openai 0.103.0-4 → 0.103.0-41

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
+ */

package/esm/typings/src/transpilers/openai-sdk/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 _OpenAiSdkTranspilerRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/types/LlmCall.d.ts

@@ -0,0 +1,20 @@
+import type { ExecutionPromptReportJson } from '../execution/execution-report/ExecutionPromptReportJson';
+import type { string_model_name } from './typeAliases';
+/**
+ * Represents a single LLM call with its report.
+ *
+ * @see https://github.com/webgptorg/promptbook/issues/24
+ */
+export type LlmCall = {
+    /**
+     * The name of the model used for the call.
+     */
+    readonly modelName: string_model_name;
+    /**
+     * The report of the LLM execution.
+     */
+    readonly report: ExecutionPromptReportJson;
+};
+/**
+ * TODO: !!! Maybe different shape of LlmCall
+ */

package/esm/typings/src/types/Updatable.d.ts

@@ -0,0 +1,19 @@
+import { BehaviorSubject } from 'rxjs';
+/**
+ * A type that represents a value that can be updated over time:
+ *
+ * 1) It can be a static value of type `TValue`
+ * 2) Or a `BehaviorSubject` that emits values of type `TValue`
+ * 3) Or pair of `[getValue, setValue]` functions for getting and setting the value
+ */
+export type Updatable<TValue> = TValue | BehaviorSubject<TValue> | [TValue, (value: TValue) => void];
+/**
+ * Restricts an Updatable to a (2) BehaviorSubject variant
+ *
+ * @see Updatable
+ * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
+ */
+export declare function asUpdatableSubject<TValue>(value: Updatable<TValue>): BehaviorSubject<TValue>;
+/**
+ * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
+ */

package/esm/typings/src/types/typeAliases.d.ts

@@ -323,7 +323,7 @@ export type string_css_property = string;
  *
  * For example `13px`
  */
-export type string_css_value = string;
+export type string_css_value = string | number;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -1,3 +1,4 @@
+import { $side_effect } from '../organization/$side_effect';
 import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell
@@ -10,7 +11,7 @@ import type { ExecCommandOptions } from './ExecCommandOptions';
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
+export declare function $execCommand(options: ExecCommandOptions): Promise<$side_effect & string>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -1,3 +1,4 @@
+import { $side_effect } from '../organization/$side_effect';
 /**
  * Run multiple commands in a shell in sequence
  *
@@ -8,7 +9,7 @@
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommands({ commands, cwd, crashOnError, }: {
+export declare function $execCommands({ commands, cwd, crashOnError, }: $side_effect & {
     readonly commands: string[];
     readonly cwd: string;
     readonly crashOnError?: boolean;

package/esm/typings/src/utils/files/$induceBookDownload.d.ts

@@ -0,0 +1,13 @@
+import { string_book } from '../../_packages/types.index';
+import { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a Book in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/utils/files/$induceFileDownload.d.ts

@@ -0,0 +1,13 @@
+import { string_url } from '../../types/typeAliases';
+import { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a File in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/utils/files/ObjectUrl.d.ts

@@ -0,0 +1,46 @@
+import { IDestroyable, Registration } from 'destroyable';
+import { string_mime_type, string_url } from '../../types/typeAliases';
+/**
+ * Converts Blob, File or MediaSource to url using URL.createObjectURL
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class ObjectUrl extends Registration implements IDestroyable {
+    readonly src: string_url;
+    private constructor();
+    /**
+     * Creates ObjectUrl from multiple input types
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static from(source: Blob | File | MediaSource | string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl from string
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static fromString(source: string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlob(source: Blob | File | MediaSource): ObjectUrl;
+    /**
+     * Creates ObjectUrl:
+     * 1) With functionality for Blobs, Files or MediaSources
+     * 2) Just a wrapper for string urls
+     *
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlobOrUrl(source: Blob | File | MediaSource | URL | string_url): ObjectUrl;
+    /**
+     * Gets object url as string
+     * @alias src
+     */
+    get href(): string_url;
+    /**
+     * Gets object url as URL object
+     */
+    get url(): URL;
+}
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/utils/files/listAllFiles.d.ts

@@ -1,13 +1,12 @@
 import type { FilesystemTools } from '../../execution/FilesystemTools';
-import type { string_dirname } from '../../types/typeAliases';
-import type { string_filename } from '../../types/typeAliases';
+import type { string_dirname, string_filename } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
- * @private internal function of `createCollectionFromDirectory`
+ * @private internal function of `AgentCollectionInDirectory` and `createPipelineCollectionFromDirectory`
  */
 export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
 /**

package/esm/typings/src/utils/misc/aboutPromptbookInformation.d.ts

@@ -0,0 +1,21 @@
+import type { string_markdown } from '../../types/typeAliases';
+export type AboutPromptbookInformationOptions = {
+    /**
+     * Include information about available servers
+     *
+     * @default true
+     */
+    isServersInfoIncluded?: boolean;
+};
+/**
+ * Provide information about Promptbook, engine version, book language version, servers, ...
+ *
+ * @param options Which information to include
+ * @returns  Information about Promptbook in markdown format
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function aboutPromptbookInformation(options?: AboutPromptbookInformationOptions): string_markdown;
+/**
+ * TODO: [🗽] Unite branding and make single place for it
+ */

package/esm/typings/src/utils/misc/injectCssModuleIntoShadowRoot.d.ts

@@ -16,5 +16,6 @@ export type InjectCssModuleIntoShadowRootOptions = {
  *
  * @public exported from `@promptbook/components`
  *         <- TODO: [🧠] Make `@promptbook/components-utils`
+ * @deprecated This was used for BookEditor shadow DOM support, which is no longer needed
  */
 export declare function injectCssModuleIntoShadowRoot(options: InjectCssModuleIntoShadowRootOptions): void;

package/esm/typings/src/utils/misc/xAboutPromptbookInformation.d.ts

@@ -0,0 +1,13 @@
+import type { AboutPromptbookInformationOptions } from './aboutPromptbookInformation';
+type AboutPromptbookInformationProps = AboutPromptbookInformationOptions;
+/**
+ * Provide information about Promptbook, engine version, book language version, servers, ...
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AboutPromptbookInformation(props: AboutPromptbookInformationProps): import("react/jsx-runtime").JSX.Element;
+export {};
+/**
+ * TODO: !!! Remove "x" from filename
+ * TODO: [🗽] Unite branding and make single place for it
+ */

package/esm/typings/src/utils/organization/$side_effect.d.ts

@@ -0,0 +1,7 @@
+import { really_any } from './really_any';
+/**
+ * Organizational helper to mark a function that produces side effects
+ *
+ * @private within the repository
+ */
+export type $side_effect = void | really_any;

package/esm/typings/src/utils/serialization/$deepFreeze.d.ts

@@ -1,4 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
+import { $side_effect } from '../organization/$side_effect';
 /**
  * Freezes the given object and all its nested objects recursively
  *
@@ -8,7 +9,7 @@ import type { ReadonlyDeep } from 'type-fest';
  * @returns The same object as the input, but deeply frozen
  * @public exported from `@promptbook/utils`
  */
-export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<$side_effect & TObject>;
 /**
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */

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-3`).
+ * It follows semantic versioning (e.g., `0.103.0-40`).
  *
  * @generated
  */

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

@@ -2,8 +2,7 @@ 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';
+import type { string_filename, string_pipeline_url } from '../types/typeAliases';
 /**
  * @see ./wizard.ts `getPipeline` method
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/azure-openai",
-    "version": "0.103.0-4",
+    "version": "0.103.0-41",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -105,13 +105,13 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/azure-openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-4"
+        "@promptbook/core": "0.103.0-41"
     },
     "dependencies": {
-        "@azure/openai": "1.0.0-beta.12",
-        "bottleneck": "^2.19.5",
-        "colors": "1.4.0",
+        "@azure/openai": "1.0.0-beta.13",
+        "bottleneck": "2.19.5",
+        "colors": "^1.4.0",
         "crypto": "1.0.1",
-        "spacetrim": "0.11.59"
+        "spacetrim": "0.11.60"
     }
 }

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-4';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-41';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -948,15 +948,30 @@
      * @public exported from `@promptbook/core`
      */
     const PROMPTBOOK_COLOR = Color.fromHex('#79EAFD');
-    // <- TODO: [🧠] Using `Color` here increases the package size approx 3kb, maybe remove it
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
     /**
-     * Dark color of the Promptbook
+     * Colors for syntax highlighting in the `<BookEditor/>`
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    ({
+        TITLE: Color.fromHex('#244EA8'),
+        LINE: Color.fromHex('#eeeeee'),
+        COMMITMENT: Color.fromHex('#DA0F78'),
+        PARAMETER: Color.fromHex('#8e44ad'),
+    });
+    // <- TODO: [🧠][🈵] Using `Color` here increases the package size approx 3kb, maybe remove it
+    /**
+     * Chat color of the Promptbook (in chat)
      *
      * TODO: [🗽] Unite branding and make single place for it
      *
      * @public exported from `@promptbook/core`
      */
     PROMPTBOOK_COLOR.then(lighten(0.1)).then(saturate(0.9)).then(grayscale(0.9));
+    // <- TODO: [🧠][🈵] Using `Color` and `lighten`, `saturate`,... here increases the package size approx 3kb, maybe remove it
     /**
      * Color of the user (in chat)
      *
@@ -1177,10 +1192,13 @@
      * @public exported from `@promptbook/utils`
      */
     function countLines(text) {
+        if (text === '') {
+            return 0;
+        }
         text = text.replace('\r\n', '\n');
         text = text.replace('\r', '\n');
         const lines = text.split('\n');
-        return lines.reduce((count, line) => count + Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 0);
+        return lines.reduce((count, line) => count + Math.max(Math.ceil(line.length / CHARACTERS_PER_STANDARD_LINE), 1), 0);
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...