@promptbook/openai 0.103.0-41 → 0.103.0-43

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

@@ -1,6 +1,5 @@
 import type { Request, Response } from 'express';
 import type { Promisable } from 'type-fest';
-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';
@@ -27,24 +26,6 @@ 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/storage/env-storage/$EnvStorage.d.ts

@@ -1,5 +1,5 @@
+import type { $side_effect } from '../../utils/organization/$side_effect';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
-import { $side_effect } from '../../utils/organization/$side_effect';
 /**
  * Stores data in .env variables
  *

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

@@ -1,5 +1,9 @@
 import { Promisable } from 'type-fest';
-import { BookTranspilerOptions, ExecutionTools, Registered, string_book, string_name, string_script, string_title } from '../../_packages/types.index';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_name, string_script, string_title } from '../../types/typeAliases';
+import type { Registered } from '../../utils/misc/$Register';
+import type { BookTranspilerOptions } from './BookTranspilerOptions';
 /**
  * Transpiler takes a book and transpiles it into another format (e.g., Langchain).
  */

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

@@ -1,4 +1,4 @@
-import { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 /**
  * Options for the BookTranspiler.
  */

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

@@ -1,5 +1,5 @@
 import { $Register } from '../../../utils/misc/$Register';
-import { BookTranspiler } from '../BookTranspiler';
+import type { BookTranspiler } from '../BookTranspiler';
 /**
  * Register for book transpilers.
  *

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

@@ -1,4 +1,7 @@
-import { BookTranspilerOptions, ExecutionTools, string_book, string_markdown } from '../../_packages/types.index';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_markdown } from '../../types/typeAliases';
+import type { BookTranspilerOptions } from '../_common/BookTranspilerOptions';
 /**
  * Converts a book into a 1:1 formatted markdown
  *

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

@@ -1,4 +1,4 @@
-import { Registration } from '../../_packages/types.index';
+import type { Registration } from '../../utils/misc/$Register';
 /**
  * Registration of transpiler
  *

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

@@ -1,4 +1,7 @@
-import { BookTranspilerOptions, ExecutionTools, string_book, string_script } from '../../_packages/types.index';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { ExecutionTools } from '../../execution/ExecutionTools';
+import type { string_script } from '../../types/typeAliases';
+import type { BookTranspilerOptions } from '../_common/BookTranspilerOptions';
 /**
  * Transpiler to Javascript code using OpenAI SDK.
  *

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

@@ -1,4 +1,4 @@
-import { Registration } from '../../_packages/types.index';
+import type { Registration } from '../../utils/misc/$Register';
 /**
  * Registration of transpiler
  *

package/esm/typings/src/utils/color/operators/darken.d.ts

@@ -1,4 +1,4 @@
-import { number_percent } from '../../../types/typeAliases';
+import type { number_percent } from '../../../types/typeAliases';
 import type { ColorTransformer } from './ColorTransformer';
 /**
  * Makes color transformer which darker the given color

package/esm/typings/src/utils/color/operators/grayscale.d.ts

@@ -1,4 +1,4 @@
-import { number_percent } from '../../../types/typeAliases';
+import type { number_percent } from '../../../types/typeAliases';
 import type { ColorTransformer } from './ColorTransformer';
 /**
  * Makes color transformer which returns a grayscale version of the color

package/esm/typings/src/utils/color/operators/lighten.d.ts

@@ -1,5 +1,5 @@
+import type { number_percent } from '../../../types/typeAliases';
 import type { ColorTransformer } from './ColorTransformer';
-import { number_percent } from '../../../types/typeAliases';
 /**
  * Makes color transformer which lighten the given color
  *

package/esm/typings/src/utils/color/operators/mixWithColor.d.ts

@@ -1,6 +1,6 @@
+import type { number_percent } from '../../../types/typeAliases';
 import { Color } from '../Color';
 import type { ColorTransformer } from './ColorTransformer';
-import { number_percent } from '../../../types/typeAliases';
 /**
  * Makes color transformer which returns a mix of two colors based on a ratio
  *

package/esm/typings/src/utils/color/operators/saturate.d.ts

@@ -1,4 +1,4 @@
-import { number_percent } from '../../../types/typeAliases';
+import type { number_percent } from '../../../types/typeAliases';
 import type { ColorTransformer } from './ColorTransformer';
 /**
  * Makes color transformer which saturate the given color

package/esm/typings/src/utils/environment/$detectRuntimeEnvironment.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns information about the current runtime environment
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environments
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $detectRuntimeEnvironment(): {
+    isRunningInBrowser: any;
+    isRunningInJest: any;
+    isRunningInNode: any;
+    isRunningInWebWorker: any;
+};
+/**
+ * TODO: [🎺] Also detect and report node version here
+ */

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

@@ -1,4 +1,4 @@
-import { $side_effect } from '../organization/$side_effect';
+import type { $side_effect } from '../organization/$side_effect';
 import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * Run one command in a shell

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

@@ -1,4 +1,4 @@
-import { $side_effect } from '../organization/$side_effect';
+import type { $side_effect } from '../organization/$side_effect';
 /**
  * Run multiple commands in a shell in sequence
  *

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

@@ -1,5 +1,5 @@
-import { string_book } from '../../_packages/types.index';
-import { $side_effect } from '../organization/$side_effect';
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { $side_effect } from '../organization/$side_effect';
 /**
  * Download a Book in a browser
  *

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

@@ -1,5 +1,5 @@
-import { string_url } from '../../types/typeAliases';
-import { $side_effect } from '../organization/$side_effect';
+import type { string_url } from '../../types/typeAliases';
+import type { $side_effect } from '../organization/$side_effect';
 /**
  * Download a File in a browser
  *

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

@@ -1,5 +1,5 @@
 import { IDestroyable, Registration } from 'destroyable';
-import { string_mime_type, string_url } from '../../types/typeAliases';
+import type { string_mime_type, string_url } from '../../types/typeAliases';
 /**
  * Converts Blob, File or MediaSource to url using URL.createObjectURL
  *

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

@@ -6,6 +6,12 @@ export type AboutPromptbookInformationOptions = {
      * @default true
      */
     isServersInfoIncluded?: boolean;
+    /**
+     * Include information about runtime environment
+     *
+     * @default true
+     */
+    isRuntimeEnvironmentInfoIncluded?: boolean;
 };
 /**
  * Provide information about Promptbook, engine version, book language version, servers, ...

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

@@ -1,4 +1,4 @@
-import { really_any } from './really_any';
+import type { really_any } from './really_any';
 /**
  * Organizational helper to mark a function that produces side effects
  *

package/esm/typings/src/utils/random/$generateBookBoilerplate.d.ts

@@ -0,0 +1,22 @@
+import type { PartialDeep } from 'type-fest';
+import type { AgentBasicInformation } from '../../book-2.0/agent-source/AgentBasicInformation';
+import { string_book } from '../../book-2.0/agent-source/string_book';
+import { string_agent_name } from '../../types/typeAliases';
+type GenerateBookBoilerplateOptions = PartialDeep<Omit<AgentBasicInformation, 'parameters'>> & {
+    /**
+     * Name of the parent agent to inherit from
+     *
+     * @default 'Adam'
+     */
+    parentAgentName?: string_agent_name;
+};
+/**
+ * Generates boilerplate for a new agent book
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Note: This function is using cryptographically secure components internally
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function $generateBookBoilerplate(options?: GenerateBookBoilerplateOptions): string_book;
+export {};

package/esm/typings/src/utils/random/$randomToken.d.ts

@@ -2,6 +2,7 @@ import type { string_token } from '../../types/typeAliases';
 /**
  * Generates random token
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
  *
  * @private internal helper function

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

@@ -1,5 +1,5 @@
 import type { ReadonlyDeep } from 'type-fest';
-import { $side_effect } from '../organization/$side_effect';
+import type { $side_effect } from '../organization/$side_effect';
 /**
  * Freezes the given object and all its nested objects recursively
  *

package/esm/typings/src/utils/serialization/serializeToPromptbookJavascript.d.ts

@@ -1,5 +1,5 @@
-import { string_javascript } from '../../types/typeAliases';
-import { TODO_any } from '../organization/TODO_any';
+import type { string_javascript } from '../../types/typeAliases';
+import type { TODO_any } from '../organization/TODO_any';
 type SerializeToPromptbookJavascriptReturn = {
     /**
      * Array of import statements required for the `value` to work

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.103.0-41",
+    "version": "0.103.0-43",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -102,7 +102,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-41"
+        "@promptbook/core": "0.103.0-43"
     },
     "dependencies": {
         "bottleneck": "2.19.5",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-41';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-43';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -110,6 +110,7 @@
     /**
      * Generates random token
      *
+     * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
      * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
      *
      * @private internal helper function
@@ -906,6 +907,23 @@
      * TODO: Maybe connect with textures
      */
 
