@promptbook/cli 0.62.2 → 0.63.0-0

package/umd/typings/src/utils/FromtoItems.d.ts

@@ -1,19 +1,19 @@
-/**
- * Represents items which are compared to each other
- */
-export type FromtoItems = Array<{
-    /**
-     * The title of the item
-     */
-    readonly title: string;
-    /**
-     * The start of the item
-     *
-     * This can mean anything, like seconds, milliseconds, dollars, etc.
-     */
-    readonly from: number;
-    /**
-     * The end of the item
-     */
-    readonly to: number;
-}>;
+/**
+ * Represents items which are compared to each other
+ */
+export type FromtoItems = Array<{
+    /**
+     * The title of the item
+     */
+    readonly title: string;
+    /**
+     * The start of the item
+     *
+     * This can mean anything, like seconds, milliseconds, dollars, etc.
+     */
+    readonly from: number;
+    /**
+     * The end of the item
+     */
+    readonly to: number;
+}>;

package/umd/typings/src/utils/arrayableToArray.d.ts

@@ -1,11 +1,11 @@
-import type { Arrayable } from '../types/Arrayable';
-/**
- * Takes an item or an array of items and returns an array of items
- *
- * 1) Any item except array and undefined returns array with that one item (also null)
- * 2) Undefined returns empty array
- * 3) Array returns itself
- *
- * @private Internal utility
- */
-export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;
+import type { Arrayable } from '../types/Arrayable';
+/**
+ * Takes an item or an array of items and returns an array of items
+ *
+ * 1) Any item except array and undefined returns array with that one item (also null)
+ * 2) Undefined returns empty array
+ * 3) Array returns itself
+ *
+ * @private Internal utility
+ */
+export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;

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

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

package/umd/typings/src/utils/currentDate.d.ts

@@ -1,7 +1,8 @@
-import type { string_date_iso8601 } from '../types/typeAliases';
-/**
- * Simple wrapper `new Date().toISOString()`
- *
- * @returns string_date branded type
- */
-export declare function $currentDate(): string_date_iso8601;
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Simple wrapper `new Date().toISOString()`
+ *
+ * @returns string_date branded type
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $currentDate(): string_date_iso8601;

package/umd/typings/src/utils/deepClone.d.ts

@@ -1,9 +1,10 @@
-import type { WritableDeep } from 'type-fest';
-/**
- * @@@
- */
-export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;
-/**
- * TODO: [🔼] Export from `@promptbook/utils`
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
+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/umd/typings/src/utils/deepFreeze.d.ts

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

package/umd/typings/src/utils/emojis.d.ts

@@ -1,23 +1,23 @@
-import type { string_char_emoji } from '../types/typeAliasEmoji';
-/**
- * All possible emoji chars like "🍆", "🍡", "🍤"...
- * Note: this will be needed to update annually - now updated at 2022-01-19
- *
- * @see https://getemoji.com/
- *
- * @private within the repository
- * @deprecated Use /\p{Extended_Pictographic}/ instead
- */
-export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
-/**
- *
- * All possible emoji chars like "🍆", "🍡", "🍤"...
- *
- * @private within the repository
- * @deprecated Use /\p{Extended_Pictographic}/ instead
- */
-export declare const EMOJIS: Set<string_char_emoji>;
-/**
- * TODO: [💴] DRY - just one version of emojis.ts
- * TODO: Mirror from Collboard or some common package
- */
+import type { string_char_emoji } from '../types/typeAliasEmoji';
+/**
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ * Note: this will be needed to update annually - now updated at 2022-01-19
+ *
+ * @see https://getemoji.com/
+ *
+ * @private within the repository
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+/**
+ *
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ *
+ * @private within the repository
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS: Set<string_char_emoji>;
+/**
+ * TODO: [💴] DRY - just one version of emojis.ts
+ * TODO: Mirror from Collboard or some common package
+ */

package/umd/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -1,5 +1,7 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-/**
- * Counts number of characters in the text
- */
-export declare function countCharacters(text: string): ExpectationAmount;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of characters in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countCharacters(text: string): ExpectationAmount;

package/umd/typings/src/utils/expectation-counters/countCharacters.test.d.ts

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

package/umd/typings/src/utils/expectation-counters/countLines.d.ts

@@ -1,5 +1,7 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-/**
- * Counts number of lines in the text
- */
-export declare function countLines(text: string): ExpectationAmount;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of lines in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countLines(text: string): ExpectationAmount;

package/umd/typings/src/utils/expectation-counters/countLines.test.d.ts

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

package/umd/typings/src/utils/expectation-counters/countPages.d.ts

@@ -1,5 +1,7 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-/**
- * Counts number of pages in the text
- */
-export declare function countPages(text: string): ExpectationAmount;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of pages in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countPages(text: string): ExpectationAmount;

package/umd/typings/src/utils/expectation-counters/countPages.test.d.ts

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

package/umd/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -1,5 +1,7 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-/**
- * Counts number of paragraphs in the text
- */
-export declare function countParagraphs(text: string): ExpectationAmount;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of paragraphs in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

package/umd/typings/src/utils/expectation-counters/countParagraphs.test.d.ts

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

package/umd/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -1,9 +1,13 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-/**
- * Split text into sentences
- */
-export declare function splitIntoSentences(text: string): Array<string>;
-/**
- * Counts number of sentences in the text
- */
-export declare function countSentences(text: string): ExpectationAmount;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Split text into sentences
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function splitIntoSentences(text: string): Array<string>;
+/**
+ * Counts number of sentences in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countSentences(text: string): ExpectationAmount;

package/umd/typings/src/utils/expectation-counters/countSentences.test.d.ts

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

package/umd/typings/src/utils/expectation-counters/countWords.d.ts

@@ -1,5 +1,7 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-/**
- * Counts number of words in the text
- */
-export declare function countWords(text: string): ExpectationAmount;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of words in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countWords(text: string): ExpectationAmount;

