@promptbook/node 0.61.0-9 → 0.61.0

package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -1,37 +1,34 @@
 import type { string_markdown } from '../../types/typeAliases';
 import type { FromtoItems } from '../FromtoItems';
 /**
- * Options for creating a markdown chart
- */
-/**
- * Options for creating a markdown chart.
+ * Options for `CreateMarkdownChartOptions`
  */
 type CreateMarkdownChartOptions = {
     /**
      * The header for the first column - the name of the item
      */
-    nameHeader: string;
+    readonly nameHeader: string;
     /**
      * The header for the second column - the value of the item
      */
-    valueHeader: string;
+    readonly valueHeader: string;
     /**
      * The items to be charted
      */
-    items: FromtoItems;
+    readonly items: FromtoItems;
     /**
      * The width of the chart in squares
      */
-    width: number;
+    readonly width: number;
     /**
      * The name of the unit shown in the chart
      */
-    unitName: string;
+    readonly unitName: string;
 };
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts

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

package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -3,14 +3,18 @@ import type { string_markdown } from '../../types/typeAliases';
  * Single code block inside markdown.
  */
 export type CodeBlock = {
+    /**
+     * Which notation was used to open the code block
+     */
+    readonly blockNotation: '```' | '>';
     /**
      * Language of the code block OR null if the language is not specified in opening ```
      */
-    language: string | null;
+    readonly language: string | null;
     /**
      * Content of the code block (unescaped)
      */
-    content: string;
+    readonly content: string;
 };
 /**
  * Extracts all code blocks from markdown.
@@ -25,3 +29,6 @@ export type CodeBlock = {
  *
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -15,5 +15,5 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
  */

package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts

@@ -8,15 +8,15 @@ export type MarkdownSection = {
     /**
      * Title of the section
      */
-    title: string_markdown_text;
+    readonly title: string_markdown_text;
     /**
      * Level of the section like h1, h2, h3, h4, h5, h6
      */
-    level: 1 | 2 | 3 | 4 | 5 | 6;
+    readonly level: 1 | 2 | 3 | 4 | 5 | 6;
     /**
      * Content of the section with markdown formatting, blocks, lists, etc.
      */
-    content: string_markdown_section_content;
+    readonly content: string_markdown_section_content;
 };
 /**
  * Parses markdown section to title its level and content

package/umd/typings/src/utils/normalization/parseKeywords.d.ts

@@ -1,3 +1,4 @@
+import type { really_unknown } from '../organization/really_unknown';
 import type { IKeywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
@@ -7,7 +8,7 @@ import type { IKeywords } from './IKeywords';
  * @param input of any kind
  * @returns {Set} of keywords without diacritics in lowercase
  */
-export declare function parseKeywords(input: unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): IKeywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/umd/typings/src/utils/organization/TODO_USE.d.ts

@@ -0,0 +1,12 @@
+import type { really_any } from './really_any';
+/**
+ * Just marks a place of place where should be something implemented
+ * No side effects.
+ *
+ * Note: It can be usefull suppressing eslint errors of unused variables
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function TODO_USE(...value: Array<really_any>): void;

package/umd/typings/src/utils/organization/TODO_any.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_any = any;

package/umd/typings/src/utils/organization/TODO_object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_object = object;

package/umd/typings/src/utils/organization/TODO_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_unknown = unknown;

package/umd/typings/src/utils/organization/___.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___ = never;

package/{esm/typings/src/utils → umd/typings/src/utils/organization}/just.d.ts

@@ -2,9 +2,13 @@
  * Returns the same value that is passed as argument.
  * No side effects.
  *
- * Note: It can be usefull for leveling indentation
+ * Note: It can be usefull for:
+ *
+ * 1) Leveling indentation
+ * 2) Putting always-true or always-false conditions without getting eslint errors
  *
  * @param value any values
  * @returns the same values
+ * @private within the repository
  */
 export declare function just<T>(value?: T): T;

package/umd/typings/src/utils/organization/keepUnused.d.ts

