@promptbook/openai 0.92.0-8 → 0.92.0

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -1,26 +1,26 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Options for mapping available parameters to expected parameters in a pipeline task.
  */
 type MakeapAvailableToExpectedParametersOptions = {
     /**
-     * @@@
+     * The set of expected parameter names (keys) for the task, all values are null.
      */
     readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
     /**
-     * @@@
+     * The set of available parameters (name-value pairs) to map to the expected parameters.
      */
     readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
 };
 /**
- * Maps available parameters to expected parameters
+ * Maps available parameters to expected parameters for a pipeline task.
  *
  * The strategy is:
- * 1) @@@
- * 2) @@@
+ * 1) First, match parameters by name where both available and expected.
+ * 2) Then, if there are unmatched expected and available parameters, map them by order.
  *
- * @throws {PipelineExecutionError} @@@
+ * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
  * @private within the repository used in `createPipelineExecutor`
  */
 export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;

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

@@ -1,9 +1,9 @@
 /**
  * Removes quotes from a string
  *
- * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `removeQuotes` which removes only bounding quotes
  * - `unwrapResult` which removes whole introduce sentence
  *

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

@@ -1,10 +1,11 @@
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
- * @@@
+ * Creates a deep clone of a PipelineJson object, copying all properties explicitly.
  *
- * Note: It is usefull @@@
+ * Note: It is useful for ensuring that modifications to the returned pipeline do not affect the original.
  *
- * @param pipeline
+ * @param pipeline The pipeline to clone.
+ * @returns A new PipelineJson object with the same properties as the input.
  * @public exported from `@promptbook/utils`
  */
 export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;

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

@@ -1,7 +1,11 @@
 import type { WritableDeep } from 'type-fest';
 /**
- * @@@
+ * Creates a deep clone of the given object
  *
+ * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
+ *
+ * @param objectValue The object to clone.
+ * @returns A deep, writable clone of the input object.
  * @public exported from `@promptbook/utils`
  */
 export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;

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

@@ -1,7 +1,7 @@
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
- * Note: This is usefull for post-processing of the result of the chat LLM model
+ * 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`

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

@@ -1,7 +1,7 @@
 /**
  * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
  *
- * Note: This is usefull for post-processing of the result of the completion LLM model
+ * 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`

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

@@ -20,9 +20,9 @@ type UnwrapResultOptions = {
 /**
  * Removes quotes and optional introduce text from a string
  *
- * Tip: This is very usefull for post-processing of the result of the LLM model
+ * 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 simmilar functions:
+ * Note: There are two similar functions:
  * - `removeQuotes` which removes only bounding quotes
  * - `unwrapResult` which removes whole introduce sentence
  *

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

@@ -1,10 +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 @@@
- * @returns @@@
+ * @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/parameterName/validateParameterName.d.ts

@@ -1,10 +1,11 @@
 import type { string_parameter_name } from '../../../types/typeAliases';
 /**
- * Function `validateParameterName` will @@@
+ * 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 @@@
- * @returns @@@
- * @throws {ParseError} @@@
+ * @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/semanticVersion/isValidPromptbookVersion.d.ts

@@ -6,7 +6,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  *
  * @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 simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  *

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

@@ -3,7 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid semantic version
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  *

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

@@ -2,7 +2,7 @@ import type { string_hostname } from '../../../types/typeAliases';
 /**
  * Checks if an URL is reserved for private networks or localhost.
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isUrlOnPrivateNetwork` which tests full URL
  * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
  *

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

@@ -2,7 +2,7 @@ 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 simmilar functions:
+ * Note: There are two similar functions:
  * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
  * - `isHostnameOnPrivateNetwork` which tests just hostname
  *

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

@@ -3,7 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid pipeline URL URL.
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
  *

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

@@ -4,7 +4,7 @@ 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 simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  *

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

@@ -14,7 +14,8 @@ 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.92.0-35`).
  *
  * @generated
  */

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

@@ -24,7 +24,7 @@ declare class Wizzard {
      * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
      * 3) As a string
      *
-     * Note: This works simmilar to the `ptbk run` command
+     * Note: This works similar to the `ptbk run` command
      */
     execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.92.0-8",
+    "version": "0.92.0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,13 +47,26 @@
         "node": ">=16.0.0",
         "npm": ">=8.0.0"
     },
+    "cspell": {
+        "version": "0.2",
+        "language": "en",
+        "ignorePaths": [
+            "node_modules",
+            ".next",
+            "coverage",
+            "dist",
+            ".git"
+        ],
+        "words": []
+    },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-8"
+        "@promptbook/core": "0.92.0"
     },
     "dependencies": {
+        "bottleneck": "^2.19.5",
         "colors": "1.4.0",
         "crypto": "1.0.1",
         "openai": "4.63.0",