@promptbook/editable 0.98.0-2 → 0.98.0-3

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.
package/esm/index.es.js CHANGED
@@ -17,7 +17,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
17
17
  * @generated
18
18
  * @see https://github.com/webgptorg/promptbook
19
19
  */
20
- const PROMPTBOOK_ENGINE_VERSION = '0.98.0-2';
20
+ const PROMPTBOOK_ENGINE_VERSION = '0.98.0-3';
21
21
  /**
22
22
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
23
23
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -12,6 +12,7 @@ import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-co
12
12
  import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
13
13
  import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
14
14
  import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
15
+ import { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
15
16
  import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
16
17
  import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
17
18
  import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
@@ -42,6 +43,7 @@ export { _OllamaMetadataRegistration };
42
43
  export { _OllamaRegistration };
43
44
  export { _OpenAiMetadataRegistration };
44
45
  export { _OpenAiAssistantMetadataRegistration };
46
+ export { _OpenAiCompatibleMetadataRegistration };
45
47
  export { _OpenAiRegistration };
46
48
  export { _OpenAiAssistantRegistration };
47
49
  export { _BoilerplateScraperRegistration };
@@ -111,6 +111,7 @@ import { _GoogleMetadataRegistration } from '../llm-providers/google/register-co
111
111
  import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-configuration';
112
112
  import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
113
113
  import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
114
+ import { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
114
115
  import { migratePipeline } from '../migrations/migratePipeline';
115
116
  import { preparePersona } from '../personas/preparePersona';
116
117
  import { book } from '../pipeline/book-notation';
@@ -259,6 +260,7 @@ export { _GoogleMetadataRegistration };
259
260
  export { _OllamaMetadataRegistration };
260
261
  export { _OpenAiMetadataRegistration };
261
262
  export { _OpenAiAssistantMetadataRegistration };
263
+ export { _OpenAiCompatibleMetadataRegistration };
262
264
  export { migratePipeline };
263
265
  export { preparePersona };
264
266
  export { book };
@@ -1,21 +1,25 @@
1
1
  import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createOpenAiAssistantExecutionTools } from '../llm-providers/openai/createOpenAiAssistantExecutionTools';
3
+ import { createOpenAiCompatibleExecutionTools } from '../llm-providers/openai/createOpenAiCompatibleExecutionTools';
3
4
  import { createOpenAiExecutionTools } from '../llm-providers/openai/createOpenAiExecutionTools';
4
5
  import { OPENAI_MODELS } from '../llm-providers/openai/openai-models';
5
6
  import { OpenAiAssistantExecutionTools } from '../llm-providers/openai/OpenAiAssistantExecutionTools';
6
7
  import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
7
8
  import { OpenAiCompatibleExecutionTools } from '../llm-providers/openai/OpenAiCompatibleExecutionTools';
9
+ import type { OpenAiCompatibleExecutionToolsOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
8
10
  import { OpenAiExecutionTools } from '../llm-providers/openai/OpenAiExecutionTools';
9
11
  import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
10
12
  import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
11
13
  import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
12
14
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
13
15
  export { createOpenAiAssistantExecutionTools };
16
+ export { createOpenAiCompatibleExecutionTools };
14
17
  export { createOpenAiExecutionTools };
15
18
  export { OPENAI_MODELS };
16
19
  export { OpenAiAssistantExecutionTools };
17
20
  export type { OpenAiAssistantExecutionToolsOptions };
18
21
  export { OpenAiCompatibleExecutionTools };
22
+ export type { OpenAiCompatibleExecutionToolsOptions };
19
23
  export { OpenAiExecutionTools };
20
24
  export type { OpenAiExecutionToolsOptions };
21
25
  export { _OpenAiRegistration };
@@ -81,6 +81,7 @@ import type { DeepseekExecutionToolsOptions } from '../llm-providers/deepseek/De
81
81
  import type { GoogleExecutionToolsOptions } from '../llm-providers/google/GoogleExecutionToolsOptions';
82
82
  import type { OllamaExecutionToolsOptions } from '../llm-providers/ollama/OllamaExecutionToolsOptions';
83
83
  import type { OpenAiAssistantExecutionToolsOptions } from '../llm-providers/openai/OpenAiAssistantExecutionToolsOptions';
84
+ import type { OpenAiCompatibleExecutionToolsOptions } from '../llm-providers/openai/OpenAiCompatibleExecutionToolsOptions';
84
85
  import type { OpenAiExecutionToolsOptions } from '../llm-providers/openai/OpenAiExecutionToolsOptions';
85
86
  import type { VercelExecutionToolsOptions } from '../llm-providers/vercel/VercelExecutionToolsOptions';
86
87
  import type { VercelProvider } from '../llm-providers/vercel/VercelProvider';
@@ -380,6 +381,7 @@ export type { DeepseekExecutionToolsOptions };
380
381
  export type { GoogleExecutionToolsOptions };
381
382
  export type { OllamaExecutionToolsOptions };
382
383
  export type { OpenAiAssistantExecutionToolsOptions };
384
+ export type { OpenAiCompatibleExecutionToolsOptions };
383
385
  export type { OpenAiExecutionToolsOptions };
384
386
  export type { VercelExecutionToolsOptions };
385
387
  export type { VercelProvider };
@@ -11,6 +11,7 @@ import { _OllamaMetadataRegistration } from '../llm-providers/ollama/register-co
11
11
  import { _OllamaRegistration } from '../llm-providers/ollama/register-constructor';
12
12
  import { _OpenAiMetadataRegistration } from '../llm-providers/openai/register-configuration';
13
13
  import { _OpenAiAssistantMetadataRegistration } from '../llm-providers/openai/register-configuration';
14
+ import { _OpenAiCompatibleMetadataRegistration } from '../llm-providers/openai/register-configuration';
14
15
  import { _OpenAiRegistration } from '../llm-providers/openai/register-constructor';
15
16
  import { _OpenAiAssistantRegistration } from '../llm-providers/openai/register-constructor';
16
17
  import { _BoilerplateScraperRegistration } from '../scrapers/_boilerplate/register-constructor';
@@ -41,6 +42,7 @@ export { _OllamaMetadataRegistration };
41
42
  export { _OllamaRegistration };
42
43
  export { _OpenAiMetadataRegistration };
43
44
  export { _OpenAiAssistantMetadataRegistration };
45
+ export { _OpenAiCompatibleMetadataRegistration };
44
46
  export { _OpenAiRegistration };
45
47
  export { _OpenAiAssistantRegistration };
46
48
  export { _BoilerplateScraperRegistration };
@@ -1,12 +1,12 @@
1
1
  import type { ClientOptions } from 'openai';
2
2
  import type { string_token } from '../../types/typeAliases';
3
- import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
3
+ import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
4
4
  /**
5
5
  * Options for `createOpenAiAssistantExecutionTools` and `OpenAiAssistantExecutionTools`
6
6
  *
7
7
  * @public exported from `@promptbook/openai`
8
8
  */
