@promptbook/openai 0.89.0-1 → 0.89.0-11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +3 -1
  2. package/esm/index.es.js +51 -36
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/src/_packages/core.index.d.ts +16 -4
  5. package/esm/typings/src/_packages/remote-client.index.d.ts +6 -8
  6. package/esm/typings/src/_packages/remote-server.index.d.ts +6 -6
  7. package/esm/typings/src/_packages/types.index.d.ts +18 -20
  8. package/esm/typings/src/cli/cli-commands/login.d.ts +15 -0
  9. package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts +7 -0
  10. package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts +15 -0
  11. package/esm/typings/src/config.d.ts +15 -8
  12. package/esm/typings/src/errors/0-index.d.ts +6 -0
  13. package/esm/typings/src/errors/AuthenticationError.d.ts +9 -0
  14. package/esm/typings/src/errors/PromptbookFetchError.d.ts +9 -0
  15. package/esm/typings/src/execution/PipelineExecutorResult.d.ts +2 -2
  16. package/esm/typings/src/execution/PromptResult.d.ts +2 -2
  17. package/esm/typings/src/execution/{PromptResultUsage.d.ts → Usage.d.ts} +5 -5
  18. package/esm/typings/src/execution/utils/addUsage.d.ts +2 -2
  19. package/esm/typings/src/execution/utils/computeUsageCounts.d.ts +3 -3
  20. package/esm/typings/src/execution/utils/usage-constants.d.ts +77 -60
  21. package/esm/typings/src/execution/utils/usageToHuman.d.ts +5 -5
  22. package/esm/typings/src/execution/utils/usageToWorktime.d.ts +5 -5
  23. package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts +12 -0
  24. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +2 -8
  25. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +2 -0
  26. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizzardOrCli.d.ts +36 -1
  27. package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts +1 -0
  28. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts +3 -3
  29. package/esm/typings/src/llm-providers/_common/utils/count-total-usage/limitTotalUsage.d.ts +2 -2
  30. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts +1 -1
  31. package/esm/typings/src/llm-providers/anthropic-claude/computeAnthropicClaudeUsage.d.ts +2 -2
  32. package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts +1 -1
  33. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +0 -9
  34. package/esm/typings/src/llm-providers/openai/computeOpenAiUsage.d.ts +2 -2
  35. package/esm/typings/src/pipeline/PipelineJson/PreparationJson.d.ts +2 -2
  36. package/esm/typings/src/remote-server/RemoteServer.d.ts +23 -0
  37. package/esm/typings/src/remote-server/socket-types/_subtypes/{PromptbookServer_Identification.d.ts → Identification.d.ts} +3 -3
  38. package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts +2 -2
  39. package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts +2 -2
  40. package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts +2 -2
  41. package/esm/typings/src/remote-server/startRemoteServer.d.ts +2 -2
  42. package/esm/typings/src/remote-server/types/RemoteClientOptions.d.ts +4 -12
  43. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +73 -3
  44. package/esm/typings/src/scrapers/_common/utils/{scraperFetch.d.ts → promptbookFetch.d.ts} +2 -2
  45. package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts +37 -0
  46. package/esm/typings/src/types/typeAliases.d.ts +6 -0
  47. package/esm/typings/src/utils/organization/TODO_narrow.d.ts +6 -0
  48. package/package.json +2 -2
  49. package/umd/index.umd.js +51 -36
  50. package/umd/index.umd.js.map +1 -1
  51. package/esm/typings/src/playground/BrjappConnector.d.ts +0 -64
  52. package/esm/typings/src/playground/brjapp-api-schema.d.ts +0 -12879
@@ -1,11 +1,46 @@
1
+ import { Promisable } from 'type-fest';
2
+ import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
3
+ import type { string_app_id } from '../../../types/typeAliases';
4
+ import type { string_url } from '../../../types/typeAliases';
5
+ import type { really_any } from '../../../utils/organization/really_any';
1
6
  import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
2
7
  import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
