@promptbook/openai 0.71.0-0 → 0.71.0-7

package/esm/typings/src/scrapers/website/websiteScraper.d.ts

@@ -0,0 +1,43 @@
+import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
+import type { KnowledgePiecePreparedJson } from '../../types/PipelineJson/KnowledgePieceJson';
+import type { string_markdown } from '../../types/typeAliases';
+import type { ScraperSourceHandler } from '../_common/Scraper';
+import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
+/**
+ * Scraper for .docx files
+ *
+ * @see `documentationUrl` for more details
+ * @public exported from `@promptbook/core`
+ */
+export declare const websiteScraper: {
+    /**
+     * Mime types that this scraper can handle
+     */
+    mimeTypes: string[];
+    /**
+     * Link to documentation
+     */
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
+    /**
+     * Convert the website  to `.md` file and returns intermediate source
+     *
+     * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
+     */
+    $convert(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): Promise<import("destroyable").IDestroyable & {
+        readonly filename: string;
+    } & {
+        markdown: string_markdown;
+    }>;
+    /**
+     * Scrapes the website and returns the knowledge pieces or `null` if it can't scrape it
+     */
+    scrape(source: ScraperSourceHandler, options: PrepareAndScrapeOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
+};
+/**
+ * TODO: !!!!!! Put into separate package
+ * TODO: [👣] Scraped website in .md can act as cache item - there is no need to run conversion each time
+ * TODO: [🦖] Make some system for putting scrapers to separete packages
+ * TODO: [🪂] Do it in parallel 11:11
+ * TODO: [🦷] Ideally use `as const satisfies Converter & Scraper` BUT this combination throws errors
+ * Note: No need to aggregate usage here, it is done by intercepting the llmTools
+ */

package/esm/typings/src/storage/{files-storage/FilesStorage.d.ts → file-cache-storage/FileCacheStorage.d.ts}

@@ -1,13 +1,13 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
-import type { FilesStorageOptions } from './FilesStorageOptions';
+import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
 /**
  * @@@
  *
  * @public exported from `@promptbook/node`
  */
-export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
+export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem> {
     private readonly options;
-    constructor(options: FilesStorageOptions);
+    constructor(options: FileCacheStorageOptions);
     /**
      * @@@
      */
@@ -27,5 +27,5 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
 }
 /**
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * Note: [🟢] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
  */

package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts

@@ -0,0 +1,10 @@
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * @@@
+ */
+export type FileCacheStorageOptions = {
+    /**
+     * @@@
+     */
+    rootFolderPath: string_dirname;
+};

package/esm/typings/src/storage/{files-storage → file-cache-storage}/utils/nameToSubfolderPath.d.ts

@@ -2,6 +2,6 @@ import type { string_name } from '../../../types/typeAliases';
 /**
  * @@@
  *
- * @private for `FilesStorage`
+ * @private for `FileCacheStorage`
  */
 export declare function nameToSubfolderPath(name: string_name): Array<string>;

package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/storage/local-storage/getLocalStorage.d.ts

@@ -6,5 +6,5 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
  */

package/esm/typings/src/storage/local-storage/getSessionStorage.d.ts

@@ -6,5 +6,5 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  */
 export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
 /**
- * Note: [🔵] This code should never be published outside of `@promptbook/browser`
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
  */

package/esm/typings/src/types/PipelineJson/ParameterJson.d.ts

@@ -33,7 +33,7 @@ export type ParameterJson = {
     readonly sampleValues?: Array<string_parameter_value>;
 };
 /**
- * TODO: [🧠] !!!!!! Should be here registered subparameter from foreach or not?
+ * TODO: [🧠] Should be here registered subparameters from foreach or not?
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -1,5 +1,5 @@
 import type { ModelRequirements } from '../ModelRequirements';
-import type { string_file_path } from '../typeAliases';
+import type { string_filename } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
 import type { string_semantic_version } from '../typeAliases';
@@ -33,7 +33,7 @@ export type PipelineJson = {
     /**
      * Internal helper for tracking the source `.ptbk.md` file of the pipeline
      */
-    readonly sourceFile?: string_file_path;
+    readonly sourceFile?: string_filename;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -39,6 +39,3 @@ export type ExecutionReportJson = {
      */
     readonly promptExecutions: Array<ExecutionPromptReportJson>;
 };
-/**
- * TODO: !!!!!! FOREACH in report
- */ 

package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts

@@ -1,3 +1,4 @@
+import type { ReadonlyDeep } from 'type-fest';
 import type { ExecutionReportJson } from './ExecutionReportJson';
 import type { ExecutionReportString } from './ExecutionReportString';
 import type { ExecutionReportStringOptions } from './ExecutionReportStringOptions';
@@ -6,7 +7,7 @@ import type { ExecutionReportStringOptions } from './ExecutionReportStringOption
  *
  * @public exported from `@promptbook/core`
  */
-export declare function executionReportJsonToString(executionReportJson: ExecutionReportJson, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
+export declare function executionReportJsonToString(executionReportJson: ReadonlyDeep<ExecutionReportJson>, options?: Partial<ExecutionReportStringOptions>): ExecutionReportString;
 /**
  * TODO: Add mermaid chart for every report
  * TODO: [🧠] Allow to filter out some parts of the report by options

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

@@ -156,7 +156,7 @@ export type string_knowledge_source_content = string_knowledge_source_link | str
  *
  * @@@ string_knowledge_source vs string_knowledge_source_link
  */
-export type string_knowledge_source_link = string_url | string_file_path;
+export type string_knowledge_source_link = string_url | string_filename;
 /**
  * Semantic helper
  *
@@ -386,6 +386,7 @@ export type string_emails = string;
  *   - `isValidUuid  to check validity
  *
  * For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
+ * TODO: [🥬] Make some system for hashes and ids of promptbook
  */
 export type string_uuid = string & {
     readonly _type: 'uuid';
@@ -423,37 +424,33 @@ export type string_file_extension = string;
  *
  * For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_file_absolute_path = string;
+export type string_absolute_filename = string;
 /**
  * Semantic helper
  *
  * For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_file_relative_path = string;
+export type string_relative_filename = string;
 /**
  * Semantic helper
  */
-export type string_file_path = string_file_absolute_path | string_file_relative_path;
+export type string_filename = string_absolute_filename | string_relative_filename;
 /**
  * Semantic helper
  *
  * For example `"C:/Users/me/work/collboard/modules-sdk/src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_folder_absolute_path = string;
+export type string_absolute_dirname = string;
 /**
  * Semantic helper
  *
  * For example `"./src/colldev/commands/develop/ColldevDevelop.tsx"`
  */
-export type string_folder_relative_path = string;
+export type string_relative_dirname = string;
 /**
  * Semantic helper
  */
-export type string_folder_path = string_file_absolute_path | string_file_relative_path;
-/**
- * Semantic helper
- */
-export type string_filename = string;
+export type string_dirname = string_absolute_dirname | string_relative_dirname;
 /**
  * Semantic helper
  *
@@ -592,7 +589,7 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO:[main] !!! Change "For example" to @example
+ * TODO: [main] !!! Change "For example" to @example
  * TODO: !! Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  */

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -0,0 +1,14 @@
+import type { IExecCommandOptions } from './IExecCommandOptions';
+/**
+ * Run one command in a shell
+ *
+ * Note: There are 2 similar functions in the codebase:
+ * - `$execCommand` which runs a single command
+ * - `$execCommands` which runs multiple commands
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $execCommand(options: IExecCommandOptions): Promise<string>;
+/**
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ */

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Run multiple commands in a shell in sequence
+ *
+ * Note: There are 2 similar functions in the codebase:
+ * - `$execCommand` which runs a single command
+ * - `$execCommands` which runs multiple commands
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $execCommands({ commands, cwd, crashOnError, }: {
+    readonly commands: string[];
+    readonly cwd: string;
+    readonly crashOnError?: boolean;
+}): Promise<void>;
+/**
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ */

package/esm/typings/src/utils/execCommand/IExecCommandOptions.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @deprecated Use sth from type-fest or move this to type helpers
+ */
+type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
+/**
+ * Simple options for `execCommand`
+ *
+ * TODO: !!!!!! Rename - remove I prefix
+ */
+export type IExecCommandOptions = string | RequiredAndOptional<IExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout'>;
+/**
+ * Advanced options for `execCommand`
+ *
+ * TODO:  !!!!!! Rename - remove I prefix
+ */
+export type IExecCommandOptionsAdvanced = {
+    readonly command: string;
+    readonly args: string[];
+    readonly cwd: string;
+    readonly crashOnError: boolean;
+    readonly timeout: number;
+};
+export {};

package/esm/typings/src/utils/execCommand/execCommand.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IExecCommandOptions } from './IExecCommandOptions';
+import type { IExecCommandOptionsAdvanced } from './IExecCommandOptions';
+/**
+ * Normalize options for `execCommand` and `execCommands`
+ *
+ * @private internal utility of `execCommand` and `execCommands`
+ */
+export declare function execCommandNormalizeOptions(options: IExecCommandOptions): Pick<IExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout'> & {
+    humanReadableCommand: string;
+};

package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/$isDirectoryExisting.d.ts

@@ -1,4 +1,4 @@
-import type { string_folder_path } from '../../types/typeAliases';
+import type { string_dirname } from '../../types/typeAliases';
 /**
  * Checks if the directory exists
  *
@@ -6,9 +6,9 @@ import type { string_folder_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function $isDirectoryExisting(directoryPath: string_folder_path): Promise<boolean>;
+export declare function $isDirectoryExisting(directoryPath: string_dirname): Promise<boolean>;
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
  * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
  * TODO: [🧠][📂] "directory" vs "folder"
  * TODO: [🖇] What about symlinks?

package/esm/typings/src/utils/files/$isFileExisting.d.ts

@@ -1,4 +1,4 @@
-import type { string_file_path } from '../../types/typeAliases';
+import type { string_filename } from '../../types/typeAliases';
 /**
  * Checks if the file exists
  *
@@ -6,9 +6,9 @@ import type { string_file_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function $isFileExisting(filePath: string_file_path): Promise<boolean>;
+export declare function $isFileExisting(filename: string_filename): Promise<boolean>;
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
  * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
  * TODO: [🖇] What about symlinks?
  */

package/esm/typings/src/utils/files/$listAllFiles.d.ts

@@ -1,5 +1,5 @@
-import type { string_file_path } from '../../types/typeAliases';
-import type { string_folder_path } from '../../types/typeAliases';
+import type { string_dirname } from '../../types/typeAliases';
+import type { string_filename } from '../../types/typeAliases';
 /**
  * Reads all files in the directory
  *
@@ -10,8 +10,8 @@ import type { string_folder_path } from '../../types/typeAliases';
  * @returns List of all files in the directory
  * @private internal function of `createCollectionFromDirectory`
  */
-export declare function $listAllFiles(path: string_folder_path, isRecursive: boolean): Promise<Array<string_file_path>>;
+export declare function $listAllFiles(path: string_dirname, isRecursive: boolean): Promise<Array<string_filename>>;
 /**
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
  * TODO: [🖇] What about symlinks?
  */

package/esm/typings/src/utils/files/extensionToMimeType.d.ts

@@ -0,0 +1,8 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert file extension to mime type
+ *
+ * @private within the repository
+ */
+export declare function extensionToMimeType(value: string_file_extension): string_mime_type;

package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/getFileExtension.d.ts

@@ -0,0 +1,8 @@
+import type { string_filename } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Get the file extension from a file name
+ *
+ * @private within the repository
+ */
+export declare function getFileExtension(value: string_filename): string_mime_type | null;

package/esm/typings/src/utils/files/getFileExtension.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,4 +1,4 @@
-import type { string_file_path } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
@@ -6,4 +6,4 @@ import type { really_unknown } from '../../organization/really_unknown';
  * Note: This does not check if the file exists only if the path is valid
  * @public exported from `@promptbook/utils`
  */
-export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;
+export declare function isValidFilePath(filename: really_unknown): filename is string_filename;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.71.0-0",
+    "version": "0.71.0-7",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.71.0-0"
+        "@promptbook/core": "0.71.0-7"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,8 +14,8 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.70.0-1';
-    // TODO:[main] !!!! List here all the versions and annotate + put into script
+    var PROMPTBOOK_VERSION = '0.71.0-6';
+    // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -1217,7 +1217,7 @@
                 prompt: computeUsage("$5.00 / 1M tokens"),
                 output: computeUsage("$15.00 / 1M tokens"),
             },
