@promptbook/utils 0.65.0 → 0.66.0-1

package/esm/typings/src/llm-providers/_common/config.d.ts

@@ -1,15 +1,10 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
-/**
- * @public exported from `@promptbook/core`
- */
-export declare const LLM_CONFIGURATION_BOILERPLATES: LlmToolsConfiguration;
 /**
  * @private internal type for `createLlmToolsFromConfiguration`
  */
 export declare const EXECUTION_TOOLS_CLASSES: Record<`create${string}`, (options: TODO_any) => LlmExecutionTools>;
 /**
- * TODO: [🧠] Better file name than `config.ts` + maybe move to two separate files
+ * TODO: !!!!!!! Make global register for this
  * TODO: [🧠][🎌] Adding this should be responsibility of each provider package NOT this one central place
  */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2024-05-25
+ * Note: Done at 2024-08-16
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`
@@ -19,5 +19,5 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
  * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
- * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🎰] Some mechanism to auto-update available models
  */

package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts

@@ -0,0 +1,18 @@
+import type Anthropic from '@anthropic-ai/sdk';
+import type { PartialDeep } from 'type-fest';
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Prompt } from '../../types/Prompt';
+/**
+ * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
+ *
+ * @param promptContent The content of the prompt
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
+ * @param rawResponse The raw response from Anthropic Claude API
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from Anthropic Claude
+ * @private internal utility of `AnthropicClaudeExecutionTools`
+ */
+export declare function computeAnthropicClaudeUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
+resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): PromptResultUsage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

package/esm/typings/src/llm-providers/anthropic-claude/register1.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export declare const _: undefined;

package/esm/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts

@@ -3,6 +3,7 @@ import type { Expectations } from '../../types/PipelineJson/Expectations';
 /**
  * Gets the expectations and creates a fake text that meets the expectations
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Note: You can provide postprocessing functions to modify the text before checking the expectations
  *       The result will be the text BEFORE the postprocessing
  *

package/esm/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts

@@ -18,4 +18,4 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
 export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- */ 
+ */

package/esm/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts

@@ -1,4 +1,5 @@
 import type OpenAI from 'openai';
+import type { PartialDeep } from 'type-fest';
 import type { PromptResultUsage } from '../../execution/PromptResultUsage';
 import type { Prompt } from '../../types/Prompt';
 /**
@@ -11,4 +12,7 @@ import type { Prompt } from '../../types/Prompt';
  * @private internal utility of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
-resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;
+resultContent: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): PromptResultUsage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

package/esm/typings/src/llm-providers/openai/computeOpenaiUsage.test.d.ts

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -18,7 +18,8 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
 /**
  * Note: [🤖] Add models of new variant
  * TODO: [🧠] Some mechanism to propagate unsureness
- * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🎰][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
  * @see https://openai.com/api/pricing/

package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts

@@ -25,7 +25,7 @@ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**
      * If set, only these models will be listed as available
      *
-     * TODO: [🧠] !!!! Figure out better solution
+     * TODO: [🧠] !!!!!! Figure out better solution
      */
     readonly models?: Array<AvailableModel>;
     /**
@@ -51,3 +51,6 @@ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
      */
     readonly clientId: client_id;
 });
+/**
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */ 

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

@@ -2,6 +2,8 @@ import type { string_date_iso8601 } from '../types/typeAliases';
 /**
  * Simple wrapper `new Date().toISOString()`
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic because it depends on the current time
+ *
  * @returns string_date branded type
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/deepFreeze.d.ts

@@ -2,12 +2,13 @@ import type { ReadonlyDeep } from 'type-fest';
 /**
  * @@@
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
  * 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<TObject>;
+export declare function $deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
 /**
  * @@@
  * @@@

package/esm/typings/src/utils/environment/getGlobalScope.d.ts

@@ -0,0 +1,12 @@
+import type { really_any } from '../organization/really_any';
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it access global
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $getGlobalScope(): really_any;
+/***
+ * TODO: !!!!! Make private and promptbook registry from this
+ */ 

package/esm/typings/src/utils/environment/isRunningInBrowser.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const $isRunningInBrowser: Function;

package/esm/typings/src/utils/environment/isRunningInNode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Detects if the code is running in a Node.js environment
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const $isRunningInNode: Function;

package/esm/typings/src/utils/environment/isRunningInWebWorker.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Detects if the code is running in a web worker
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const $isRunningInWebWorker: Function;

package/esm/typings/src/utils/files/isDirectoryExisting.d.ts

@@ -2,9 +2,11 @@ import type { string_folder_path } from '../../types/typeAliases';
 /**
  * Checks if the directory exists
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
+ *
  * @private within the repository
  */
-export declare function isDirectoryExisting(directoryPath: string_folder_path): Promise<boolean>;
+export declare function $isDirectoryExisting(directoryPath: string_folder_path): Promise<boolean>;
 /**
  * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages

package/esm/typings/src/utils/files/isFileExisting.d.ts

@@ -2,9 +2,11 @@ import type { string_file_path } from '../../types/typeAliases';
 /**
  * Checks if the file exists
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
+ *
  * @private within the repository
  */
-export declare function isFileExisting(filePath: string_file_path): Promise<boolean>;
+export declare function $isFileExisting(filePath: string_file_path): Promise<boolean>;
 /**
  * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages

package/esm/typings/src/utils/files/listAllFiles.d.ts

@@ -3,12 +3,14 @@ import type { string_folder_path } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
+ *
  * @param path
  * @param isRecursive
  * @returns List of all files in the directory
  * @private internal function of `createCollectionFromDirectory`
  */
-export declare function listAllFiles(path: string_folder_path, isRecursive: boolean): Promise<Array<string_file_path>>;
+export declare function $listAllFiles(path: string_folder_path, isRecursive: boolean): Promise<Array<string_file_path>>;
 /**
  * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [🖇] What about symlinks?

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

@@ -2,6 +2,7 @@ import type { number_seed } from '../../types/typeAliases';
 /**
  * Generates random seed
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
  * Warning: This function is not cryptographically secure (it uses Math.random internally)
  * @public exported from `@promptbook/utils`
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.65.0",
+    "version": "0.66.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -12,7 +12,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.65.0-7';
+    var PROMPTBOOK_VERSION = '0.66.0-0';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -1121,6 +1121,8 @@
     /**
      * Simple wrapper `new Date().toISOString()`
      *
+     * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic because it depends on the current time
+     *
      * @returns string_date branded type
      * @public exported from `@promptbook/utils`
      */
@@ -1154,12 +1156,13 @@
     /**
      * @@@
      *
+     * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
      * 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`
      */