8
+ type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
9
+ /**
10
+ * Use local keys and execute LLMs directly
11
+ */
12
+ readonly strategy: 'BRING_YOUR_OWN_KEYS';
13
+ } | {
14
+ /**
15
+ * Do not use local keys but login to Promptbook server and execute LLMs there
16
+ */
17
+ readonly strategy: 'REMOTE_SERVER';
18
+ /**
19
+ * URL of the remote server
20
+ *
21
+ * @default `DEFAULT_REMOTE_SERVER_URL`
22
+ */
23
+ readonly remoteServerUrl?: string_url;
24
+ /**
25
+ * Identifier of the application which will be passed to the remote server identification
26
+ *
27
+ * Note: This can be some id or some semantic name like "email-agent"
28
+ */
29
+ readonly appId: string_app_id;
30
+ /**
31
+ *
32
+ */
33
+ loginPrompt(): Promisable<Identification<really_any>>;
34
+ });
3
35
  /**
4
36
  * Returns LLM tools for CLI
5
37
  *
38
+ * 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
39
+ *
6
40
  * @private within the repository - for CLI utils
7
41
  */
8
- export declare function $provideLlmToolsForWizzardOrCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): Promise<LlmExecutionToolsWithTotalUsage>;
42
+ export declare function $provideLlmToolsForWizzardOrCli(options?: ProvideLlmToolsForWizzardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
43
+ export {};
9
44
  /**
10
45
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
11
46
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
@@ -6,6 +6,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
6
6
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
7
7
  *
8
8
  * @@@ .env
9
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
9
10
  *
10
11
  * It looks for environment variables:
11
12
  * - `process.env.OPENAI_API_KEY`
@@ -1,6 +1,6 @@
1
1
  import type { Observable } from 'rxjs';
2
2
  import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
3
- import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
3
+ import type { Usage } from '../../../../execution/Usage';
4
4
  /**
5
5
  * LLM tools with option to get total usage of the execution
6
6
  */
@@ -8,13 +8,13 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
8
8
  /**
9
9
  * Get total cost of the execution up to this point
10
10
  */
11
- getTotalUsage(): PromptResultUsage;
11
+ getTotalUsage(): Usage;
12
12
  /**
13
13
  * Observable of total cost of the execution up to this point
14
14
  *
15
15
  * Note: This does report the cost of the last prompt, not the total cost of the execution up to this point
16
16
  */
17
- spending(): Observable<PromptResultUsage>;
17
+ spending(): Observable<Usage>;
18
18
  };
19
19
  /**
20
20
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
@@ -1,5 +1,5 @@
1
1
  import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
2
- import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
2
+ import type { Usage } from '../../../../execution/Usage';
3
3
  import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
4
4
  import type { TODO_any } from '../../../../utils/organization/TODO_any';
5
5
  import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
@@ -12,7 +12,7 @@ type LimitTotalUsageOptions = {
12
12
  *
13
13
  * @default ZERO_USAGE
14
14
  */
15
- maxTotalUsage: PromptResultUsage;
15
+ maxTotalUsage: Usage;
16
16
  /**
17
17
  * @@@
18
18
  *
@@ -25,7 +25,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & Cl
25
25
  */
26
26
  export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
27
27
  isProxied: true;
28
- } & Pick<RemoteClientOptions<undefined>, 'remoteUrl' | 'path'>;
28
+ } & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;
29
29
  /**
30
30
  * TODO: [🧠][🤺] Pass `userId`
31
31
  */
@@ -1,6 +1,6 @@
1
1
  import type Anthropic from '@anthropic-ai/sdk';
2
2
  import type { PartialDeep } from 'type-fest';
3
- import type { PromptResultUsage } from '../../execution/PromptResultUsage';
3
+ import type { Usage } from '../../execution/Usage';
4
4
  import type { Prompt } from '../../types/Prompt';
5
5
  /**
6
6
  * 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';
12
12
  * @private internal utility of `AnthropicClaudeExecutionTools`
13
13
  */