9
- export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions & ClientOptions & {
9
+ export type OpenAiAssistantExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions & ClientOptions & {
10
10
  /**
11
11
  * Which assistant to use
12
12
  */
@@ -11,14 +11,14 @@ import type { string_markdown_text } from '../../types/typeAliases';
11
11
  import type { string_model_name } from '../../types/typeAliases';
12
12
  import type { string_title } from '../../types/typeAliases';
13
13
  import { computeOpenAiUsage } from './computeOpenAiUsage';
14
- import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
14
+ import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
15
15
  /**
16
16
  * Execution Tools for calling OpenAI API or other OpeenAI compatible provider
17
17
  *
18
18
  * @public exported from `@promptbook/openai`
19
19
  */
20
20
  export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecutionTools {
21
- protected readonly options: OpenAiExecutionToolsOptions;
21
+ protected readonly options: OpenAiCompatibleExecutionToolsOptions;
22
22
  /**
23
23
  * OpenAI API client.
24
24
  */
@@ -32,7 +32,7 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
32
32
  *
33
33
  * @param options which are relevant are directly passed to the OpenAI compatible client
34
34
  */
35
- constructor(options: OpenAiExecutionToolsOptions);
35
+ constructor(options: OpenAiCompatibleExecutionToolsOptions);
36
36
  abstract get title(): string_title & string_markdown_text;
37
37
  abstract get description(): string_markdown;
38
38
  getClient(): Promise<OpenAI>;
@@ -0,0 +1,11 @@
1
+ import type { ClientOptions } from 'openai';
2
+ import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
3
+ /**
4
+ * Options for `createOpenAiCompatibleExecutionTools` and `OpenAiCompatibleExecutionTools`
5
+ *
6
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
7
+ * Rest is used by the `OpenAiCompatibleExecutionTools`.
8
+ *
9
+ * @public exported from `@promptbook/openai`
10
+ */
11
+ export type OpenAiCompatibleExecutionToolsOptions = CommonToolsOptions & ClientOptions;
@@ -1,11 +1,9 @@
1
- import type { ClientOptions } from 'openai';
2
- import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
1
+ import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
3
2
  /**
4
3
  * Options for `createOpenAiExecutionTools` and `OpenAiExecutionTools`
5
4
  *
6
- * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
7
- * Rest is used by the `OpenAiExecutionTools`.
5
+ * This extends OpenAiCompatibleExecutionToolsOptions.
8
6
  *
9
7
  * @public exported from `@promptbook/openai`
10
8
  */
11
- export type OpenAiExecutionToolsOptions = CommonToolsOptions & ClientOptions;
9
+ export type OpenAiExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions;
@@ -0,0 +1,17 @@
1
+ import { OpenAiCompatibleExecutionTools } from './OpenAiCompatibleExecutionTools';
2
+ import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleExecutionToolsOptions';
3
+ /**
4
+ * Execution Tools for calling OpenAI compatible API
5
+ *
6
+ * Note: This can be used for any OpenAI compatible APIs
7
+ *
8
+ * @public exported from `@promptbook/openai`
9
+ */
10
+ export declare const createOpenAiCompatibleExecutionTools: ((options: OpenAiCompatibleExecutionToolsOptions) => OpenAiCompatibleExecutionTools) & {
11
+ packageName: string;
12
+ className: string;
13
+ };
14
+ /**
15
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
16
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
17
+ */
@@ -19,6 +19,17 @@ export declare const _OpenAiMetadataRegistration: Registration;
19
19
  * @public exported from `@promptbook/cli`
20
20
  */
21
21
  export declare const _OpenAiAssistantMetadataRegistration: Registration;
22
+ /**
23
+ * Registration of the OpenAI Compatible metadata
24
+ *
25
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be instantiated directly.
26
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
27
+ *
28
+ * @public exported from `@promptbook/core`
29
+ * @public exported from `@promptbook/wizard`
30
+ * @public exported from `@promptbook/cli`
31
+ */
32
+ export declare const _OpenAiCompatibleMetadataRegistration: Registration;
22
33
  /**
23
34
  * Note: [💞] Ignore a discrepancy between file name and entity name
24
35
  */
@@ -19,6 +19,10 @@ export declare const _OpenAiRegistration: Registration;
19
19
  * @public exported from `@promptbook/cli`
20
20
  */
21
21
  export declare const _OpenAiAssistantRegistration: Registration;
22
+ /**
23
+ * Note: OpenAiCompatibleExecutionTools is an abstract class and cannot be registered directly.
24
+ * It serves as a base class for OpenAiExecutionTools and other compatible implementations.
25
+ */
22
26
  /**
23
27
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
24
28
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.98.0-1`).
18
+ * It follows semantic versioning (e.g., `0.98.0-2`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/editable",
3
- "version": "0.98.0-2",
3
+ "version": "0.98.0-3",
4
4
  "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -74,7 +74,7 @@
74
74
  "module": "./esm/index.es.js",
75
75
  "typings": "./esm/typings/src/_packages/editable.index.d.ts",
76
76
  "peerDependencies": {
77
- "@promptbook/core": "0.98.0-2"
77
+ "@promptbook/core": "0.98.0-3"
78
78
  },
79
79
  "dependencies": {
80
80
  "crypto-js": "4.2.0",
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.98.0-2';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.98.0-3';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name