@promptbook/types 0.77.0-0 → 0.77.0-3

package/README.md

@@ -266,7 +266,7 @@ Or you can install them separately:
 -   **[@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/google](https://www.npmjs.com/package/@promptbook/google)** - 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

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

@@ -1,4 +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/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/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

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.77.0-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,
@@ -52,6 +52,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.77.0-0"
+        "@promptbook/core": "0.77.0-3"
     }
 }

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

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