@@ -0,0 +1,16 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used but should be kept
+ * No side effects.
+ *
+ * Note: It can be usefull for:
+ *
+ * 1) Suppressing eager optimization of unused imports
+ * 2) Suppressing eslint errors of unused variables in the tests
+ * 3) Keeping the type of the variable for type testing
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;

package/umd/typings/src/utils/organization/really_any.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to mark a place where to really use `any`
+ *
+ * @private within the repository
+ */
+export type really_any = any;

package/umd/typings/src/utils/organization/really_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to mark a place where to really use `unknown`
+ *
+ * @private within the repository
+ */
+export type really_unknown = unknown;

package/umd/typings/src/utils/random/randomSeed.d.ts

@@ -0,0 +1,7 @@
+import type { number_seed } from '../../types/typeAliases';
+/**
+ * Generates random seed
+ *
+ * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ */
+export declare function $randomSeed(): number_seed;

package/umd/typings/src/{execution/utils → utils}/replaceParameters.d.ts

@@ -1,5 +1,5 @@
-import type { Parameters } from '../../types/Parameters';
-import type { string_template } from '../../types/typeAliases';
+import type { Parameters } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *
@@ -7,7 +7,5 @@ import type { string_template } from '../../types/typeAliases';
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
- *
- * @private within the createPipelineExecutor
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/umd/typings/src/utils/replaceParameters.test.d.ts

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

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

@@ -4,3 +4,6 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  */
 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/umd/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -1,5 +1,6 @@
 import type { string_email } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid email
  */
-export declare function isValidEmail(email: unknown): email is string_email;
+export declare function isValidEmail(email: really_unknown): email is string_email;

package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,7 +1,8 @@
 import type { string_file_path } 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
  */
-export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;
+export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;

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

@@ -1,2 +1,3 @@
 import type { string_javascript_name } from '../../../types/typeAliases';
-export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;
+import type { really_unknown } from '../../organization/really_unknown';
+export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -1,4 +1,5 @@
 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.
@@ -9,4 +10,4 @@ import type { string_promptbook_version } from '../../../version';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;
+export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

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

@@ -1,4 +1,5 @@
 import type { string_semantic_version } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid semantic version
  *
@@ -6,4 +7,4 @@ import type { string_semantic_version } from '../../../types/typeAliases';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;
+export declare function isValidSemanticVersion(version: really_unknown): version is string_semantic_version;

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

@@ -1,4 +1,5 @@
 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.
  *
