@promptbook/types 0.71.0-0 → 0.71.0-12

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: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

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: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * 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: [🟢 !!!!!! After fix makeKnowledgeSourceHandler] 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,9 @@ 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`
+ * TODO: [😶] Unite floder listing
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  * 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/types",
-    "version": "0.71.0-0",
+    "version": "0.71.0-12",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -49,6 +49,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.71.0-0"
+        "@promptbook/core": "0.71.0-12"
     }
 }

package/esm/typings/src/knowledge/prepare-knowledge/_common/Scraper.d.ts

@@ -1,37 +0,0 @@
-import type { Promisable } from 'type-fest';
-import type { string_file_path } from '../../../types/typeAliases';
-import type { string_knowledge_source_link } from '../../../types/typeAliases';
-import type { string_markdown } from '../../../types/typeAliases';
-import type { string_markdown_text } from '../../../types/typeAliases';
-import type { string_mime_type } from '../../../types/typeAliases';
-import type { string_mime_type_with_wildcard } from '../../../types/typeAliases';
-import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
-import type { really_unknown } from '../../../utils/organization/really_unknown';
-/**
- * @@@
- *
- * @private still an internal experimental
- */
-export type Scraper = {
-    readonly description: string_markdown_text;
-    readonly documentationUrl: string_promptbook_documentation_url;
-    readonly examples: Array<string_file_path>;
-    readonly mimeTypes: Array<string_mime_type_with_wildcard>;
-    scrape(source: ScraperSourceOptions): Promisable<string_markdown>;
-};
-/**
- * @@@
- *
- * @private still an internal experimental
- */
-export type ScraperSourceOptions = {
-    readonly source: string_knowledge_source_link;
-    readonly mimeType: string_mime_type;
-    asJson(): Promise<really_unknown>;
-    asText(): Promise<really_unknown>;
-    asBlob(): Promise<really_unknown>;
-};
-/**
- * TODO: [🐝] @@@ Annotate all
- * TODO: [🔼] Export via types
- */

package/esm/typings/src/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env ts-node
-export {};

package/esm/typings/src/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,14 +0,0 @@
-import type { PrepareOptions } from '../../../prepare/PrepareOptions';
-import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
-import type { string_markdown } from '../../../types/typeAliases';
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare function prepareKnowledgeFromMarkdown(knowledgeContent: string_markdown, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
-/**
- * TODO: [🐝][🔼][main] !!! Export via `@promptbook/markdown`
- * TODO: [🪂] Do it in parallel 11:11
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -1,15 +0,0 @@
-import type { PrepareOptions } from '../../../prepare/PrepareOptions';
-import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/KnowledgePieceJson';
-import type { string_base64 } from '../../../types/typeAliases';
-/**
- * @@@
- *
- * @private still in development [🐝]
- */
-export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
-/**
- * TODO: [🐝][🔼][main] !!! Export via `@promptbook/pdf`
- * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
- *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
- * TODO: [🪂] Do it in parallel
- */

package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts

@@ -1,25 +0,0 @@
-import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
-import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
-/**
- * @@@
- *
- * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
- *
- * @@@ .env
- *
- * It looks for environment variables:
- * - `process.env.OPENAI_API_KEY`
- * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
- *
- * @returns @@@
- * @public exported from `@promptbook/node`
- */
-export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
-/**
- * TODO: @@@ write `createLlmToolsFromEnv` vs `createLlmToolsFromConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
- * TODO: [🧠][🍛] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
- * TODO: [🧠] Is there some meaningfull way how to test this util
- * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
- * TODO: [🥃] Allow `ptbk make` without llm tools
- * TODO: This should be maybe not under `_common` but under `utils`
- */

package/esm/typings/src/prepare/PrepareOptions.d.ts

@@ -1,22 +0,0 @@
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
-/**
- * Options for preparation of the pipeline
- */
-export type PrepareOptions = {
-    /**
-     * LLM tools
-     */
-    readonly llmTools: LlmExecutionTools;
-    /**
-     * Maximum number of tasks running in parallel
-     *
-     * @default MAX_PARALLEL_COUNT
-     */
-    readonly maxParallelCount?: number;
-    /**
-     * If true, the preparation logs additional information
-     *
-     * @default false
-     */
-    readonly isVerbose?: boolean;
-};

package/esm/typings/src/storage/files-storage/FilesStorageOptions.d.ts

@@ -1,10 +0,0 @@
-import type { string_folder_path } from '../../types/typeAliases';
-/**
- * @@@
- */
-export type FilesStorageOptions = {
-    /**
-     * @@@
-     */
-    cacheFolderPath: string_folder_path;
-};