@promptbook/node 0.89.0 → 0.92.0-10

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

@@ -87,9 +87,12 @@ import { FORMFACTOR_DEFINITIONS } from '../formfactors/index';
 import { MatcherFormfactorDefinition } from '../formfactors/matcher/MatcherFormfactorDefinition';
 import { SheetsFormfactorDefinition } from '../formfactors/sheets/SheetsFormfactorDefinition';
 import { TranslatorFormfactorDefinition } from '../formfactors/translator/TranslatorFormfactorDefinition';
+import { filterModels } from '../llm-providers/_common/filterModels';
 import { $llmToolsMetadataRegister } from '../llm-providers/_common/register/$llmToolsMetadataRegister';
 import { $llmToolsRegister } from '../llm-providers/_common/register/$llmToolsRegister';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/register/createLlmToolsFromConfiguration';
+import { MODEL_TRUST_LEVEL } from '../llm-providers/_common/register/LlmToolsMetadata';
+import { MODEL_ORDER } from '../llm-providers/_common/register/LlmToolsMetadata';
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
 import { countUsage } from '../llm-providers/_common/utils/count-total-usage/countUsage';
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
@@ -225,9 +228,12 @@ export { FORMFACTOR_DEFINITIONS };
 export { MatcherFormfactorDefinition };
 export { SheetsFormfactorDefinition };
 export { TranslatorFormfactorDefinition };
+export { filterModels };
 export { $llmToolsMetadataRegister };
 export { $llmToolsRegister };
 export { createLlmToolsFromConfiguration };
+export { MODEL_TRUST_LEVEL };
+export { MODEL_ORDER };
 export { cacheLlmTools };
 export { countUsage };
 export { limitTotalUsage };

package/esm/typings/src/_packages/deepseek.index.d.ts

@@ -1,8 +1,10 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createDeepseekExecutionTools } from '../llm-providers/deepseek/createDeepseekExecutionTools';
+import { DEEPSEEK_MODELS } from '../llm-providers/deepseek/deepseek-models';
 import type { DeepseekExecutionToolsOptions } from '../llm-providers/deepseek/DeepseekExecutionToolsOptions';
 import { _DeepseekRegistration } from '../llm-providers/deepseek/register-constructor';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createDeepseekExecutionTools };
+export { DEEPSEEK_MODELS };
 export type { DeepseekExecutionToolsOptions };
 export { _DeepseekRegistration };

package/esm/typings/src/_packages/google.index.d.ts

@@ -1,10 +1,12 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { createGoogleExecutionTools } from '../llm-providers/google/createGoogleExecutionTools';
+import { GOOGLE_MODELS } from '../llm-providers/google/google-models';
 import type { GoogleExecutionToolsOptions } from '../llm-providers/google/GoogleExecutionToolsOptions';
 import { _GoogleRegistration } from '../llm-providers/google/register-constructor';
 import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { createGoogleExecutionTools };
+export { GOOGLE_MODELS };
 export type { GoogleExecutionToolsOptions };
 export { _GoogleRegistration };
 export type { VercelExecutionToolsOptions };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -7,6 +7,7 @@ import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { jsonParse } from '../formats/json/utils/jsonParse';
 import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
@@ -91,6 +92,7 @@ export { serializeError };
 export { forEachAsync };
 export { isValidCsvString };
 export { isValidJsonString };
+export { jsonParse };
 export { isValidXmlString };
 export { prompt };
 export { promptTemplate };

package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts

@@ -1,5 +1,5 @@
-import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
+import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { string_promptbook_server_url } from '../../types/typeAliases';
 type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
     /**

package/esm/typings/src/conversion/archive/loadArchive.d.ts

@@ -1,6 +1,6 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { string_filename } from '../../types/typeAliases';
-import type { FilesystemTools } from '../../execution/FilesystemTools';
 /**
  * Loads the books from the archive file with `.bookc` extension
  *
@@ -10,7 +10,7 @@ import type { FilesystemTools } from '../../execution/FilesystemTools';
  *
  * @private utility of Prompbook
  */