-    function deepFreeze(objectValue) {
+    function $deepFreeze(objectValue) {
         var e_1, _a;
         var propertyNames = Object.getOwnPropertyNames(objectValue);
         try {
@@ -1167,7 +1170,7 @@
                 var propertyName = propertyNames_1_1.value;
                 var value = objectValue[propertyName];
                 if (value && typeof value === 'object') {
-                    deepFreeze(value);
+                    $deepFreeze(value);
                 }
             }
         }
@@ -1184,6 +1187,47 @@
      * TODO: [🧠] Is there a way how to meaningfully test this utility
      */
 
+    /**
+     * @@@
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it access global
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function $getGlobalScope() {
+        return Function('return this')();
+    }
+    /***
+     * TODO: !!!!! Make private and promptbook registry from this
+     */
+
+    /**
+     * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var $isRunningInBrowser = new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
+
+    /**
+     * Detects if the code is running in a Node.js environment
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var $isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
+
+    /**
+     * Detects if the code is running in a web worker
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var $isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
+
     /**
      * Counts number of characters in the text
      *
@@ -1274,25 +1318,6 @@
         PAGES: countPages,
     };
 
-    /**
-     * Detects if the code is running in a browser environment in main thread (Not in a web worker)
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    var isRunningInBrowser = new Function("\n    try {\n        return this === window;\n    } catch (e) {\n        return false;\n    }\n");
-    /**
-     * Detects if the code is running in a Node.js environment
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    var isRunningInNode = new Function("\n    try {\n        return this === global;\n    } catch (e) {\n        return false;\n    }\n");
-    /**
-     * Detects if the code is running in a web worker
-     *
-     * @public exported from `@promptbook/utils`
-     */
-    var isRunningInWebWorker = new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
-
     /**
      * Makes first letter of a string uppercase
      *
@@ -1608,6 +1633,7 @@
     /**
      * Generates random seed
      *
+     * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
      * Warning: This function is not cryptographically secure (it uses Math.random internally)
      * @public exported from `@promptbook/utils`
      */
@@ -1656,7 +1682,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    deepFreeze([
+    $deepFreeze([
         'content',
         'context',
         'knowledge',
@@ -1678,6 +1704,9 @@
      * @private within the repository
      */
     var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+    /**
+     * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+     */
 
     /**
      * This error type indicates that some limit was reached
@@ -2230,6 +2259,11 @@
     }
 
     exports.$currentDate = $currentDate;
+    exports.$deepFreeze = $deepFreeze;
+    exports.$getGlobalScope = $getGlobalScope;
+    exports.$isRunningInBrowser = $isRunningInBrowser;
+    exports.$isRunningInNode = $isRunningInNode;
+    exports.$isRunningInWebWorker = $isRunningInWebWorker;
     exports.$randomSeed = $randomSeed;
     exports.CountUtils = CountUtils;
     exports.DIACRITIC_VARIANTS_LETTERS = DIACRITIC_VARIANTS_LETTERS;
@@ -2244,7 +2278,6 @@
     exports.countWords = countWords;
     exports.decapitalize = decapitalize;
     exports.deepClone = deepClone;
-    exports.deepFreeze = deepFreeze;
     exports.difference = difference;
     exports.extractBlock = extractBlock;
     exports.extractParameterNames = extractParameterNames;
@@ -2253,9 +2286,6 @@
     exports.forEachAsync = forEachAsync;
     exports.intersection = intersection;
     exports.isHostnameOnPrivateNetwork = isHostnameOnPrivateNetwork;
-    exports.isRunningInBrowser = isRunningInBrowser;
-    exports.isRunningInNode = isRunningInNode;
-    exports.isRunningInWebWorker = isRunningInWebWorker;
     exports.isUrlOnPrivateNetwork = isUrlOnPrivateNetwork;
     exports.isValidEmail = isValidEmail;
     exports.isValidFilePath = isValidFilePath;