14
14
  export declare function computeAnthropicClaudeUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
15
- resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): PromptResultUsage;
15
+ resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): Usage;
16
16
  /**
17
17
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
18
18
  */
@@ -11,4 +11,4 @@ import type { Registration } from '../../utils/$Register';
11
11
  export declare const _AnthropicClaudeMetadataRegistration: Registration;
12
12
  /**
13
13
  * Note: [💞] Ignore a discrepancy between file name and entity name
14
- */
14
+ */
@@ -8,8 +8,6 @@ import type { Prompt } from '../../types/Prompt';
8
8
  import type { string_markdown } from '../../types/typeAliases';
9
9
  import type { string_markdown_text } from '../../types/typeAliases';
10
10
  import type { string_title } from '../../types/typeAliases';
11
- import type { string_token } from '../../types/typeAliases';
12
- import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
13
11
  import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
14
12
  /**
15
13
  * Execution Tools for calling OpenAI API
@@ -31,13 +29,6 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
31
29
  get title(): string_title & string_markdown_text;
32
30
  get description(): string_markdown;
33
31
  getClient(): Promise<OpenAI>;
34
- /**
35
- * Create (sub)tools for calling OpenAI API Assistants
36
- *
37
- * @param assistantId Which assistant to use
38
- * @returns Tools for calling OpenAI API Assistants with same token
39
- */
40
- createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
41
32
  /**
42
33
  * Check the `options` passed to `constructor`
43
34
  */
@@ -1,6 +1,6 @@
1
1
  import type OpenAI from 'openai';
2
2
  import type { PartialDeep } from 'type-fest';
3
- import type { PromptResultUsage } from '../../execution/PromptResultUsage';
3
+ import type { Usage } from '../../execution/Usage';
4
4
  import type { Prompt } from '../../types/Prompt';
5
5
  /**
6
6
  * Computes the usage of the OpenAI API based on the response from OpenAI
@@ -12,7 +12,7 @@ import type { Prompt } from '../../types/Prompt';
12
12
  * @private internal utility of `OpenAiExecutionTools`
13
13
  */
14
14
  export declare function computeOpenAiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
15
- resultContent: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): PromptResultUsage;
15
+ resultContent: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): Usage;
16
16
  /**
17
17
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
18
18
  */
@@ -1,4 +1,4 @@
1
- import type { PromptResultUsage } from '../../execution/PromptResultUsage';
1
+ import type { Usage } from '../../execution/Usage';
2
2
  import type { number_id } from '../../types/typeAliases';
3
3
  import type { string_promptbook_version } from '../../version';
4
4
  export type PreparationJson = {
@@ -13,7 +13,7 @@ export type PreparationJson = {
13
13
  /**
14
14
  * Usage of the prompt execution
15
15
  */
16
- readonly usage: PromptResultUsage;
16
+ readonly usage: Usage;
17
17
  };
18
18
  /**
19
19
  * TODO: [🍙] Make some standard order of json properties
@@ -0,0 +1,23 @@
1
+ /// <reference types="node" />
2
+ import type { IDestroyable } from 'destroyable';
3
+ import express from 'express';
4
+ import http from 'http';
5
+ import { DefaultEventsMap, Server } from 'socket.io';
6
+ import type { TODO_any } from '../utils/organization/TODO_any';
7
+ import type { TODO_narrow } from '../utils/organization/TODO_narrow';
8
+ export type RemoteServer = IDestroyable & {
9
+ /**
10
+ * HTTP server instance
11
+ */
12
+ readonly httpServer: http.Server<TODO_any>;
13
+ /**
14
+ * Express application instance
15
+ *
16
+ * Note: This is useful for adding custom routes
17
+ */
18
+ readonly expressApp: express.Express;
19
+ /**
20
+ * Socket.io server instance
21
+ */
22
+ readonly socketIoServer: Server<TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_any>;
23
+ };
@@ -7,14 +7,14 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
7
7
  * @public exported from `@promptbook/remote-server`
8
8
  * @public exported from `@promptbook/remote-client`
