@promptbook/openai 0.88.0 → 0.89.0-11

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

@@ -1,11 +1,46 @@
+import { Promisable } from 'type-fest';
+import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
+import type { string_app_id } from '../../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
+import type { really_any } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
+    /**
+     * Use local keys and execute LLMs directly
+     */
+    readonly strategy: 'BRING_YOUR_OWN_KEYS';
+} | {
+    /**
+     * Do not use local keys but login to Promptbook server and execute LLMs there
+     */
+    readonly strategy: 'REMOTE_SERVER';
+    /**
+     * URL of the remote server
+     *
+     * @default `DEFAULT_REMOTE_SERVER_URL`
+     */
+    readonly remoteServerUrl?: string_url;
+    /**
+     * Identifier of the application which will be passed to the remote server identification
+     *
+     * Note: This can be some id or some semantic name like "email-agent"
+     */
+    readonly appId: string_app_id;
+    /**
+     *
+     */
+    loginPrompt(): Promisable<Identification<really_any>>;
+});
 /**
  * Returns LLM tools for CLI
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes this .env file
+ *
  * @private within the repository - for CLI utils
  */
-export declare function $provideLlmToolsForWizzardOrCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): Promise<LlmExecutionToolsWithTotalUsage>;
+export declare function $provideLlmToolsForWizzardOrCli(options?: ProvideLlmToolsForWizzardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
+export {};
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

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

@@ -6,6 +6,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
  * @@@ .env
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * It looks for environment variables:
  * - `process.env.OPENAI_API_KEY`

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -1,5 +1,6 @@
+import type { Observable } from 'rxjs';
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { Usage } from '../../../../execution/Usage';
 /**
  * LLM tools with option to get total usage of the execution
  */
@@ -7,7 +8,13 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
     /**
      * Get total cost of the execution up to this point
      */
-    getTotalUsage(): PromptResultUsage;
+    getTotalUsage(): Usage;
+    /**
+     * Observable of total cost of the execution up to this point
+     *
+     * Note: This does report the cost of the last prompt, not the total cost of the execution up to this point
+     */
+    spending(): Observable<Usage>;
 };
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/{countTotalUsage.d.ts → countUsage.d.ts}

@@ -7,7 +7,7 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  * @returns LLM tools with same functionality with added total cost counting
  * @public exported from `@promptbook/core`
  */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts

@@ -1,5 +1,5 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { Usage } from '../../../../execution/Usage';
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { TODO_any } from '../../../../utils/organization/TODO_any';
 import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
@@ -12,7 +12,7 @@ type LimitTotalUsageOptions = {
      *
      * @default ZERO_USAGE
      */
-    maxTotalUsage: PromptResultUsage;
+    maxTotalUsage: Usage;
     /**
      * @@@
      *

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

@@ -25,7 +25,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & Cl
  */
 export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied: true;
-} & Pick<RemoteClientOptions<undefined>, 'remoteUrl' | 'path'>;
+} & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;
 /**
  * TODO: [🧠][🤺] Pass `userId`
  */

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

@@ -1,6 +1,6 @@
 import type Anthropic from '@anthropic-ai/sdk';
 import type { PartialDeep } from 'type-fest';
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
@@ -12,7 +12,7 @@ import type { Prompt } from '../../types/Prompt';
  * @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;
+resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): Usage;
 /**
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */

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

@@ -11,4 +11,4 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AnthropicClaudeMetadataRegistration: Registration;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

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

@@ -8,8 +8,6 @@ import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
-import type { string_token } from '../../types/typeAliases';
-import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API
@@ -31,13 +29,6 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     getClient(): Promise<OpenAI>;
-    /**
-     * Create (sub)tools for calling OpenAI API Assistants
-     *
-     * @param assistantId Which assistant to use
-     * @returns Tools for calling OpenAI API Assistants with same token
-     */
-    createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
     /**
      * Check the `options` passed to `constructor`
      */

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

@@ -1,6 +1,6 @@
 import type OpenAI from 'openai';
 import type { PartialDeep } from 'type-fest';
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
@@ -12,7 +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: PartialDeep<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'>>): Usage;
 /**
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */

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

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { number_id } from '../../types/typeAliases';
 import type { string_promptbook_version } from '../../version';
 export type PreparationJson = {
@@ -13,7 +13,7 @@ export type PreparationJson = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: PromptResultUsage;
+    readonly usage: Usage;
 };
 /**
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/playground/playground.d.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/remote-server/RemoteServer.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import type { IDestroyable } from 'destroyable';
+import express from 'express';
+import http from 'http';
+import { DefaultEventsMap, Server } from 'socket.io';
+import type { TODO_any } from '../utils/organization/TODO_any';
+import type { TODO_narrow } from '../utils/organization/TODO_narrow';
+export type RemoteServer = IDestroyable & {
+    /**
+     * HTTP server instance
+     */
+    readonly httpServer: http.Server<TODO_any>;
+    /**
+     * Express application instance
+     *
+     * Note: This is useful for adding custom routes
+     */
+    readonly expressApp: express.Express;
+    /**
+     * Socket.io server instance
+     */
+    readonly socketIoServer: Server<TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_any>;
+};