@@ -6,7 +7,7 @@ import type { string_pipeline_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
  */
-export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
+export declare function isValidPipelineUrl(url: really_unknown): url is string_pipeline_url;
 /**
  * TODO: [🐠] Maybe more info why the URL is invalid
  */

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

@@ -1,4 +1,5 @@
 import type { string_url } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
@@ -7,4 +8,4 @@ import type { string_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  */
-export declare function isValidUrl(url: unknown): url is string_url;
+export declare function isValidUrl(url: really_unknown): url is string_url;

package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -1,5 +1,6 @@
 import type { string_uuid } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  */
-export declare function isValidUuid(value: unknown): value is string_uuid;
+export declare function isValidUuid(value: really_unknown): value is string_uuid;

package/esm/typings/src/collection/constructors/justTestFsImport.d.ts

@@ -1,7 +0,0 @@
-/**
- * Just testing imports and compatibility
- */
-export declare function justTestFsImport(): Promise<void>;
-/**
- * TODO: !!! Remove this file
- */ 

package/esm/typings/src/personas/personaToModelRequirements.d.ts

@@ -1,6 +0,0 @@
-/**
- * Function personaToModelRequirements will @@@
- *
- * @private within the package
- */
-export declare function personaToModelRequirements(value: string): boolean;

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

@@ -1,14 +0,0 @@
-/**
- * Parameters of the pipeline
- *
- * There are three types of parameters:
- * - **INPUT PARAMETERs** are required to execute the pipeline.
- * - **Intermediate parameters** are used internally in the pipeline.
- * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
- *
- * @see https://github.com/webgptorg/promptbook#parameters
- */
-export type Parameters = object;
-/**
- * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
- */

package/esm/typings/src/types/PipelineJson/KnowledgeJson.d.ts

@@ -1,6 +0,0 @@
-import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
-export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
-/**
- * !!!! Annotate
- * TODO: [🦪] Internal links between (Material)KnowledgePieces withing the KnowledgeJson
- */

package/esm/typings/src/types/PipelineJson/MaterialKnowledgePieceJson.d.ts

@@ -1,28 +0,0 @@
-import type { EmbeddingVector } from '../../execution/EmbeddingVector';
-import type { string_keyword } from '../../utils/normalization/IKeywords';
-import type { string_href } from '../typeAliases';
-import type { string_markdown } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_model_name } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-export type MaterialKnowledgePieceJson = {
-    readonly name: string_name;
-    readonly title: string_markdown_text;
-    readonly content: string_markdown;
-    readonly keywords: Array<string_keyword>;
-    readonly index: Array<{
-        modelName: string_model_name;
-        position: EmbeddingVector;
-    }>;
-    readonly sources: Array<{
-        title: string_markdown_text;
-        href: string_href;
-    }>;
-};
-/**
- * TODO: !!! Use or uninstall xyzt
- * !!!! Annotate
- * TODO: [🧠][🦪] Maybe allow internal links between (Material)KnowledgePieces withing the KnowledgeJson and maybe require to explicitelly reference the source of the knowledge
- * TODO: [🧠] Make some non-material sources like external search engine or dialog to user
- * TODO: [🧠] Make some non-material (and maybe non-knowledge-like but tool-like) sources like calculator, code interpreter
- */

package/umd/typings/src/collection/constructors/justTestFsImport.d.ts

@@ -1,7 +0,0 @@
-/**
- * Just testing imports and compatibility
- */
-export declare function justTestFsImport(): Promise<void>;
-/**
- * TODO: !!! Remove this file
- */ 

package/umd/typings/src/personas/personaToModelRequirements.d.ts

@@ -1,6 +0,0 @@
-/**
- * Function personaToModelRequirements will @@@
- *
- * @private within the package
- */
-export declare function personaToModelRequirements(value: string): boolean;

package/umd/typings/src/types/Parameters.d.ts

@@ -1,14 +0,0 @@
-/**
- * Parameters of the pipeline
- *
- * There are three types of parameters:
- * - **INPUT PARAMETERs** are required to execute the pipeline.
- * - **Intermediate parameters** are used internally in the pipeline.
- * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
- *
- * @see https://github.com/webgptorg/promptbook#parameters
- */
-export type Parameters = object;
-/**
- * TODO: Constrain type to Simple key-value object, only string keys and string values and no index signature + only camelCase keys and spaceTrimmed values
- */

package/umd/typings/src/types/PipelineJson/KnowledgeJson.d.ts

@@ -1,6 +0,0 @@
-import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
-export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
-/**
- * !!!! Annotate
- * TODO: [🦪] Internal links between (Material)KnowledgePieces withing the KnowledgeJson
- */

package/umd/typings/src/types/PipelineJson/MaterialKnowledgePieceJson.d.ts

@@ -1,28 +0,0 @@
-import type { EmbeddingVector } from '../../execution/EmbeddingVector';
-import type { string_keyword } from '../../utils/normalization/IKeywords';
-import type { string_href } from '../typeAliases';
-import type { string_markdown } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_model_name } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-export type MaterialKnowledgePieceJson = {
-    readonly name: string_name;
-    readonly title: string_markdown_text;
-    readonly content: string_markdown;
-    readonly keywords: Array<string_keyword>;
-    readonly index: Array<{
-        modelName: string_model_name;
-        position: EmbeddingVector;
-    }>;
-    readonly sources: Array<{
-        title: string_markdown_text;
-        href: string_href;
-    }>;
-};
-/**
- * TODO: !!! Use or uninstall xyzt
- * !!!! Annotate
- * TODO: [🧠][🦪] Maybe allow internal links between (Material)KnowledgePieces withing the KnowledgeJson and maybe require to explicitelly reference the source of the knowledge
- * TODO: [🧠] Make some non-material sources like external search engine or dialog to user
- * TODO: [🧠] Make some non-material (and maybe non-knowledge-like but tool-like) sources like calculator, code interpreter
- */