-            //TODO:[main] !!!!!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
+            //TODO: [main] !!! Add gpt-4o-mini-2024-07-18 and all others to be up to date
         },
         /**/
         /**/
@@ -1247,7 +1247,7 @@
             modelVariant: 'CHAT',
             modelTitle: 'o1-preview-2024-09-12',
             modelName: 'o1-preview-2024-09-12',
-            //             <- TODO:[main] !!!!!! Some better system to organize theese date suffixes and versions
+            //             <- TODO: [main] !!! Some better system to organize theese date suffixes and versions
             pricing: {
                 prompt: computeUsage("$15.00 / 1M tokens"),
                 output: computeUsage("$60.00 / 1M tokens"),
@@ -1421,6 +1421,7 @@
         OpenAiExecutionTools.prototype.callChatModel = function (prompt) {
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, format, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+                var _this = this;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -1467,7 +1468,12 @@
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            return [4 /*yield*/, client.chat.completions.create(rawRequest)];
+                            return [4 /*yield*/, client.chat.completions.create(rawRequest).catch(function (error) {
+                                    if (_this.options.isVerbose) {
+                                        console.info(colors__default["default"].bgRed('error'), error);
+                                    }
+                                    throw error;
+                                })];
                         case 2:
                             rawResponse = _a.sent();
                             if (this.options.isVerbose) {
@@ -1510,6 +1516,7 @@
         OpenAiExecutionTools.prototype.callCompletionModel = function (prompt) {
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+                var _this = this;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -1539,7 +1546,12 @@
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            return [4 /*yield*/, client.completions.create(rawRequest)];
+                            return [4 /*yield*/, client.completions.create(rawRequest).catch(function (error) {
+                                    if (_this.options.isVerbose) {
+                                        console.info(colors__default["default"].bgRed('error'), error);
+                                    }
+                                    throw error;
+                                })];
                         case 2:
                             rawResponse = _a.sent();
                             if (this.options.isVerbose) {
@@ -1579,6 +1591,7 @@
         OpenAiExecutionTools.prototype.callEmbeddingModel = function (prompt) {
             return __awaiter(this, void 0, void 0, function () {
                 var content, parameters, modelRequirements, client, modelName, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+                var _this = this;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
@@ -1603,7 +1616,12 @@
                             if (this.options.isVerbose) {
                                 console.info(colors__default["default"].bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                             }
-                            return [4 /*yield*/, client.embeddings.create(rawRequest)];
+                            return [4 /*yield*/, client.embeddings.create(rawRequest).catch(function (error) {
+                                    if (_this.options.isVerbose) {
+                                        console.info(colors__default["default"].bgRed('error'), error);
+                                    }
+                                    throw error;
+                                })];
                         case 2:
                             rawResponse = _a.sent();
                             if (this.options.isVerbose) {