package/umd/typings/src/utils/expectation-counters/countWords.test.d.ts

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

package/umd/typings/src/utils/expectation-counters/index.d.ts

@@ -1,6 +1,8 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
-import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
-/**
- * Index of all counter functions
- */
-export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
+/**
+ * Index of all counter functions
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;

package/umd/typings/src/utils/extractParameterNames.d.ts

@@ -1,9 +1,10 @@
-import type { string_parameter_name } from '../types/typeAliases';
-import type { string_template } from '../types/typeAliases';
-/**
- * Parses the template and returns the list of all parameter names
- *
- * @param template the template with parameters in {curly} braces
- * @returns the list of parameter names
- */
-export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;
+import type { string_parameter_name } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
+/**
+ * Parses the template and returns the list of all parameter names
+ *
+ * @param template the template with parameters in {curly} braces
+ * @returns the list of parameter names
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;

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

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

package/umd/typings/src/utils/formatNumber.d.ts

@@ -1,6 +1,6 @@
-/**
- * Format either small or big number
- *
- * @private within the repository
- */
-export declare function formatNumber(value: number): string;
+/**
+ * Format either small or big number
+ *
+ * @private within the repository
+ */
+export declare function formatNumber(value: number): string;

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

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

package/umd/typings/src/utils/getCurrentIsoDate.d.ts

@@ -1,7 +1,7 @@
-import type { string_date_iso8601 } from '../types/typeAliases';
-/**
- * Get current date in ISO 8601 format
- *
- * @private This is internal util of the promptbook
- */
-export declare function getCurrentIsoDate(): string_date_iso8601;
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private This is internal util of the promptbook
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

package/umd/typings/src/utils/isRunningInWhatever.d.ts

@@ -1,15 +1,18 @@
-/**
- * Detects if the code is running in a browser environment in main thread (Not in a web worker)
- */
-export declare const isRunningInBrowser: Function;
-/**
- * Detects if the code is running in a Node.js environment
- */
-export declare const isRunningInNode: Function;
-/**
- * Detects if the code is running in a web worker
- */
-export declare const isRunningInWebWorker: Function;
-/**
- * TODO: [🔼] !!! Export via `@promptbook/utils`
- */
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const isRunningInBrowser: Function;
+/**
+ * Detects if the code is running in a Node.js environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const isRunningInNode: Function;
+/**
+ * Detects if the code is running in a web worker
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const isRunningInWebWorker: Function;

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

@@ -1,11 +1,14 @@
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_name } from '../../types/typeAliases';
-/**
- * Add or modify an auto-generated section in a markdown file
- *
- * @private within the repository
- */
-export declare function addAutoGeneratedSection(content: string_markdown, options: {
-    readonly sectionName: string_name;
-    readonly sectionContent: string_markdown;
-}): string_markdown;
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Add or modify an auto-generated section in a markdown file
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function addAutoGeneratedSection(content: string_markdown, options: {
+    readonly sectionName: string_name;
+    readonly sectionContent: string_markdown;
+}): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/umd/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts

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

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

@@ -1,38 +1,38 @@
-import type { string_markdown } from '../../types/typeAliases';
-import type { FromtoItems } from '../FromtoItems';
-/**
- * Options for `CreateMarkdownChartOptions`
- */
-type CreateMarkdownChartOptions = {
-    /**
-     * The header for the first column - the name of the item
-     */
-    readonly nameHeader: string;
-    /**
-     * The header for the second column - the value of the item
-     */
-    readonly valueHeader: string;
-    /**
-     * The items to be charted
-     */
-    readonly items: FromtoItems;
-    /**
-     * The width of the chart in squares
-     */
-    readonly width: number;
-    /**
-     * The name of the unit shown in the chart
-     */
-    readonly unitName: string;
-};
-/**
- * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
- *
- * @private within the repository
- */
-export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
-export {};
-/**
- * TODO: Maybe use Mermain Gant Diagrams
- *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
- */
+import type { string_markdown } from '../../types/typeAliases';
+import type { FromtoItems } from '../FromtoItems';
+/**
+ * Options for `CreateMarkdownChartOptions`
+ */
+type CreateMarkdownChartOptions = {
+    /**
+     * The header for the first column - the name of the item
+     */
+    readonly nameHeader: string;
+    /**
+     * The header for the second column - the value of the item
+     */
+    readonly valueHeader: string;
+    /**
+     * The items to be charted
+     */
+    readonly items: FromtoItems;
+    /**
+     * The width of the chart in squares
+     */
+    readonly width: number;
+    /**
+     * The name of the unit shown in the chart
+     */
+    readonly unitName: string;
+};
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
+export {};
+/**
+ * TODO: Maybe use Mermain Gant Diagrams
+ *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
+ */

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

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

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

@@ -1,8 +1,11 @@
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
-/**
- * Create a markdown table from a 2D array of strings
- *
- * @private within the repository
- */
-export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Create a markdown table from a 2D array of strings
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

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

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

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

@@ -1,6 +1,11 @@
-import type { string_markdown_text } from '../../types/typeAliases';
-/**
- * Function escapeMarkdownBlock will escape markdown block if needed
- * It is useful when you want have block in block
- */
-export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Function escapeMarkdownBlock will escape markdown block if needed
+ * It is useful when you want have block in block
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/umd/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts

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

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

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