@promptbook/javascript 0.112.0-32 → 0.112.0-35

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

@@ -5,11 +5,8 @@ import type { string_token } from '../../types/typeAliases';
  * 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
  * @returns secure random token
+ *
+ * @private internal helper function
  */
 export declare function $randomToken(randomness: number): string_token;
-/**
- * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
- * TODO: Maybe use nanoid instead https://github.com/ai/nanoid
- */

package/esm/src/utils/random/EnglishNamePool.d.ts

@@ -4,6 +4,7 @@ import type { GenerateNameResult, NamePool } from './NamePool';
  *
  * @param seed - Input seed used to derive a stable pseudonym.
  * @returns Deterministic English full name with color metadata.
+ *
  * @private internal helper for deterministic pseudonym generation
  */
 export declare function generateDeterministicEnglishName(seed: string): GenerateNameResult;

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

@@ -7,9 +7,7 @@ import type { $side_effect } from '../organization/$side_effect';
  * 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<$side_effect & TObject>;
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */

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

@@ -35,11 +35,7 @@ export type CheckSerializableAsJsonOptions = {
  * - And much more...
  *
  * @throws UnexpectedError if the value is not serializable as JSON
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function checkSerializableAsJson(options: CheckSerializableAsJsonOptions): void;
-/**
- * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
- * TODO: [🧠][main] !!3 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/src/utils/serialization/clonePipeline.d.ts

@@ -6,9 +6,7 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
  *
  * @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;
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

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

@@ -7,9 +7,7 @@ import type { WritableDeep } from 'type-fest';
  *
  * @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>;
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */

package/esm/src/utils/serialization/exportJson.d.ts

@@ -21,9 +21,7 @@ export type ExportJsonOptions<TObject> = CheckSerializableAsJsonOptions & Partia
  * Note: This function does not mutates the given object
  *
  * @returns The same type of object as the input but read-only and re-ordered
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function exportJson<TObject>(options: ExportJsonOptions<TObject>): TObject;
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */

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

@@ -15,11 +15,6 @@ import type { JsonValue } from 'type-fest';
  * - `Symbol` objects are not serializable
  * - And much more...
  *
- *
  * @public exported from `@promptbook/utils`
  */
 export declare function isSerializableAsJson(value: unknown): value is JsonValue;
-/**
- * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
- * TODO: [🧠][💺] Can be done this on type-level?
- */

package/esm/src/utils/serialization/jsonStringsToJsons.d.ts

@@ -1,9 +1,6 @@
 /**
  * Recursively converts JSON strings to JSON objects
-
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function jsonStringsToJsons<T>(object: T): T;
-/**
- * TODO: Type the return type correctly
- */

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

@@ -1,5 +1,8 @@
 import type { string_javascript } from '../../types/typeAliases';
 import type { TODO_any } from '../organization/TODO_any';
+/**
+ * Type describing serialize to promptbook javascript return.
+ */
 type SerializeToPromptbookJavascriptReturn = {
     /**
      * Array of import statements required for the `value` to work
@@ -17,6 +20,3 @@ type SerializeToPromptbookJavascriptReturn = {
  */
 export declare function serializeToPromptbookJavascript(value: TODO_any): SerializeToPromptbookJavascriptReturn;
 export {};
-/**
- * TODO: Dynamic indentation passable through options in a second argument
- */

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

@@ -2,9 +2,7 @@
  * 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/src/utils/sets/intersection.d.ts

@@ -2,6 +2,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/src/utils/sets/union.d.ts

@@ -2,6 +2,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/src/utils/take/classes/TakeChain.d.ts

@@ -1,8 +1,11 @@
 import type { ITakeChain } from '../interfaces/ITakeChain';
 import type { Takeable } from '../interfaces/Takeable';
 /**
- * @private util of `@promptbook/color`
+ * Class implementing take chain.
+ *
  * @de
+ *
+ * @private util of `@promptbook/color`
  */
 export declare class TakeChain<TValue extends Takeable> implements ITakeChain<TValue> {
     value: TValue;

package/esm/src/utils/take/interfaces/ITakeChain.d.ts

@@ -2,10 +2,14 @@ import type { Takeable } from './Takeable';
 /**
  * Represents any value with take chain functionality
  *
- * @private util of `@promptbook/color`
  * @deprecated [🤡] Use some better functional library instead of `TakeChain`
+ *
+ * @private util of `@promptbook/color`
  */
 export type WithTake<TValue extends Takeable> = TValue & ITakeChain<TValue>;
+/**
+ * Type describing take chain.
+ */
 export type ITakeChain<TValue extends Takeable> = {
     readonly value: TValue;
     then<TResultValue extends Takeable>(callback: (value: TValue) => TResultValue): WithTake<TResultValue>;

package/esm/src/utils/take/interfaces/Takeable.d.ts

@@ -1,7 +1,8 @@
 /**
  * Represents a type that can be chained in take pipe
  *
- * @private util of `@promptbook/color`
  * @deprecated [🤡] Use some better functional library instead of `TakeChain`
+ *
+ * @private util of `@promptbook/color`
  */
 export type Takeable = Exclude<object, null>;

package/esm/src/utils/take/take.d.ts

@@ -5,8 +5,8 @@ import type { Takeable } from './interfaces/Takeable';
  *
  * @param {*} initialValue - The initial value.
  * @returns {Proxy<WithTake<TValue>>} - A proxy object with a `take` method.
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
  *
  * @private util of `@promptbook/color`
- * @deprecated [🤡] Use some better functional library instead of `TakeChain`
  */
 export declare function take<TValue extends Takeable>(initialValue: TValue): WithTake<TValue>;

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

@@ -4,9 +4,7 @@ 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/src/utils/validators/filePath/isRootPath.test.d.ts

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

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

@@ -4,9 +4,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  * Tests if given string is valid file path.
  *
  * 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/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -5,6 +5,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  *
  * @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/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -8,6 +8,7 @@ import type { string_parameter_name } from '../../../types/typeAliases';
  * @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/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -4,12 +4,13 @@ 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
  *
+ * @see https://www.npmjs.com/package/promptbook?activeTab=versions
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

package/esm/src/utils/validators/url/extractUrlsFromText.d.ts

@@ -3,6 +3,7 @@
  *
  * @param text - Input text that may contain one or more URLs.
  * @returns Unique URLs in their first-seen order.
+ *
  * @private utility of KNOWLEDGE parsing
  */
 export declare function extractUrlsFromText(text: string): string[];

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

@@ -14,6 +14,7 @@ export type IsUrlOnPrivateNetworkOptions = IsHostnameOnPrivateNetworkOptions;
  * @param {string} url - The URL to check.
  * @param {IsUrlOnPrivateNetworkOptions} options - Options for the 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, options?: IsUrlOnPrivateNetworkOptions): boolean;

package/esm/src/utils/validators/url/isValidAgentUrl.d.ts

@@ -11,6 +11,3 @@ import type { really_unknown } from '../../organization/really_unknown';
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidAgentUrl(url: really_unknown): url is string_agent_url;
-/**
- * TODO: [🐠] Maybe more info why the URL is invalid
- */

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

@@ -11,6 +11,3 @@ import type { really_unknown } from '../../organization/really_unknown';
  * @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/src/utils/validators/url/normalizeDomainForMatching.d.ts

@@ -6,6 +6,7 @@
  *
  * @param rawDomain - Raw domain value (for example `my-agent.com` or `https://my-agent.com/path`).
  * @returns Normalized hostname or `null` when the value cannot be normalized.
+ *
  * @private utility for host/domain matching
  */
 export declare function normalizeDomainForMatching(rawDomain: string): string | null;

package/esm/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.112.0-31`).
+ * It follows semantic versioning (e.g., `0.112.0-34`).
  *
  * @generated
  */

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

@@ -9,7 +9,3 @@ import type { string_filename, string_pipeline_url } from '../types/typeAliases'
  * @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/src/wizard/wizard.d.ts

@@ -65,11 +65,8 @@ declare class Wizard {
  * 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

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.112.0-32",
+    "version": "0.112.0-35",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -97,7 +97,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/javascript.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.112.0-32"
+        "@promptbook/core": "0.112.0-35"
     },
     "dependencies": {
         "crypto": "1.0.1",