9
9
  */
10
- export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
10
+ export type Identification<TCustomOptions> = ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification;
11
11
  /**
12
12
  * Application mode is situation when you run known and well-defined books with your own api keys
13
13
  *
14
14
  * @public exported from `@promptbook/remote-server`
15
15
  * @public exported from `@promptbook/remote-client`
16
16
  */
17
- export type PromptbookServer_ApplicationIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
17
+ export type ApplicationModeIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
18
18
  /**
19
19
  * Application mode
20
20
  */
@@ -29,7 +29,7 @@ export type PromptbookServer_ApplicationIdentification<TCustomOptions> = Applica
29
29
  * @public exported from `@promptbook/remote-server`
30
30
  * @public exported from `@promptbook/remote-client`
31
31
  */
32
- export type PromptbookServer_AnonymousIdentification = {
32
+ export type AnonymousModeIdentification = {
33
33
  /**
34
34
  * Anonymous mode
35
35
  */
@@ -1,4 +1,4 @@
1
- import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
1
+ import type { Identification } from '../_subtypes/Identification';
2
2
  /**
3
3
  * List models available in the server
4
4
  *
@@ -10,7 +10,7 @@ export type PromptbookServer_ListModels_Request<TCustomOptions> = {
10
10
  /**
11
11
  * Identifier of the end user or application
12
12
  */
13
- readonly identification: PromptbookServer_Identification<TCustomOptions>;
13
+ readonly identification: Identification<TCustomOptions>;
14
14
  };
15
15
  /**
16
16
  * TODO: [🧠] Listing models inanonymous mode does not make sence - keeping only to preserve consistency
@@ -1,5 +1,5 @@
1
1
  import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
2
- import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
2
+ import type { Identification } from '../_subtypes/Identification';
3
3
  /**
4
4
  * This is a request from client to server to prepare a pipeline
5
5
  *
@@ -9,7 +9,7 @@ export type PromptbookServer_PreparePipeline_Request<TCustomOptions> = {
9
9
  /**
10
10
  * Identifier of the end user or application
11
11
  */
12
- readonly identification: PromptbookServer_Identification<TCustomOptions>;
12
+ readonly identification: Identification<TCustomOptions>;
13
13
  /**
14
14
  * The Pipeline to prepare
15
15
  */
@@ -1,5 +1,5 @@
1
1
  import type { Prompt } from '../../../types/Prompt';
2
- import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
2
+ import type { Identification } from '../_subtypes/Identification';
3
3
  /**
4
4
  * This is a request from client to server to execute a prompt
5
5
  *
@@ -9,7 +9,7 @@ export type PromptbookServer_Prompt_Request<TCustomOptions> = {
9
9
  /**
10
10
  * Identifier of the end user or application
11
11
  */
12
- readonly identification: PromptbookServer_Identification<TCustomOptions>;
12
+ readonly identification: Identification<TCustomOptions>;
13
13
  /**
14
14
  * The Prompt to execute
15
15
  */
@@ -1,4 +1,4 @@
1
- import type { IDestroyable } from 'destroyable';
1
+ import type { RemoteServer } from './RemoteServer';
2
2
  import type { RemoteServerOptions } from './types/RemoteServerOptions';
3
3
  /**
4
4
  * 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';
9
9
  * @see https://github.com/webgptorg/promptbook#remote-server
10
10
  * @public exported from `@promptbook/remote-server`
11
11
  */
12
- export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
12
+ export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
13
13
  /**
14
14
  * TODO: !! Add CORS and security - probbably via `helmet`
15
15
  * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch
@@ -1,7 +1,6 @@
1
1
  import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
2
2
  import type { string_base_url } from '../../types/typeAliases';
3
- import type { string_uri } from '../../types/typeAliases';
4
- import type { PromptbookServer_Identification } from '../socket-types/_subtypes/PromptbookServer_Identification';
3
+ import type { Identification } from '../socket-types/_subtypes/Identification';
5
4
  /**
6
5
  * Options for `RemoteLlmExecutionTools`
7
6
  *
@@ -12,21 +11,14 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
12
11
  * URL of the remote server
13
12
  * On this server will be connected to the socket.io server
14
13
  */
15
- readonly remoteUrl: string_base_url;
16
- /**
17
- * Path for the Socket.io server to listen
18
- *
19
- * @default '/socket.io'
20
- * @example '/promptbook/socket.io'
21
- */
22
- readonly path: string_uri;
14
+ readonly remoteServerUrl: string_base_url;
23
15
  /**
24
16
  * Identification of client for Socket.io remote server
25
17
  */
26
- readonly identification: PromptbookServer_Identification<TCustomOptions>;
18
+ readonly identification: Identification<TCustomOptions>;
27
19
  };
