@promptbook/cli 0.100.0 โ†’ 0.100.2

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.
@@ -1,7 +1,7 @@
1
1
  import type { string_agent_name } from '../../types/typeAliases';
2
2
  import type { string_url_image } from '../../types/typeAliases';
3
3
  import type { string_book } from './string_book';
4
- export interface AgentBasicInformation {
4
+ export type AgentBasicInformation = {
5
5
  /**
6
6
  * Name of the agent
7
7
  * This is the first line of the agent source
@@ -17,7 +17,7 @@ export interface AgentBasicInformation {
17
17
  * This is the line starting with "META IMAGE"
18
18
  */
19
19
  profileImageUrl: string_url_image;
20
- }
20
+ };
21
21
  /**
22
22
  * Parses basic information from agent source
23
23
  *
@@ -6,7 +6,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
6
6
  * - Creating regex patterns for parsing
7
7
  * - Applying its effects to agent model requirements
8
8
  */
9
- export interface CommitmentDefinition {
9
+ export type CommitmentDefinition = {
10
10
  /**
11
11
  * The type/name of this commitment (e.g., 'PERSONA', 'KNOWLEDGE', etc.)
12
12
  */
@@ -45,4 +45,4 @@ export interface CommitmentDefinition {
45
45
  * @returns Updated agent model requirements
46
46
  */
47
47
  applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
48
- }
48
+ };
@@ -4,7 +4,7 @@ import type { TODO_any } from '../../../utils/organization/TODO_any';
4
4
  *
5
5
  * This is like "compiled" version of agent source
6
6
  */
7
- export interface AgentModelRequirements {
7
+ export type AgentModelRequirements = {
8
8
  /**
9
9
  * The system message that defines the agent's behavior and personality
10
10
  */
@@ -34,4 +34,4 @@ export interface AgentModelRequirements {
34
34
  * Each commitment can store its own data here
35
35
  */
36
36
  readonly metadata?: Record<string, TODO_any>;
37
- }
37
+ };
@@ -2,7 +2,7 @@ import type { ParsedCommitment } from './ParsedCommitment';
2
2
  /**
3
3
  * Result of parsing agent source for commitments
4
4
  */
5
- export interface AgentSourceParseResult {
5
+ export type AgentSourceParseResult = {
6
6
  /**
7
7
  * The agent name (first line)
8
8
  */
@@ -15,4 +15,4 @@ export interface AgentSourceParseResult {
15
15
  * Lines that are not commitments (for system message)
16
16
  */
17
17
  nonCommitmentLines: string[];
18
- }
18
+ };
@@ -2,7 +2,7 @@ import type { BookCommitment } from '../_base/BookCommitment';
2
2
  /**
3
3
  * Parsed commitment line from agent source
4
4
  */
5
- export interface ParsedCommitment {
5
+ export type ParsedCommitment = {
6
6
  /**
7
7
  * The commitment type (e.g., 'PERSONA', 'KNOWLEDGE')
8
8
  */
@@ -19,4 +19,4 @@ export interface ParsedCommitment {
19
19
  * Line number in the agent source (1-based)
20
20
  */
21
21
  lineNumber: number;
22
- }
22
+ };
@@ -24,3 +24,6 @@ export type AvatarProfileProps = {
24
24
  * @public exported from `@promptbook/components`
25
25
  */
26
26
  export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;
27
+ /**
28
+ * TODO: [๐Ÿ•›] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
29
+ */
@@ -1,3 +1,4 @@
1
+ import type { CSSProperties } from 'react';
1
2
  import type { string_book } from '../../book-2.0/agent-source/string_book';
2
3
  /**
3
4
  * Props of `BookEditor`
@@ -9,6 +10,10 @@ export type BookEditorProps = {
9
10
  * Additional CSS classes to apply to the editor container.
10
11
  */
11
12
  readonly className?: string;
13
+ /**
14
+ * Optional CSS style which will be added to root <div/> element
15
+ */
16
+ readonly style?: CSSProperties;
12
17
  /**
13
18
  * CSS className for a font (e.g. from next/font) to style the editor text.
14
19
  * If omitted, defaults to system serif fonts.
@@ -1,7 +1,4 @@
1
- import type { string_color } from '../../../types/typeAliases';
2
- import type { string_name } from '../../../types/typeAliases';
3
- import type { string_person_fullname } from '../../../types/typeAliases';
4
- import type { string_url_image } from '../../../types/typeAliases';
1
+ import type { string_color, string_name, string_person_fullname, string_url_image } from '../../../types/typeAliases';
5
2
  import { Color } from '../../../utils/color/Color';
6
3
  /**
7
4
  * A participant in the chat
@@ -30,3 +27,6 @@ export type ChatParticipant = {
30
27
  */
31
28
  color: string_color | Color;
32
29
  };
30
+ /**
31
+ * TODO: [๐Ÿ•›] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
32
+ */
@@ -1,13 +1,9 @@
1
1
  import type { Promisable } from 'type-fest';
2
2
  import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
3
3
  import type { Prompt } from '../types/Prompt';
4
- import type { string_markdown } from '../types/typeAliases';
5
- import type { string_markdown_text } from '../types/typeAliases';
6
- import type { string_title } from '../types/typeAliases';
4
+ import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
7
5
  import type { AvailableModel } from './AvailableModel';
8
- import type { ChatPromptResult } from './PromptResult';
9
- import type { CompletionPromptResult } from './PromptResult';
10
- import type { EmbeddingPromptResult } from './PromptResult';
6
+ import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from './PromptResult';
11
7
  /**
12
8
  * Container for all the tools needed to execute prompts to large language models like GPT-4
13
9
  * On its interface it exposes common methods for prompt execution.
@@ -60,6 +56,7 @@ export type LlmExecutionTools = {
60
56
  callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
61
57
  };
62
58
  /**
59
+ * TODO: [๐Ÿ•›] Extend this from sth class
63
60
  * TODO: [๐Ÿš] Implement destroyable pattern to free resources
64
61
  * TODO: [๐Ÿณ] Add `callTranslationModel`
65
62
  * TODO: [๐Ÿง ] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
@@ -5,7 +5,7 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
5
5
  /**
6
6
  * Options for validating a prompt result
7
7
  */
8
- export interface ValidatePromptResultOptions {
8
+ export type ValidatePromptResultOptions = {
9
9
  /**
10
10
  * The result string to validate
11
11
  */
@@ -23,11 +23,11 @@ export interface ValidatePromptResultOptions {
23
23
  * Note: This is for validation purposes only - postprocessing should be done before calling this function
24
24
  */
25
25
  postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
26
- }
26
+ };
27
27
  /**
28
28
  * Result of prompt result validation
29
29
  */
30
- export interface ValidatePromptResultResult {
30
+ export type ValidatePromptResultResult = {
31
31
  /**
32
32
  * Whether the result is valid (passes all expectations and format checks)
33
33
  */
@@ -40,7 +40,7 @@ export interface ValidatePromptResultResult {
40
40
  * Error that occurred during validation, if any
41
41
  */
42
42
  error?: ExpectError;
43
- }
43
+ };
44
44
  /**
45
45
  * Validates a prompt result against expectations and format requirements.
46
46
  * This function provides a common abstraction for result validation that can be used
@@ -76,6 +76,6 @@ export declare function getLlmProviderProfile(providerKey: keyof typeof LLM_PROV
76
76
  export declare function createCustomLlmProfile(baseProfile: ChatParticipant, overrides: Partial<ChatParticipant>): ChatParticipant;
77
77
  /**
78
78
  * TODO: Refactor this - each profile must be alongside the provider definition
79
- * TODO: Unite `AvatarProfileProps` and `ChatParticipant`
79
+ * TODO: [๐Ÿ•›] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
80
80
  * Note: [๐Ÿ’ž] Ignore a discrepancy between file name and entity name
81
81
  */
@@ -1,7 +1,5 @@
1
- import { MODEL_ORDERS } from '../../../constants';
2
- import { MODEL_TRUST_LEVELS } from '../../../constants';
3
- import type { string_name } from '../../../types/typeAliases';
4
- import type { string_title } from '../../../types/typeAliases';
1
+ import { MODEL_ORDERS, MODEL_TRUST_LEVELS } from '../../../constants';
2
+ import type { string_name, string_title } from '../../../types/typeAliases';
5
3
  import type { Registered } from '../../../utils/$Register';
6
4
  import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
7
5
  import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
@@ -52,6 +50,7 @@ export type LlmToolsMetadata = Registered & {
52
50
  createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
53
51
  };
54
52
  /**
53
+ * TODO: [๐Ÿ•›] Extend this
55
54
  * TODO: Add configuration schema and maybe some documentation link
56
55
  * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
57
56
  * TODO: [ยฎ] DRY Register logic
@@ -1,5 +1,4 @@
1
- import type { string_color } from '../../types/typeAliases';
2
- import type { string_url_image } from '../../types/typeAliases';
1
+ import type { string_color, string_url_image } from '../../types/typeAliases';
3
2
  import type { WithTake } from '../take/interfaces/ITakeChain';
4
3
  import { CSS_COLORS } from './css-colors';
5
4
  /**
@@ -6,7 +6,7 @@ import type { Takeable } from './Takeable';
6
6
  * @deprecated [๐Ÿคก] Use some better functional library instead of `TakeChain`
7
7
  */
8
8
  export type WithTake<TValue extends Takeable> = TValue & ITakeChain<TValue>;
9
- export interface ITakeChain<TValue extends Takeable> {
9
+ export type ITakeChain<TValue extends Takeable> = {
10
10
  readonly value: TValue;
11
11
  then<TResultValue extends Takeable>(callback: (value: TValue) => TResultValue): WithTake<TResultValue>;
12
- }
12
+ };
@@ -1,7 +1,7 @@
1
1
  import type { string_filename } from '../../../types/typeAliases';
2
2
  import type { really_unknown } from '../../organization/really_unknown';
3
3
  /**
4
- * Tests if given string is valid URL.
4
+ * Tests if given string is valid file path.
5
5
  *
6
6
  * Note: This does not check if the file exists only if the path is valid
7
7
  * @public exported from `@promptbook/utils`
@@ -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.100.0-65`).
18
+ * It follows semantic versioning (e.g., `0.100.1`).
19
19
  *
20
20
  * @generated
21
21
  */
@@ -9,12 +9,12 @@ import type { string_pipeline_url } from '../types/typeAliases';
9
9
  /**
10
10
  * Options for wizard methods
11
11
  */
12
- interface WizardOptions {
12
+ type WizardOptions = {
13
13
  /**
14
14
  * Whether to enable verbose logging
15
15
  */
16
16
  isVerbose?: boolean;
17
- }
17
+ };
18
18
  /**
19
19
  * Wizard for simple usage of the Promptbook
20
20
  * Look at `wizard` for more details
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/cli",
3
- "version": "0.100.0",
3
+ "version": "0.100.2",
4
4
  "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -58,7 +58,7 @@
58
58
  * @generated
59
59
  * @see https://github.com/webgptorg/promptbook
60
60
  */
61
- const PROMPTBOOK_ENGINE_VERSION = '0.100.0';
61
+ const PROMPTBOOK_ENGINE_VERSION = '0.100.2';
62
62
  /**
63
63
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
64
64
  * Note: [๐Ÿ’ž] Ignore a discrepancy between file name and entity name
@@ -1746,7 +1746,7 @@
1746
1746
  }
1747
1747
 
1748
1748
  /**
1749
- * Tests if given string is valid URL.
1749
+ * Tests if given string is valid file path.
1750
1750
  *
1751
1751
  * Note: This does not check if the file exists only if the path is valid
1752
1752
  * @public exported from `@promptbook/utils`
@@ -1758,18 +1758,25 @@
1758
1758
  if (filename.split('\n').length > 1) {
1759
1759
  return false;
1760
1760
  }
1761
- if (filename.split(' ').length >
1762
- 5 /* <- TODO: [๐Ÿง ][๐Ÿˆท] Make some better non-arbitrary way how to distinct filenames from informational texts */) {
1761
+ // Normalize slashes early so heuristics can detect path-like inputs
1762
+ const filenameSlashes = filename.replace(/\\/g, '/');
1763
+ // Reject strings that look like sentences (informational text)
1764
+ // Heuristic: contains multiple spaces and ends with a period, or contains typical sentence punctuation
1765
+ // But skip this heuristic if the string looks like a path (contains '/' or starts with a drive letter)
1766
+ if (filename.trim().length > 60 && // long enough to be a sentence
1767
+ /[.!?]/.test(filename) && // contains sentence punctuation
1768
+ filename.split(' ').length > 8 && // has many words
1769
+ !/\/|^[A-Z]:/i.test(filenameSlashes) // do NOT treat as sentence if looks like a path
1770
+ ) {
1763
1771
  return false;
1764
1772
  }
1765
- const filenameSlashes = filename.split('\\').join('/');
1766
1773
  // Absolute Unix path: /hello.txt
1767
1774
  if (/^(\/)/i.test(filenameSlashes)) {
1768
1775
  // console.log(filename, 'Absolute Unix path: /hello.txt');
1769
1776
  return true;
1770
1777
  }
1771
- // Absolute Windows path: /hello.txt
1772
- if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
1778
+ // Absolute Windows path: C:/ or C:\ (allow spaces and multiple dots in filename)
1779
+ if (/^[A-Z]:\/.+$/i.test(filenameSlashes)) {
1773
1780
  // console.log(filename, 'Absolute Windows path: /hello.txt');
1774
1781
  return true;
1775
1782
  }
@@ -2633,7 +2640,7 @@
2633
2640
  };
2634
2641
  /**
2635
2642
  * TODO: Refactor this - each profile must be alongside the provider definition
2636
- * TODO: Unite `AvatarProfileProps` and `ChatParticipant`
2643
+ * TODO: [๐Ÿ•›] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
2637
2644
  * Note: [๐Ÿ’ž] Ignore a discrepancy between file name and entity name
2638
2645
  */
2639
2646
 
@@ -7928,9 +7935,15 @@
7928
7935
  }
7929
7936
  if (isValidUrl(knowledgeSourceContent)) {
7930
7937
  const url = knowledgeSourceContent;
7938
+ if (isVerbose) {
7939
+ console.info(`๐Ÿ“„ [1] "${name}" is available at "${url}"`);
7940
+ }
7931
7941
  const response = await fetch(url); // <- TODO: [๐Ÿง ] Scraping and fetch proxy
7932
7942
  const mimeType = ((_a = response.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
7933
7943
  if (tools.fs === undefined || !url.endsWith('.pdf' /* <- TODO: [๐Ÿ’ต] */)) {
7944
+ if (isVerbose) {
7945
+ console.info(`๐Ÿ“„ [2] "${name}" tools.fs is not available or URL is not a PDF.`);
7946
+ }
7934
7947
  return {
7935
7948
  source: name,
7936
7949
  filename: null,
@@ -7966,13 +7979,17 @@
7966
7979
  await tools.fs.mkdir(path.dirname(path.join(rootDirname, filepath)), { recursive: true });
7967
7980
  }
7968
7981
  catch (error) {
7982
+ if (isVerbose) {
7983
+ console.info(`๐Ÿ“„ [3] "${name}" error creating cache directory`);
7984
+ }
7969
7985
  // Note: If we can't create cache directory, we'll handle it when trying to write the file
7970
7986
  // This handles read-only filesystems, permission issues, and missing parent directories
7971
- if (error instanceof Error && (error.message.includes('EROFS') ||
7972
- error.message.includes('read-only') ||
7973
- error.message.includes('EACCES') ||
7974
- error.message.includes('EPERM') ||
7975
- error.message.includes('ENOENT'))) ;
7987
+ if (error instanceof Error &&
7988
+ (error.message.includes('EROFS') ||
7989
+ error.message.includes('read-only') ||
7990
+ error.message.includes('EACCES') ||
7991
+ error.message.includes('EPERM') ||
7992
+ error.message.includes('ENOENT'))) ;
7976
7993
  else {
7977
7994
  // Re-throw other unexpected errors
7978
7995
  throw error;
@@ -7987,13 +8004,17 @@
7987
8004
  await tools.fs.writeFile(path.join(rootDirname, filepath), fileContent);
7988
8005
  }
7989
8006
  catch (error) {
8007
+ if (isVerbose) {
8008
+ console.info(`๐Ÿ“„ [4] "${name}" error writing cache file`);
8009
+ }
7990
8010
  // Note: If we can't write to cache, we'll process the file directly from memory
7991
8011
  // This handles read-only filesystems like Vercel
7992
- if (error instanceof Error && (error.message.includes('EROFS') ||
7993
- error.message.includes('read-only') ||
7994
- error.message.includes('EACCES') ||
7995
- error.message.includes('EPERM') ||
7996
- error.message.includes('ENOENT'))) {
8012
+ if (error instanceof Error &&
8013
+ (error.message.includes('EROFS') ||
8014
+ error.message.includes('read-only') ||
8015
+ error.message.includes('EACCES') ||
8016
+ error.message.includes('EPERM') ||
8017
+ error.message.includes('ENOENT'))) {
7997
8018
  // Return a handler that works directly with the downloaded content
7998
8019
  return {
7999
8020
  source: name,
@@ -8015,6 +8036,9 @@
8015
8036
  }
8016
8037
  // TODO: [๐Ÿ’ต] Check the file security
8017
8038
  // TODO: [๐Ÿงน][๐Ÿง ] Delete the file after the scraping is done
8039
+ if (isVerbose) {
8040
+ console.info(`๐Ÿ“„ [5] "${name}" cached at "${path.join(rootDirname, filepath)}"`);
8041
+ }
8018
8042
  return makeKnowledgeSourceHandler({ name, knowledgeSourceContent: filepath }, tools, {
8019
8043
  ...options,
8020
8044
  rootDirname,
@@ -8029,7 +8053,12 @@
8029
8053
  throw new EnvironmentMismatchError('Can not import file knowledge in non-file pipeline');
8030
8054
  // <- TODO: [๐Ÿง ] What is the best error type here`
8031
8055
  }
8032
- const filename = path.join(rootDirname, knowledgeSourceContent).split('\\').join('/');
8056
+ const filename = path.isAbsolute(knowledgeSourceContent)
8057
+ ? knowledgeSourceContent
8058
+ : path.join(rootDirname, knowledgeSourceContent).split('\\').join('/');
8059
+ if (isVerbose) {
8060
+ console.info(`๐Ÿ“„ [6] "${name}" is a valid file "${filename}"`);
8061
+ }
8033
8062
  const fileExtension = getFileExtension(filename);
8034
8063
  const mimeType = extensionToMimeType(fileExtension || '');
8035
8064
  if (!(await isFileExisting(filename, tools.fs))) {
@@ -8071,6 +8100,12 @@
8071
8100
  };
8072
8101
  }
8073
8102
  else {
8103
+ if (isVerbose) {
8104
+ console.info(`๐Ÿ“„ [7] "${name}" is just a explicit string text with a knowledge source`);
8105
+ console.info('---');
8106
+ console.info(knowledgeSourceContent);
8107
+ console.info('---');
8108
+ }
8074
8109
  return {
8075
8110
  source: name,
8076
8111
  filename: null,