@promptbook/markdown-utils 0.76.0 → 0.77.0-3

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

@@ -4,6 +4,8 @@ import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic
 import { _AnthropicClaudeRegistration } from '../llm-providers/anthropic-claude/register-constructor';
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
 import { _AzureOpenAiRegistration } from '../llm-providers/azure-openai/register-constructor';
+import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
+import { _GoogleRegistration } from '../llm-providers/google/register-constructor';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
 import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
@@ -24,6 +26,8 @@ export { _AnthropicClaudeMetadataRegistration };
 export { _AnthropicClaudeRegistration };
 export { _AzureOpenAiMetadataRegistration };
 export { _AzureOpenAiRegistration };
+export { _GoogleMetadataRegistration };
+export { _GoogleRegistration };
 export { _OpenAiMetadataRegistration };
 export { _OpenAiAssistantMetadataRegistration };
 export { _OpenAiRegistration };

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

@@ -82,6 +82,7 @@ import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usag
 import { limitTotalUsage } from '../llm-providers/_common/utils/count-total-usage/limitTotalUsage';
 import { _AnthropicClaudeMetadataRegistration } from '../llm-providers/anthropic-claude/register-configuration';
 import { _AzureOpenAiMetadataRegistration } from '../llm-providers/azure-openai/register-configuration';
+import { _GoogleMetadataRegistration } from '../llm-providers/google/register-configuration';
 import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
 import { MultipleLlmExecutionTools } from '../llm-providers/multiple/MultipleLlmExecutionTools';
 import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
@@ -196,6 +197,7 @@ export { countTotalUsage };
 export { limitTotalUsage };
 export { _AnthropicClaudeMetadataRegistration };
 export { _AzureOpenAiMetadataRegistration };
+export { _GoogleMetadataRegistration };
 export { joinLlmExecutionTools };
 export { MultipleLlmExecutionTools };
 export { _OpenAiMetadataRegistration };

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

@@ -0,0 +1,10 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { createGoogleExecutionTools } from '../llm-providers/google/createGoogleExecutionTools';
+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 type { GoogleExecutionToolsOptions };
+export { _GoogleRegistration };
+export type { VercelExecutionToolsOptions };

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

@@ -55,6 +55,7 @@ import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anth
 import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
+import type { GoogleExecutionToolsOptions } from '../llm-providers/google/GoogleExecutionToolsOptions';
 import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
 import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
 import type { PromptbookServer_Error } from '../llm-providers/remote/interfaces/PromptbookServer_Error';