28
20
  /**
29
21
  * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
30
22
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
31
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
23
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
32
24
  */
@@ -1,10 +1,15 @@
1
+ import type { Request, Response } from 'express';
1
2
  import type { Promisable } from 'type-fest';
2
3
  import type { PipelineCollection } from '../../collection/PipelineCollection';
4
+ import { AuthenticationError } from '../../errors/AuthenticationError';
3
5
  import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
4
6
  import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
5
7
  import type { string_app_id } from '../../types/typeAliases';
8
+ import type { string_email } from '../../types/typeAliases';
9
+ import type { string_password } from '../../types/typeAliases';
6
10
  import type { string_uri } from '../../types/typeAliases';
7
11
  import type { string_user_id } from '../../types/typeAliases';
12
+ import type { Identification } from '../socket-types/_subtypes/Identification';
8
13
  /**
9
14
  * @@@
10
15
  *
@@ -16,7 +21,6 @@ import type { string_user_id } from '../../types/typeAliases';
16
21
  *
17
22
  * You can enable both modes at the same time.
18
23
  *
19
- * @public exported from `@promptbook/remote-client`
20
24
  * @public exported from `@promptbook/remote-server`
21
25
  */
22
26
  export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
@@ -32,8 +36,12 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
32
36
  * @default '/'
33
37
  * @example '/api/promptbook/'
34
38
  */
