@promptbook/remote-client 0.55.0-1 → 0.55.0-2

package/esm/typings/_packages/core.index.d.ts

@@ -11,14 +11,15 @@ import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
 import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
 import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
-import { addPromptResultUsage } from '../execution/addPromptResultUsage';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
+import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { usageToWorktime } from '../execution/utils/usageToWorktime';
 import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
 import { createPromptbookLibraryFromUrl } from '../library/constructors/createPromptbookLibraryFromUrl';
@@ -31,7 +32,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
-export { addPromptResultUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, usageToWorktime, };
 export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };

package/esm/typings/execution/PromptbookExecutor.d.ts

@@ -2,6 +2,7 @@ import type { Promisable } from 'type-fest';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { string_name } from '../types/typeAliases';
+import type { PromptResultUsage } from './PromptResult';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
  * Executor is made by combining execution tools and promptbook library.
@@ -13,15 +14,19 @@ import type { string_name } from '../types/typeAliases';
 export type PromptbookExecutor = {
     (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
-         * Whether the execution was successful
+         * Whether the execution was successful, details are aviable in `executionReport`
          */
         isSuccessful: boolean;
         /**
-         * Errors that occured during the execution
+         * Added usage of whole execution, detailed usage is aviable in `executionReport`
+         */
+        usage: PromptResultUsage;
+        /**
+         * Errors that occured during the execution, details are aviable in `executionReport`
          */
         errors: Array<Error>;
         /**
-         * The report of the execution
+         * The report of the execution with all details
          */
         executionReport: ExecutionReportJson;
         /**

package/esm/typings/execution/utils/addUsage.d.ts

@@ -0,0 +1,7 @@
+import type { PromptResultUsage } from '../PromptResult';
+/**
+ * Function `addUsage` will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns void usage
+ */
+export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/esm/typings/execution/utils/addUsage.test.d.ts

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

package/esm/typings/execution/{computeUsageCounts.d.ts → utils/computeUsageCounts.d.ts}

@@ -1,4 +1,4 @@
-import type { PromptResultUsageCounts } from './PromptResult';
+import type { PromptResultUsageCounts } from '../PromptResult';
 /**
  * Helper of usage compute
  *

package/esm/typings/execution/utils/uncertainNumber.d.ts

@@ -0,0 +1,9 @@
+import type { UncertainNumber } from '../PromptResult';
+/**
+ * Make UncertainNumber
+ *
+ * @param value
+ *
+ * @private utility for initializating UncertainNumber
+ */
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;

package/esm/typings/execution/utils/usageToWorktime.d.ts

@@ -0,0 +1,10 @@
+import type { PromptResultUsage } from '../PromptResult';
+import type { UncertainNumber } from '../PromptResult';
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of theese sources:
+ * - https://jecas.cz/doba-cteni
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ */
+export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;

package/esm/typings/execution/utils/usageToWorktime.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.55.0-1",
+    "version": "0.55.0-2",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.55.0-1"
+        "@promptbook/core": "0.55.0-2"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/_packages/core.index.d.ts

@@ -11,14 +11,15 @@ import { PromptbookReferenceError } from '../errors/PromptbookReferenceError';
 import { PromptbookSyntaxError } from '../errors/PromptbookSyntaxError';
 import { TemplateError } from '../errors/TemplateError';
 import { UnexpectedError } from '../errors/UnexpectedError';
-import { addPromptResultUsage } from '../execution/addPromptResultUsage';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
 import { MultipleLlmExecutionTools } from '../execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools';
 import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
+import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { usageToWorktime } from '../execution/utils/usageToWorktime';
 import { createPromptbookLibraryFromDirectory } from '../library/constructors/createPromptbookLibraryFromDirectory';
 import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
 import { createPromptbookLibraryFromUrl } from '../library/constructors/createPromptbookLibraryFromUrl';
@@ -31,7 +32,7 @@ import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
 export { justTestFsImport };
 export { ExecutionTypes, PROMPTBOOK_VERSION };
-export { addPromptResultUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prettifyPromptbookString, usageToWorktime, };
 export { createPromptbookLibraryFromDirectory, createPromptbookLibraryFromSources, createPromptbookLibraryFromUrl, createPromptbookSublibrary, SimplePromptbookLibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookJsonToString, promptbookStringToJson, validatePromptbookJson };

package/umd/typings/execution/PromptbookExecutor.d.ts

@@ -2,6 +2,7 @@ import type { Promisable } from 'type-fest';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { string_name } from '../types/typeAliases';
+import type { PromptResultUsage } from './PromptResult';
 /**
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
  * Executor is made by combining execution tools and promptbook library.
@@ -13,15 +14,19 @@ import type { string_name } from '../types/typeAliases';
 export type PromptbookExecutor = {
     (inputParameters: Record<string_name, string>, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<{
         /**
-         * Whether the execution was successful
+         * Whether the execution was successful, details are aviable in `executionReport`
          */
         isSuccessful: boolean;
         /**
-         * Errors that occured during the execution
+         * Added usage of whole execution, detailed usage is aviable in `executionReport`
+         */
+        usage: PromptResultUsage;
+        /**
+         * Errors that occured during the execution, details are aviable in `executionReport`
          */
         errors: Array<Error>;
         /**
-         * The report of the execution
+         * The report of the execution with all details
          */
         executionReport: ExecutionReportJson;
         /**

package/umd/typings/execution/utils/addUsage.d.ts

@@ -0,0 +1,7 @@
+import type { PromptResultUsage } from '../PromptResult';
+/**
+ * Function `addUsage` will add multiple usages into one
+ *
+ * Note: If you provide 0 values, it returns void usage
+ */
+export declare function addUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/umd/typings/execution/utils/addUsage.test.d.ts

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

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

@@ -1,4 +1,4 @@
-import type { PromptResultUsageCounts } from './PromptResult';
+import type { PromptResultUsageCounts } from '../PromptResult';
 /**
  * Helper of usage compute
  *

package/umd/typings/execution/utils/uncertainNumber.d.ts

@@ -0,0 +1,9 @@
+import type { UncertainNumber } from '../PromptResult';
+/**
+ * Make UncertainNumber
+ *
+ * @param value
+ *
+ * @private utility for initializating UncertainNumber
+ */
+export declare function uncertainNumber(value?: number | typeof NaN | undefined | null): UncertainNumber;

package/umd/typings/execution/utils/usageToWorktime.d.ts

@@ -0,0 +1,10 @@
+import type { PromptResultUsage } from '../PromptResult';
+import type { UncertainNumber } from '../PromptResult';
+/**
+ * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
+ *
+ * Note: This is an estimate based of theese sources:
+ * - https://jecas.cz/doba-cteni
+ * - https://www.originalnitonery.cz/blog/psani-vsemi-deseti-se-muzete-naucit-i-sami-doma
+ */
+export declare function usageToWorktime(usage: PromptResultUsage): UncertainNumber;

package/umd/typings/execution/utils/usageToWorktime.test.d.ts

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

package/esm/typings/execution/addPromptResultUsage.d.ts

@@ -1,7 +0,0 @@
-import type { PromptResultUsage } from './PromptResult';
-/**
- * Function addPromptResultUsage will add multiple usages into one
- *
- * Note: If you provide 0 values, it returns void usage
- */
-export declare function addPromptResultUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;

package/umd/typings/execution/addPromptResultUsage.d.ts

@@ -1,7 +0,0 @@
-import type { PromptResultUsage } from './PromptResult';
-/**
- * Function addPromptResultUsage will add multiple usages into one
- *
- * Note: If you provide 0 values, it returns void usage
- */
-export declare function addPromptResultUsage(...usageItems: Array<PromptResultUsage>): PromptResultUsage;