@@ -72,6 +73,8 @@ import type { RemoteServerOptions } from '../llm-providers/remote/interfaces/Rem
 import type { AnonymousRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import type { CollectionRemoteServerOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
 import type { CollectionRemoteServerClientOptions } from '../llm-providers/remote/interfaces/RemoteServerOptions';
+import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
+import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
 import type { IsPipelineImplementingInterfaceOptions } from '../pipeline/PipelineInterface/isPipelineImplementingInterface';
 import type { PipelineInterface } from '../pipeline/PipelineInterface/PipelineInterface';
 import type { CommonTaskJson } from '../pipeline/PipelineJson/CommonTaskJson';
@@ -309,6 +312,7 @@ export type { AnthropicClaudeExecutionToolsOptions };
 export type { AnthropicClaudeExecutionToolsDirectOptions };
 export type { AnthropicClaudeExecutionToolsProxiedOptions };
 export type { AzureOpenAiExecutionToolsOptions };
+export type { GoogleExecutionToolsOptions };
 export type { OpenAiAssistantExecutionToolsOptions };
 export type { OpenAiExecutionToolsOptions };
 export type { PromptbookServer_Error };
@@ -326,6 +330,8 @@ export type { RemoteServerOptions };
 export type { AnonymousRemoteServerOptions };
 export type { CollectionRemoteServerOptions };
 export type { CollectionRemoteServerClientOptions };
+export type { VercelExecutionToolsOptions };
+export type { VercelProvider };
 export type { IsPipelineImplementingInterfaceOptions };
 export type { PipelineInterface };
 export type { CommonTaskJson };

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

@@ -8,7 +8,7 @@ import { deserializeError } from '../errors/utils/deserializeError';
 import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
-import { $currentDate } from '../utils/$currentDate';
+import { $getCurrentDate } from '../utils/$getCurrentDate';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
 import { $isRunningInWebWorker } from '../utils/environment/$isRunningInWebWorker';
@@ -82,7 +82,7 @@ export { deserializeError };
 export { serializeError };
 export { forEachAsync };
 export { isValidJsonString };
-export { $currentDate };
+export { $getCurrentDate };
 export { $isRunningInBrowser };
 export { $isRunningInNode };
 export { $isRunningInWebWorker };

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

@@ -1,2 +1,6 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { createExecutionToolsFromVercelProvider } from '../llm-providers/vercel/createExecutionToolsFromVercelProvider';
+import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { createExecutionToolsFromVercelProvider };
+export type { VercelProvider };

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

@@ -8,7 +8,7 @@ export type AvailableModel = {
     /**
      * The model title
      */
-    readonly modelTitle: string_title;
+    readonly modelTitle?: string_title;
     /**
      * The model name aviailable
      */
@@ -18,3 +18,7 @@ export type AvailableModel = {
      */
     readonly modelVariant: ModelVariant;
 };
+/**
+ * TODO: !!!!!! Maybe remove `modelTitle`
+ * TODO: !!!!!! Put pricing information here
+ */

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

@@ -1,15 +1,24 @@
+import type { string_user_id } from '../types/typeAliases';
 /**
  * @@@
  *
  * Note: Keep it public to allow people to make their own execution tools
  */
 export type CommonToolsOptions = {
+    /**
+     * A unique identifier representing your end-user
+     *
+     * Note: For example it can help to detect abuse
+     * For example for OpenAi @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
+     */
+    readonly userId?: string_user_id;
     /**
      * If true, the internal executions will be logged
      */
     readonly isVerbose?: boolean;
 };
 /**
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
  * TODO: [🈁] Maybe add here `isDeterministic`
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */

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

@@ -18,7 +18,7 @@ export type CreateLlmToolsFromConfigurationOptions = {
      *
      * Note: This is passed to the LLM tools providers to identify misuse
      */
-    readonly userId?: string_user_id | null;
+    readonly userId?: string_user_id;
 };
 /**
  * @@@

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

@@ -33,5 +33,5 @@ export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
      *
      * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids (document from OpenAI not Azure, but same concept)
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
 };

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

@@ -0,0 +1,12 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+/**
+ * Options for `GoogleExecutionTools`
+ *
+ * !!!!!! This extends Google's `ClientOptions` with are directly passed to the Google generative AI client.
+ * @public exported from `@promptbook/google`
+ */
+export type GoogleExecutionToolsOptions = CommonToolsOptions & Parameters<typeof createGoogleGenerativeAI>[0];
+/**
+ * TODO: [🧠][🤺] Pass `userId`
+ */

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

@@ -0,0 +1,18 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { GoogleExecutionToolsOptions } from './GoogleExecutionToolsOptions';
+/**
+ * Execution Tools for calling Google Gemini API.
+ *
+ * @public exported from `@promptbook/google`
+ */
+export declare const createGoogleExecutionTools: ((options: GoogleExecutionToolsOptions) => LlmExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!!! Maybe change all `new GoogleExecutionTools` -> `createGoogleExecutionTools` in manual
+ * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

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

@@ -0,0 +1,13 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider metadata
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _GoogleMetadataRegistration: Registration;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,14 @@
+import type { Registration } from '../../utils/$Register';
+/**
+ * Registration of LLM provider
+ *
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
+ *
+ * @public exported from `@promptbook/google`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _GoogleRegistration: Registration;
+/**
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -1,6 +1,5 @@
 import type { ClientOptions } from 'openai';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
-import type { string_user_id } from '../../types/typeAliases';
 /**
  * Options for `OpenAiExecutionTools`
  *
@@ -9,12 +8,4 @@ import type { string_user_id } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/openai`
  */
-export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions & {
-    /**
-     * A unique identifier representing your end-user, which can help OpenAI to monitor
-     * and detect abuse.
-     *
-     * @see https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids
-     */
-    userId: string_user_id | null;
-};
+export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions;

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

@@ -24,7 +24,7 @@ export type PromptbookServer_ListModels_AnonymousRequest = {
      * Note: this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
     /**
      * Configuration for the LLM tools
      */

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

@@ -29,7 +29,7 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
      * Note: this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
     /**
      * Configuration for the LLM tools
      */

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

@@ -41,7 +41,7 @@ export type RemoteLlmExecutionToolsOptions<TCustomOptions> = CommonToolsOptions
      * Note: This is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode).
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
 } | ({
     /**
      * Use anonymous server with client identification and fixed collection

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

@@ -62,7 +62,7 @@ export type CollectionRemoteServerClientOptions<TCustomOptions> = {
     /**
      * @@@
      */
-    readonly userId: string_user_id | null;
+    readonly userId?: string_user_id;
     /**
      * @@@
      */

package/esm/typings/src/llm-providers/vercel/VercelExecutionToolsOptions.d.ts

@@ -0,0 +1,22 @@
+import type { AvailableModel } from '../../execution/AvailableModel';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { VercelProvider } from './VercelProvider';
+/**
+ * Options for `createExecutionToolsFromVercelProvider`
+ *
+ * @public exported from `@promptbook/google`
+ */
+export type VercelExecutionToolsOptions = CommonToolsOptions & {
+    /**
+     * Vercel provider for the execution tools
+     */
+    readonly vercelProvider: VercelProvider;
+    /**
+     * List of available models for given Vercel provider
+     */
+    readonly availableModels: ReadonlyArray<AvailableModel>;
+    /**
+     * Additional settings for chat models when calling `vercelProvider.chat('model-name', settings)`
+     */
+    readonly additionalChatSettings?: Partial<Parameters<VercelProvider['chat']>[1]>;
+};

package/esm/typings/src/llm-providers/vercel/VercelProvider.d.ts

@@ -0,0 +1,13 @@
+import type { createGoogleGenerativeAI } from '@ai-sdk/google';
+import type { createOpenAI } from '@ai-sdk/openai';
+/**
+ * This is common interface for all v1 Vercel providers
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export type VercelProvider = ReturnType<typeof createOpenAI> | ReturnType<typeof createGoogleGenerativeAI>;
+/**
+ * ^^^^
+ * TODO: Is there some way to get the type of the provider directly,
+ *       NOT this stupid way via inferring the return type from a specific vercel provider⁉
+ */

package/esm/typings/src/llm-providers/vercel/createExecutionToolsFromVercelProvider.d.ts

@@ -0,0 +1,8 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { VercelExecutionToolsOptions } from './VercelExecutionToolsOptions';
+/**
+ * !!!!!!
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export declare function createExecutionToolsFromVercelProvider(options: VercelExecutionToolsOptions): LlmExecutionTools;

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/utils/{$currentDate.d.ts → $getCurrentDate.d.ts}

@@ -7,4 +7,4 @@ import type { string_date_iso8601 } from '../types/typeAliases';
  * @returns string_date branded type
  * @public exported from `@promptbook/utils`
  */
-export declare function $currentDate(): string_date_iso8601;
+export declare function $getCurrentDate(): string_date_iso8601;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.76.0",
+    "version": "0.77.0-3",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.75.10';
+    var PROMPTBOOK_ENGINE_VERSION = '0.77.0-2';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3684,7 +3684,7 @@
                         llmToolsWithUsage = countTotalUsage(llmTools);
                         currentPreparation = {
                             id: 1,
-                            // TODO: [🍥]> date: $currentDate(),
+                            // TODO: [🍥]> date: $getCurrentDate(),
                             promptbookVersion: PROMPTBOOK_ENGINE_VERSION,
                             usage: ZERO_USAGE,
                         };