35
- readonly rootPath: string_uri;
36
- } & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
39
+ readonly rootPath?: string_uri;
40
+ } & ((AnonymousRemoteServerOptions & {
41
+ readonly isApplicationModeAllowed?: false;
42
+ }) | ({
43
+ readonly isAnonymousModeAllowed?: false;
44
+ } & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
37
45
  export type AnonymousRemoteServerOptions = {
38
46
  /**
39
47
  * Enable anonymous mode
@@ -51,6 +59,18 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
51
59
  * This is used to check validity of the prompt to prevent misuse
52
60
  */
53
61
  readonly collection: PipelineCollection;
62
+ /**
63
+ * User tries to login to the server, this function will be called verify the user and return the identification or throw an error
64
+ * This can be also doubled as a function to register the user
65
+ *
66
+ * Note: In most cases, you will return `PromptbookServer_ApplicationIdentification`
67
+ * `PromptbookServer_AnonymousIdentification` is useful only in scenarios when user stores its own api keys on the application server and
68
+ * server acts only as a api key provider
69
+ *
70
+ * Note: In most cases DO NOT THROW `AuthenticationError` but return `isSuccess: false` with message
71
+ * @throws `AuthenticationError` if the user is not allowed to login for example because of invalid credentials
72
+ */
73
+ login(loginRequest: LoginRequest): Promise<LoginResponse<TCustomOptions>>;
54
74
  /**
55
75
  * Creates llm execution tools for each client
56
76
  */
@@ -82,6 +102,56 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
82
102
  */
83
103
  readonly customOptions?: TCustomOptions;
84
104
  };
105
+ /**
106
+ * Login request for the application mode
107
+ */
108
+ export type LoginRequest = {
109
+ /**
110
+ * Identifier of the application you are using
111
+ *
112
+ * 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"
113
+ */
114
+ readonly appId: string_app_id | null;
115
+ /**
116
+ * Username (for example email) of the user
117
+ */
118
+ readonly username: string_email | string;
119
+ /**
120
+ * Password of the user
121
+ */
122
+ readonly password: string_password;
123
+ /**
124
+ * Request object from express if you want to access some request data for example headers, IP address, etc.
125
+ */
126
+ readonly rawRequest: Request;
127
+ /**
128
+ * Response object from express if you want to add some custom headers.
129
+ *
130
+ * Note: It is not recommended to use this object to send body of the response because it can confuse the client
131
+ */
132
+ readonly rawResponse: Response;
133
+ };
134
+ /**
135
+ * Login response for the application mode
136
+ */
137
+ export type LoginResponse<TCustomOptions> = {
138
+ /**
139
+ * Was the login successful
140
+ */
141
+ readonly isSuccess: boolean;
142
+ /**
143
+ * Message to display to the user, this message is always displayed
144
+ */
145
+ readonly message?: string;
146
+ /**
147
+ * Optional error if the login was not successful
148
+ */
149
+ readonly error?: AuthenticationError;
150
+ /**
151
+ * Identification of the user to be used in the future requests
152
+ */
153
+ readonly identification?: Identification<TCustomOptions>;
154
+ };
85
155
  /**
86
156
  * TODO: Constrain anonymous mode for specific models / providers
87
157
  */
@@ -2,9 +2,9 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
2
2
  /**
3
3
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
4
4
  *
5
- * @private as default `fetch` function used in Promptbook scrapers
5
+ * @public exported from `@promptbook/core`
6
6
  */
7
- export declare const scraperFetch: PromptbookFetch;
7
+ export declare const promptbookFetch: PromptbookFetch;
8
8
  /**
9
9
  * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
10
10
  */
@@ -0,0 +1,37 @@
1
+ import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ /**
3
+ * Stores data in .env variables (Remove !!! nonce 1)
4
+ *
5
+ * 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`
6
+ *
7
+ * @private within the repository - for CLI utils
8
+ */
9
+ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
10
+ private envFilename;
11
+ private $provideOrCreateEnvFile;
12
+ private transformKey;
13
+ /**
14
+ * Returns the number of key/value pairs currently present in the list associated with the object.
15
+ */
16
+ get length(): number;
17
+ /**
18
+ * Empties the list associated with the object of all key/value pairs, if there are any.
19
+ */
20
+ clear(): void;
21
+ /**
22
+ * 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.
23
+ */
24
+ getItem(key: string): Promise<TItem | null>;
25
+ /**
26
+ * 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.
27
+ */
28
+ key(index: number): string | null;
29
+ /**
30
+ * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
31
+ */
32
+ setItem(key: string, value: TItem): Promise<void>;
33
+ /**
34
+ * 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.
35
+ */
36
+ removeItem(key: string): void;
37
+ }
@@ -242,6 +242,12 @@ export type string_promptbook_documentation_url = `https://github.com/webgptorg/
242
242
  * For example `"towns.cz"`
243
243
  */
244
244
  export type string_domain = string;
245
+ /**
246
+ * Semantic helper
247
+ *
248
+ * For example `"https://*.pavolhejny.com/*"`
249
+ */
250
+ export type string_origin = string;
245
251
  /**
246
252
  * Semantic helper
247
253
  *
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Organizational helper to better mark the place where the more specific type is missing
3
+ *
4
+ * @private within the repository
5
+ */
6
+ export type TODO_narrow<T> = T;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/openai",
3
- "version": "0.89.0-1",
3
+ "version": "0.89.0-11",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -47,7 +47,7 @@
47
47
  "module": "./esm/index.es.js",
48
48
  "typings": "./esm/typings/src/_packages/openai.index.d.ts",
49
49
  "peerDependencies": {
50
- "@promptbook/core": "0.89.0-1"
50
+ "@promptbook/core": "0.89.0-11"
51
51
  },
52
52
  "dependencies": {
53
53
  "colors": "1.4.0",