@promptbook/utils 0.41.4 → 0.41.102

package/esm/typings/types/execution-report/ExecutionReportJson.d.ts

@@ -1,56 +1,56 @@
-import type { PromptResult } from '../../execution/PromptResult';
-import type { Prompt } from '../Prompt';
-import type { string_promptbook_url, string_version } from '../typeAliases';
-/**
- * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
- *
- * It can have 2 formats:
- * -   **.md file** created from the **JSON** format
- * -   _(this)_ **JSON** format
- *
- * @see https://github.com/webgptorg/promptbook#execution-report
- */
-export type ExecutionReportJson = {
-    /**
-     * Unique identifier of the promptbook from promptbook which was executed
-     */
-    readonly promptbookUrl?: string_promptbook_url;
-    /**
-     * Title of from promptbook which was executed
-     */
-    readonly title?: string;
-    /**
-     * Version from promptbook which was executed
-     */
-    readonly promptbookUsedVersion: string_version;
-    /**
-     * Version from promptbook which was requested by promptbook
-     */
-    readonly promptbookRequestedVersion?: string_version;
-    /**
-     * Description of the promptbook which was executed
-     */
-    readonly description?: string;
-    /**
-     * Sequence of prompt templates in order which were executed
-     */
-    readonly promptExecutions: Array<{
-        /**
-         * The prompt wich was executed
-         */
-        prompt: Omit<Prompt, 'promptbookUrl' | 'parameters'>;
-        /**
-         * Result of the prompt execution (if not failed during LLM execution)
-         */
-        result?: PromptResult;
-        /**
-         * The error which occured during LLM execution or during postprocessing or expectation checking
-         *
-         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
-         */
-        error?: {
-            message: string;
-        };
-    }>;
-};
+import type { PromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../Prompt';
+import type { string_promptbook_url, string_version } from '../typeAliases';
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   **.md file** created from the **JSON** format
+ * -   _(this)_ **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportJson = {
+    /**
+     * Unique identifier of the promptbook from promptbook which was executed
+     */
+    readonly promptbookUrl?: string_promptbook_url;
+    /**
+     * Title of from promptbook which was executed
+     */
+    readonly title?: string;
+    /**
+     * Version from promptbook which was executed
+     */
+    readonly promptbookUsedVersion: string_version;
+    /**
+     * Version from promptbook which was requested by promptbook
+     */
+    readonly promptbookRequestedVersion?: string_version;
+    /**
+     * Description of the promptbook which was executed
+     */
+    readonly description?: string;
+    /**
+     * Sequence of prompt templates in order which were executed
+     */
+    readonly promptExecutions: Array<{
+        /**
+         * The prompt wich was executed
+         */
+        prompt: Omit<Prompt, 'promptbookUrl' | 'parameters'>;
+        /**
+         * Result of the prompt execution (if not failed during LLM execution)
+         */
+        result?: PromptResult;
+        /**
+         * The error which occured during LLM execution or during postprocessing or expectation checking
+         *
+         * Note: It makes sense to have both error and result defined, for example when the result not pass expectations
+         */
+        error?: {
+            message: string;
+        };
+    }>;
+};

package/esm/typings/types/execution-report/ExecutionReportString.d.ts

@@ -1,16 +1,16 @@
-/**
- * ExecutionReport is result of executing one promptbook
- * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
- *
- * It can have 2 formats:
- * -   _(this)_ **.md file** created from the **JSON** format
- * -   **JSON** format
- *
- * @see https://github.com/webgptorg/promptbook#execution-report
- */
-export type ExecutionReportString = string & {
-    readonly _type: 'ExecutionReportString';
-};
-/**
- * TODO: Better validation or remove branded type and make it just string
- */
+/**
+ * ExecutionReport is result of executing one promptbook
+ * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
+ *
+ * It can have 2 formats:
+ * -   _(this)_ **.md file** created from the **JSON** format
+ * -   **JSON** format
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-report
+ */
+export type ExecutionReportString = string & {
+    readonly _type: 'ExecutionReportString';
+};
+/**
+ * TODO: Better validation or remove branded type and make it just string
+ */

package/esm/typings/types/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,21 +1,21 @@
-import { number_percent } from '../typeAliases';
-/**
- * Options for generating an execution report string
- */
-export type ExecutionReportStringOptions = {
-    /**
-     * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
-     */
-    taxRate: number_percent;
-    /**
-     * The width of the charts in the report
-     */
-    chartsWidth: number;
-};
-/**
- * Default options for generating an execution report string
- */
-export declare const ExecutionReportStringOptionsDefaults: {
-    taxRate: number;
-    chartsWidth: number;
-};
+import { number_percent } from '../typeAliases';
+/**
+ * Options for generating an execution report string
+ */
+export type ExecutionReportStringOptions = {
+    /**
+     * The tax rate to be applied, expressed as a percentage from 0 to 1 (=100%) or even more
+     */
+    taxRate: number_percent;
+    /**
+     * The width of the charts in the report
+     */
+    chartsWidth: number;
+};
+/**
+ * Default options for generating an execution report string
+ */
+export declare const ExecutionReportStringOptionsDefaults: {
+    taxRate: number;
+    chartsWidth: number;
+};

package/esm/typings/types/execution-report/config.d.ts

@@ -1,8 +1,8 @@
-/**
- * The thresholds for the relative time in the `moment` library.
- *
- * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
- */
-export declare const MOMENT_ARG_THRESHOLDS: {
-    readonly ss: 3;
-};
+/**
+ * The thresholds for the relative time in the `moment` library.
+ *
+ * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
+ */
+export declare const MOMENT_ARG_THRESHOLDS: {
+    readonly ss: 3;
+};

package/esm/typings/types/execution-report/countWorkingDuration.d.ts

@@ -1,7 +1,7 @@
-import { FromtoItems } from '../../utils/FromtoItems';
-/**
- * Count the duration of working time
- *
- * @private within the library
- */
-export declare function countWorkingDuration(items: FromtoItems): number;
+import { FromtoItems } from '../../utils/FromtoItems';
+/**
+ * Count the duration of working time
+ *
+ * @private within the library
+ */
+export declare function countWorkingDuration(items: FromtoItems): number;

package/esm/typings/types/execution-report/countWorkingDuration.test.d.ts

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

package/esm/typings/types/execution-report/executionReportJsonToString.d.ts

@@ -1,11 +1,11 @@
-import type { ExecutionReportJson } from './ExecutionReportJson';
-import type { ExecutionReportString } from './ExecutionReportString';
-import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
-/**
- * Converts execution report from JSON to string format
- */
-export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
-/**
- * TODO: Add mermaid chart for every report
- * TODO: [🧠] Allow to filter out some parts of the report by options
- */
+import type { ExecutionReportJson } from './ExecutionReportJson';
+import type { ExecutionReportString } from './ExecutionReportString';
+import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
+/**
+ * Converts execution report from JSON to string format
+ */
+export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+/**
+ * TODO: Add mermaid chart for every report
+ * TODO: [🧠] Allow to filter out some parts of the report by options
+ */

package/esm/typings/types/execution-report/executionReportJsonToString.test.d.ts

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