+    /**
+     * Makes color transformer which returns a grayscale version of the color
+     *
+     * @param amount from 0 to 1
+     *
+     * @public exported from `@promptbook/color`
+     */
+    function grayscale(amount) {
+        return ({ red, green, blue, alpha }) => {
+            const average = (red + green + blue) / 3;
+            red = Math.round(average * amount + red * (1 - amount));
+            green = Math.round(average * amount + green * (1 - amount));
+            blue = Math.round(average * amount + blue * (1 - amount));
+            return Color.fromValues(red, green, blue, alpha);
+        };
+    }
+
     /**
      * Converts HSL values to RGB values
      *
@@ -1021,102 +1039,6 @@
      * TODO: Maybe implement by mix+hsl
      */
 
-    /**
-     * Calculates distance between two colors
-     *
-     * @param color1 first color
-     * @param color2 second color
-     *
-     * Note: This function is inefficient. Use colorDistanceSquared instead if possible.
-     *
-     * @public exported from `@promptbook/color`
-     */
-    /**
-     * Calculates distance between two colors without square root
-     *
-     * @param color1 first color
-     * @param color2 second color
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function colorDistanceSquared(color1, color2) {
-        const rmean = (color1.red + color2.red) / 2;
-        const r = color1.red - color2.red;
-        const g = color1.green - color2.green;
-        const b = color1.blue - color2.blue;
-        const weightR = 2 + rmean / 256;
-        const weightG = 4.0;
-        const weightB = 2 + (255 - rmean) / 256;
-        const distance = weightR * r * r + weightG * g * g + weightB * b * b;
-        return distance;
-    }
-
-    /**
-     * Makes color transformer which finds the nearest color from the given list
-     *
-     * @param colors array of colors to choose from
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function nearest(...colors) {
-        return (color) => {
-            const distances = colors.map((c) => colorDistanceSquared(c, color));
-            const minDistance = Math.min(...distances);
-            const minIndex = distances.indexOf(minDistance);
-            const nearestColor = colors[minIndex];
-            return nearestColor;
-        };
-    }
-
-    /**
-     * Color transformer which returns the negative color
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function negative(color) {
-        const r = 255 - color.red;
-        const g = 255 - color.green;
-        const b = 255 - color.blue;
-        return Color.fromValues(r, g, b, color.alpha);
-    }
-
-    /**
-     * Makes color transformer which finds the furthest color from the given list
-     *
-     * @param colors array of colors to choose from
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function furthest(...colors) {
-        return (color) => {
-            const furthestColor = negative(nearest(...colors.map(negative))(color));
-            return furthestColor;
-        };
-    }
-    /**
-     * Makes color transformer which finds the best text color (black or white) for the given background color
-     *
-     * @public exported from `@promptbook/color`
-     */
-    furthest(Color.get('white'), Color.from('black'));
-
-    /**
-     * Makes color transformer which returns a grayscale version of the color
-     *
-     * @param amount from 0 to 1
-     *
-     * @public exported from `@promptbook/color`
-     */
-    function grayscale(amount) {
-        return ({ red, green, blue, alpha }) => {
-            const average = (red + green + blue) / 3;
-            red = Math.round(average * amount + red * (1 - amount));
-            green = Math.round(average * amount + green * (1 - amount));
-            blue = Math.round(average * amount + blue * (1 - amount));
-            return Color.fromValues(red, green, blue, alpha);
-        };
-    }
-
     /**
      * Makes color transformer which saturate the given color
      *
@@ -4000,6 +3922,19 @@
         }
     }
 
+    /**
+     * This error indicates error from the database
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class DatabaseError extends Error {
+        constructor(message) {
+            super(message);
+            this.name = 'DatabaseError';
+            Object.setPrototypeOf(this, DatabaseError.prototype);
+        }
+    }
+
     /**
      * This error type indicates that you try to use a feature that is not available in the current environment
      *
@@ -4153,6 +4088,7 @@
         UnexpectedError,
         WrappedError,
         NotAllowed,
+        DatabaseError,
         // TODO: [🪑]> VersionMismatchError,
     };
     /**