@promptbook/pdf 0.75.10 → 0.77.0-0

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/pdf`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -238,6 +242,8 @@ Or you can install them separately:
 -   **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
 -   **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
 -   **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK 
+-   **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
+-   **[@promptbook/gemini](https://www.npmjs.com/package/@promptbook/gemini)** - Integration with Google's Gemini API
 -   **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
 -   **[@promptbook/langtail](https://www.npmjs.com/package/@promptbook/langtail)** - Execution tools for Langtail API, wrapper around Langtail SDK
 -   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
@@ -257,11 +263,6 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-
-
-
-
-
 ### 📚 Dictionary
 
 The following glossary is used to clarify certain concepts:
@@ -277,8 +278,6 @@ The following glossary is used to clarify certain concepts:
 -   **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
 -   **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
 
-
-
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
 #### Promptbook core
@@ -339,8 +338,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
 -   [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
 
-
-
 ### Terms specific to Promptbook TypeScript implementation
 
 -   Anonymous mode

package/esm/index.es.js

@@ -20,7 +20,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.75.9';
+var PROMPTBOOK_ENGINE_VERSION = '0.76.0';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3500,7 +3500,7 @@ function preparePipeline(pipeline, tools, options) {
                     llmToolsWithUsage = countTotalUsage(llmTools);
                     currentPreparation = {
                         id: 1,
-                        // TODO: [🍥]> date: $currentDate(),
+                        // TODO: [🍥]> date: $getCurrentDate(),
                         promptbookVersion: PROMPTBOOK_ENGINE_VERSION,
                         usage: ZERO_USAGE,
                     };

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

@@ -0,0 +1,2 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };

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

@@ -0,0 +1,4 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { createExecutionToolsFromVercelProvider } from '../llm-providers/vercel/createExecutionToolsFromVercelProvider';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { createExecutionToolsFromVercelProvider };

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/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/createExecutionToolsFromVercelProvider.d.ts

@@ -0,0 +1,11 @@
+import type { createOpenAI } from '@ai-sdk/openai';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+type ProviderV1 = ReturnType<typeof createOpenAI>;
+/**
+ * !!!!!!
+ *
+ * @public exported from `@promptbook/vercel`
+ */
+export declare function createExecutionToolsFromVercelProvider(vercelProvider: ProviderV1, options?: CommonToolsOptions): LlmExecutionTools;
+export {};

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/pdf",
-    "version": "0.75.10",
+    "version": "0.77.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/pdf.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.75.10"
+        "@promptbook/core": "0.77.0-0"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

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

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

@@ -1,7 +0,0 @@
-import type { string_date_iso8601 } from '../types/typeAliases';
-/**
- * Get current date in ISO 8601 format
- *
- * @private internal utility
- */
-export declare function getCurrentIsoDate(): string_date_iso8601;