package/esm/typings/src/remote-server/socket-types/_subtypes/{PromptbookServer_Identification.d.ts → Identification.d.ts}

@@ -7,14 +7,14 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
+export type Identification<TCustomOptions> = ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification;
 /**
  * Application mode is situation when you run known and well-defined books with your own api keys
  *
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type PromptbookServer_ApplicationIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
+export type ApplicationModeIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
     /**
      * Application mode
      */
@@ -29,7 +29,7 @@ export type PromptbookServer_ApplicationIdentification<TCustomOptions> = Applica
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type PromptbookServer_AnonymousIdentification = {
+export type AnonymousModeIdentification = {
     /**
      * Anonymous mode
      */
@@ -37,7 +37,8 @@ export type PromptbookServer_AnonymousIdentification = {
     /**
      * Identifier of the end user
      *
-     * Note: this is passed to the certain model providers to identify misuse
+     * Note: This can be either some id or email or any other identifier
+     * Note: In anonymous mode, 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;

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../_subtypes/Identification';
 /**
  * List models available in the server
  *
@@ -10,7 +10,7 @@ export type PromptbookServer_ListModels_Request<TCustomOptions> = {
     /**
      * Identifier of the end user or application
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
 };
 /**
  * TODO: [🧠] Listing models inanonymous mode does not make sence - keeping only to preserve consistency

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts

@@ -1,5 +1,5 @@
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
-import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../_subtypes/Identification';
 /**
  * This is a request from client to server to prepare a pipeline
  *
@@ -9,7 +9,7 @@ export type PromptbookServer_PreparePipeline_Request<TCustomOptions> = {
     /**
      * Identifier of the end user or application
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
     /**
      * The Pipeline to prepare
      */

package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts

@@ -1,5 +1,5 @@
 import type { Prompt } from '../../../types/Prompt';
-import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../_subtypes/Identification';
 /**
  * This is a request from client to server to execute a prompt
  *
@@ -9,7 +9,7 @@ export type PromptbookServer_Prompt_Request<TCustomOptions> = {
     /**
      * Identifier of the end user or application
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
     /**
      * The Prompt to execute
      */

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -1,4 +1,4 @@
-import type { IDestroyable } from 'destroyable';
+import type { RemoteServer } from './RemoteServer';
 import type { RemoteServerOptions } from './types/RemoteServerOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
@@ -9,7 +9,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-server`
  */
-export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
+export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
  * TODO: !! Add CORS and security - probbably via `helmet`
  * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch

package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts

@@ -1,7 +1,6 @@
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { string_base_url } from '../../types/typeAliases';
-import type { string_uri } from '../../types/typeAliases';
-import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
  * Options for `RemoteLlmExecutionTools`
  *
@@ -12,21 +11,14 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
      * URL of the remote server
      * On this server will be connected to the socket.io server
      */
-    readonly remoteUrl: string_base_url;
-    /**
-     * Path for the Socket.io server to listen
-     *
-     * @default '/socket.io'
-     * @example '/promptbook/socket.io'
-     */
-    readonly path: string_uri;
+    readonly remoteServerUrl: string_base_url;
     /**
      * Identification of client for Socket.io remote server
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
 };
 /**
  * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
  */

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -1,10 +1,15 @@
+import type { Request, Response } from 'express';
 import type { Promisable } from 'type-fest';
 import type { PipelineCollection } from '../../collection/PipelineCollection';
+import { AuthenticationError } from '../../errors/AuthenticationError';
 import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { string_app_id } from '../../types/typeAliases';
+import type { string_email } from '../../types/typeAliases';
+import type { string_password } from '../../types/typeAliases';
 import type { string_uri } from '../../types/typeAliases';
 import type { string_user_id } from '../../types/typeAliases';
+import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
  * @@@
  *
@@ -16,7 +21,6 @@ import type { string_user_id } from '../../types/typeAliases';
  *
  * You can enable both modes at the same time.
  *
- * @public exported from `@promptbook/remote-client`
  * @public exported from `@promptbook/remote-server`
  */
 export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
@@ -32,8 +36,12 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @default '/'
      * @example '/api/promptbook/'
      */
-    readonly rootPath: string_uri;
-} & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+    readonly rootPath?: string_uri;
+} & ((AnonymousRemoteServerOptions & {
+    readonly isApplicationModeAllowed?: false;
+}) | ({
+    readonly isAnonymousModeAllowed?: false;
+} & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
@@ -51,6 +59,18 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
      * This is used to check validity of the prompt to prevent misuse
      */
     readonly collection: PipelineCollection;
+    /**
+     * User tries to login to the server, this function will be called verify the user and return the identification or throw an error
+     * This can be also doubled as a function to register the user
+     *
+     * Note: In most cases, you will return `PromptbookServer_ApplicationIdentification`
+     *       `PromptbookServer_AnonymousIdentification` is useful only in scenarios when user stores its own api keys on the application server and
+     *       server acts only as a api key provider
+     *
+     * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
+     * @throws `AuthenticationError`  if the user is not allowed to login for example because of invalid credentials
+     */
+    login(loginRequest: LoginRequest): Promise<LoginResponse<TCustomOptions>>;
     /**
      * Creates llm execution tools for each client
      */
@@ -58,18 +78,80 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
 };
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
-     * @@@
+     * Identifier of the application
+     *
+     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     * Note: This can be some id or some semantic name like "email-agent"
      */
     readonly appId: string_app_id | null;
     /**
-     * @@@
+     * Identifier of the end user
+     *
+     * Note: This can be either some id or email or any other identifier
+     * Note: This is also passed to the certain model providers to identify misuse
      */
     readonly userId?: string_user_id;
     /**
-     * @@@
+     * Token of the user to verify its identity
+     *
+     * Note: This is passed for example to `createLlmExecutionTools`
+     */
+    readonly userToken?: string_user_id;
+    /**
+     * Additional arbitrary options to identify the client or to pass custom metadata
      */
     readonly customOptions?: TCustomOptions;
 };
+/**
+ * Login request for the application mode
+ */
+export type LoginRequest = {
+    /**
+     * Identifier of the application you are using
+     *
+     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     */
+    readonly appId: string_app_id | null;
+    /**
+     * Username (for example email) of the user
+     */
+    readonly username: string_email | string;
+    /**
+     * Password of the user
+     */
+    readonly password: string_password;
+    /**
+     * Request object from express if you want to access some request data for example headers, IP address, etc.
+     */
+    readonly rawRequest: Request;
+    /**
+     * Response object from express if you want to add some custom headers.
+     *
+     * Note: It is not recommended to use this object to send body of the response because it can confuse the client
+     */
+    readonly rawResponse: Response;
+};
+/**
+ * Login response for the application mode
+ */
+export type LoginResponse<TCustomOptions> = {
+    /**
+     * Was the login successful
+     */
+    readonly isSuccess: boolean;
+    /**
+     * Message to display to the user, this message is always displayed
+     */
+    readonly message?: string;
+    /**
+     * Optional error if the login was not successful
+     */
+    readonly error?: AuthenticationError;
+    /**
+     * Identification of the user to be used in the future requests
+     */
+    readonly identification?: Identification<TCustomOptions>;
+};
 /**
  * TODO: Constrain anonymous mode for specific models / providers
  */

package/esm/typings/src/scrapers/_common/utils/{scraperFetch.d.ts → promptbookFetch.d.ts}

@@ -2,9 +2,9 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
 /**
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
  *
- * @private as default `fetch` function used in Promptbook scrapers
+ * @public exported from `@promptbook/core`
  */
-export declare const scraperFetch: PromptbookFetch;
+export declare const promptbookFetch: PromptbookFetch;
 /**
  * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
  */

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -0,0 +1,37 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Stores data in .env variables (Remove !!! nonce 1)
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes to `process.env`
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
+    private envFilename;
+    private $provideOrCreateEnvFile;
+    private transformKey;
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     */
+    getItem(key: string): Promise<TItem | null>;
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index: number): string | null;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): Promise<void>;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}

package/esm/typings/src/types/typeAliases.d.ts

@@ -242,6 +242,12 @@ export type string_promptbook_documentation_url = `https://github.com/webgptorg/
  * For example `"towns.cz"`
  */
 export type string_domain = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://*.pavolhejny.com/*"`
+ */
+export type string_origin = string;
 /**
  * Semantic helper
  *
@@ -433,13 +439,13 @@ export type string_uuid = string & {
  *
  * @@@
  */
-export type string_app_id = id;
+export type string_app_id = id | 'app';
 /**
  * End user identifier
  *
  * @@@
  */
-export type string_user_id = id;
+export type string_user_id = id | string_email;
 /**
  * Semantic helper
  *

package/esm/typings/src/utils/organization/TODO_narrow.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the more specific type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_narrow<T> = T;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.88.0",
+    "version": "0.89.0-11",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.88.0"
+        "@promptbook/core": "0.89.0-11"
     },
     "dependencies": {
         "colors": "1.4.0",