@promptbook/vercel 0.76.0

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

@@ -0,0 +1,16 @@
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ *
+ * @returns parsed number
+ * @throws {ParseError} if the value is not a number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ * TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
+ */

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

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

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

@@ -0,0 +1,9 @@
+import type { number_seed } from '../../types/typeAliases';
+/**
+ * Generates random seed
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $randomSeed(): number_seed;

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

@@ -0,0 +1,8 @@
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeEmojis(text: string): string;

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

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

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

@@ -0,0 +1,14 @@
+/**
+ * Removes quotes from a string
+ *
+ * Tip: This is very usefull 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:
+ * - `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 removeQuotes(text: string): string;

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

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

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

@@ -0,0 +1,17 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * @@@
+ * @@@
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @param name - Name of the object for debugging purposes
+ * @param objectValue - Object to be deeply frozen
+ * @returns The same object as the input, but deeply frozen
+ * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
+ */
+export declare function $asDeeplyFrozenSerializableJson<TObject>(name: string_name, objectValue: TObject): TObject;
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

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

@@ -0,0 +1,14 @@
+import type { ReadonlyDeep } from 'type-fest';
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+/**
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

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

@@ -0,0 +1,27 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Checks if the value is [🚉] serializable as JSON
+ * If not, throws an UnexpectedError with a rich error message and tracking
+ *
+ * - Almost all primitives are serializable BUT:
+ * - `undefined` is not serializable
+ * - `NaN` is not serializable
+ * - Objects and arrays are serializable if all their properties are serializable
+ * - Functions are not serializable
+ * - Circular references are not serializable
+ * - `Date` objects are not serializable
+ * - `Map` and `Set` objects are not serializable
+ * - `RegExp` objects are not serializable
+ * - `Error` objects are not serializable
+ * - `Symbol` objects are not serializable
+ * - And much more...
+ *
+ * @throws UnexpectedError if the value is not serializable as JSON
+ * @public exported from `@promptbook/utils`
+ */
+export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
+ */

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

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+/**
+ * @@@
+ *
+ * Note: It is usefull @@@
+ *
+ * @param pipeline
+ * @public exported from `@promptbook/utils`
+ */
+export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;
+/**
+ * TODO: [🍙] Make some standard order of json properties
+ */

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

@@ -0,0 +1,10 @@
+import type { WritableDeep } from 'type-fest';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;
+/**
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

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

@@ -0,0 +1,24 @@
+/**
+ * Tests if the value is [🚉] serializable as JSON
+ *
+ * - Almost all primitives are serializable BUT:
+ * - `undefined` is not serializable
+ * - `NaN` is not serializable
+ * - Objects and arrays are serializable if all their properties are serializable
+ * - Functions are not serializable
+ * - Circular references are not serializable
+ * - `Date` objects are not serializable
+ * - `Map` and `Set` objects are not serializable
+ * - `RegExp` objects are not serializable
+ * - `Error` objects are not serializable
+ * - `Symbol` objects are not serializable
+ * - And much more...
+ *
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isSerializableAsJson(value: unknown): boolean;
+/**
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][💺] Can be done this on type-level?
+ */

package/esm/typings/src/utils/serialization/isSerializableAsJson.test.d.ts

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

package/esm/typings/src/utils/sets/difference.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Create difference set of two sets.
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;
+/**
+ * TODO: [🧠][💯] Maybe also implement symmetricDifference
+ */

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

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

package/esm/typings/src/utils/sets/intersection.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Creates a new set with all elements that are present in all sets
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
+ */
+export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * Creates a new set with all elements that are present in either set
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
+ */
+export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

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 usefull 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 usefull 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 usefull 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:
+ * - `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/isValidFilePath.d.ts

@@ -0,0 +1,9 @@
+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;

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';
+/**
+ * @@@
+ *
+ * @param javascriptName @@@
+ * @returns @@@
+ * @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,10 @@
+import type { string_parameter_name } from '../../../types/typeAliases';
+/**
+ * Function `validateParameterName` will @@@
+ *
+ * @param parameterName @@@
+ * @returns @@@
+ * @throws {ParseError} @@@
+ * @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 simmilar 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 simmilar 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 simmilar 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 simmilar 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 simmilar 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 simmilar 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,18 @@
+import type { string_semantic_version } from './types/typeAliases';
+/**
+ * The version of the Book language
+ *
+ * @see https://github.com/webgptorg/book
+ */
+export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
+/**
+ * The version of the Promptbook engine
+ *
+ * @see https://github.com/webgptorg/promptbook
+ */
+export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
+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/package.json

@@ -0,0 +1,59 @@
+{
+    "name": "@promptbook/vercel",
+    "version": "0.76.0",
+    "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
+    "--note-0": "    <- [🐊]",
+    "private": false,
+    "sideEffects": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/webgptorg/promptbook"
+    },
+    "contributors": [
+        "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
+    ],
+    "--todo-0": "TODO: [❇️] Make better list of keywords",
+    "keywords": [
+        "ai",
+        "llm",
+        "prompt",
+        "template",
+        "language-model",
+        "chatgpt",
+        "autogpt",
+        "machine-learning",
+        "natural-language-processing",
+        "nlp",
+        "openai",
+        "gpt-3",
+        "gpt-4",
+        "gpt-4o",
+        "gpt-4o-mini",
+        "o1",
+        "o1-mini",
+        "o1-preview",
+        "anthropic",
+        "LLMOps"
+    ],
+    "license": "CC-BY-4.0",
+    "bugs": {
+        "url": "https://github.com/webgptorg/promptbook/issues"
+    },
+    "homepage": "https://www.npmjs.com/package/@promptbook/core",
+    "funding": [
+        {
+            "type": "individual",
+            "url": "https://buymeacoffee.com/hejny"
+        },
+        {
+            "type": "github",
+            "url": "https://github.com/webgptorg/promptbook/blob/main/README.md#%EF%B8%8F-contributing"
+        }
+    ],
+    "main": "./umd/index.umd.js",
+    "module": "./esm/index.es.js",
+    "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
+    "peerDependencies": {
+        "@promptbook/core": "0.76.0"
+    }
+}

package/umd/index.umd.js

@@ -0,0 +1,31 @@
+(function (global, factory) {
+	typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+	typeof define === 'function' && define.amd ? define(['exports'], factory) :
+	(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-vercel"] = {}));
+})(this, (function (exports) { 'use strict';
+
+	// ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
+	/**
+	 * The version of the Book language
+	 *
+	 * @see https://github.com/webgptorg/book
+	 */
+	var BOOK_LANGUAGE_VERSION = '1.0.0';
+	/**
+	 * The version of the Promptbook engine
+	 *
+	 * @see https://github.com/webgptorg/promptbook
+	 */
+	var PROMPTBOOK_ENGINE_VERSION = '0.75.10';
+	/**
+	 * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
+	 * Note: [💞] Ignore a discrepancy between file name and entity name
+	 */
+
+	exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
+	exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
+
+	Object.defineProperty(exports, '__esModule', { value: true });
+
+}));
+//# sourceMappingURL=index.umd.js.map

package/umd/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../../../../src/version.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;CAAA;CAIA;;;;CAIG;AACI,KAAM,qBAAqB,GAA4B,QAAQ;CAEtE;;;;CAIG;AACI,KAAM,yBAAyB,GAA8B,UAAU;CAI9E;;;CAGG;;;;;;;;;;;"}