-export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<Array<PipelineJson>>;
+export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/execution/CommonToolsOptions.d.ts

@@ -16,6 +16,10 @@ export type CommonToolsOptions = {
      * If true, the internal executions will be logged
      */
     readonly isVerbose?: boolean;
+    /**
+    * Maximum number of requests per minute
+    */
+    readonly maxRequestsPerMinute?: number;
 };
 /**
  * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt

package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts

@@ -3,12 +3,17 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
  * @@@
  *
  * @private internal type of `getKnowledgeFoTask`
  */
 type GetKnowledgeForTaskOptions = {
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
     /**
      * @@@
      */
@@ -21,7 +26,14 @@ type GetKnowledgeForTaskOptions = {
 /**
  * @@@
  *
+ * Here is the place where RAG (retrieval-augmented generation) happens
+ *
  * @private internal utility of `createPipelineExecutor`
  */
 export declare function getKnowledgeForTask(options: GetKnowledgeForTaskOptions): Promise<string_parameter_value & string_markdown>;
 export {};
+/**
+ * TODO: !!!! Verify if this is working
+ * TODO: [♨] Implement Better - use keyword search
+ * TODO: [♨] Examples of values
+ */

package/esm/typings/src/execution/createPipelineExecutor/getReservedParametersForTask.d.ts

@@ -2,12 +2,17 @@ import type { ReadonlyDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { ReservedParameters } from '../../types/typeAliases';
+import type { ExecutionTools } from '../ExecutionTools';
 /**
  * @@@
  *
  * @private internal type of `getReservedParametersForTask`
  */
 type GetReservedParametersForTaskOptions = {
+    /**
+     * The execution tools to be used during the execution of the pipeline
+     */
+    readonly tools: ExecutionTools;
     /**
      * @@@
      */

package/esm/typings/src/formats/csv/utils/csvParse.d.ts

@@ -0,0 +1,12 @@
+import type { ParseResult } from 'papaparse';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { Parameters } from '../../../types/typeAliases';
+import type { CsvSettings } from '../CsvSettings';
+/**
+ * Converts a CSV string into an object
+ *
+ * Note: This is wrapper around `papaparse.parse()` with better autohealing
+ *
+ * @private - for now until `@promptbook/csv` is released
+ */
+export declare function csvParse(value: string, settings?: CsvSettings, schema?: TODO_any): ParseResult<Parameters>;

package/esm/typings/src/formats/json/utils/jsonParse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Converts a JavaScript Object Notation (JSON) string into an object.
+ *
+ * Note: This is wrapper around `JSON.parse()` with better error and type handling
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function jsonParse<T>(value: string): T;
+/**
+ * TODO: !!!! Use in Promptbook.studio
+ */

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

@@ -0,0 +1,15 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+/**
+ * Creates a wrapper around LlmExecutionTools that only exposes models matching the filter function
+ *
+ * @param llmTools The original LLM execution tools to wrap
+ * @param modelFilter Function that determines whether a model should be included
+ * @returns A new LlmExecutionTools instance with filtered models
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function filterModels<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, modelFilter: (model: AvailableModel) => boolean): TLlmTools;
+/**
+ * TODO: !!! [models] Test that this is working
+ */

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

@@ -3,6 +3,41 @@ import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
+/**
+ * How is the model provider trusted?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_TRUST_LEVEL: {
+    readonly FULL: "Model is running on the local machine, training data and model weights are known, data are ethically sourced";
+    readonly OPEN: "Model is open source, training data and model weights are known";
+    readonly PARTIALLY_OPEN: "Model is open source, but training data and model weights are not (fully) known";
+    readonly CLOSED_LOCAL: "Model can be run locally, but it is not open source";
+    readonly CLOSED_FREE: "Model is behind API gateway but free to use";
+    readonly CLOSED_BUSINESS: "Model is behind API gateway and paid but has good SLA, TOS, privacy policy and in general is a good to use in business applications";
+    readonly CLOSED: "Model is behind API gateway and paid";
+    readonly UNTRUSTED: "Model has questions about the training data and ethics, but it is not known if it is a problem or not";
+    readonly VURNABLE: "Model has some known serious vulnerabilities, leaks, ethical problems, etc.";
+};
+/**
+ * How is the model provider important?
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const MODEL_ORDER: {
+    /**
+     * Top-tier models, e.g. OpenAI, Anthropic,...
+     */
+    readonly TOP_TIER: 333;
+    /**
+     * Mid-tier models, e.g. Llama, Mistral, etc.
+     */
+    readonly NORMAL: 100;
+    /**
+     * Low-tier models, e.g. Phi, Tiny, etc.
+     */
+    readonly LOW_TIER: 0;
+};
 /**
  * @@@
  *
@@ -13,6 +48,14 @@ export type LlmToolsMetadata = Registered & {
      * @@@
      */
     readonly title: string_title;
+    /**
+     * How is the model is trusted?
+     */
+    readonly trustLevel: keyof typeof MODEL_TRUST_LEVEL;
+    /**
+     * How is the model provider important and should be sorted in the list of available providers?
+     */
+    readonly order: typeof MODEL_ORDER[keyof typeof MODEL_ORDER] | number;
     /**
      * List of environment variables that can be used to configure the provider
      *

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

@@ -19,6 +19,10 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
      * OpenAI Azure API client.
      */
     private client;
+    /**
+     * Rate limiter instance
+     */
+    private limiter;
     /**
      * Creates OpenAI Execution Tools.
      *

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

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Deepseek models with descriptions
+ *
+ * Note: Done at 2025-04-22
+ *
+ * @see https://www.deepseek.com/models
+ * @public exported from `@promptbook/deepseek`
+ */
+export declare const DEEPSEEK_MODELS: ReadonlyArray<AvailableModel & {
+    modelDescription?: string;
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Add information about context window sizes, capabilities, and relative performance characteristics
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🧠] Verify pricing information is current with Deepseek's official documentation
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,23 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { number_usd } from '../../types/typeAliases';
+/**
+ * List of available Google models with descriptions
+ *
+ * Note: Done at 2025-04-22
+ *
+ * @see https://ai.google.dev/models/gemini
+ * @public exported from `@promptbook/google`
+ */
+export declare const GOOGLE_MODELS: ReadonlyArray<AvailableModel & {
+    modelDescription?: string;
+    pricing?: {
+        readonly prompt: number_usd;
+        readonly output: number_usd;
+    };
+}>;
+/**
+ * TODO: [🧠] Add information about context window sizes, capabilities, and relative performance characteristics
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🧠] Verify pricing information is current with Google's official documentation
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -20,6 +20,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * OpenAI API client.
      */
     private client;
+    /**
+     * Rate limiter instance
+     */
+    private limiter;
     /**
      * Creates OpenAI Execution Tools.
      *

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

@@ -8,7 +8,7 @@ import type { string_persona_description } from '../types/typeAliases';
  * @see https://github.com/webgptorg/promptbook/discussions/22
  * @public exported from `@promptbook/core`
  */
-export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
+export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<Pick<PersonaPreparedJson, 'modelsRequirements'>>;
 /**
  * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
  * TODO: [🏢] Check validity of `modelName` in pipeline

package/esm/typings/src/pipeline/PipelineJson/PersonaJson.d.ts

@@ -30,11 +30,13 @@ export type PersonaJson = {
  */
 export type PersonaPreparedJson = PersonaJson & {
     /**
-     * Model requirements for the persona
+     * Models requirements for the persona
+     *
+     * Sorted by relevance, best-fitting models is first
      *
      * Note: The model must be CHAT variant to be usable through persona
      */
-    readonly modelRequirements: ChatModelRequirements;
+    readonly modelsRequirements: Array<ChatModelRequirements>;
     /**
      * List of preparation ids that were used to prepare this persona
      */