@promptbook/remote-server 0.72.0-1 → 0.72.0-11

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

@@ -1,13 +1,15 @@
+import type { ExecutionTools } from '../../execution/ExecutionTools';
 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> {
-    protected readonly options: FilesStorageOptions;
-    constructor(options: FilesStorageOptions);
+export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem> {
+    protected readonly tools: Required<Pick<ExecutionTools, 'fs'>>;
+    private readonly options;
+    constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
     /**
      * @@@
      */
@@ -27,5 +29,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 never released in packages that could be imported into browser environment
  */

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/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/storage/{utils → memory/utils}/PrefixStorage.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable } from 'type-fest';
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
  * This class behaves like LocalStorage but separates keys by prefix
  *

package/esm/typings/src/storage/{utils → memory/utils}/makePromptbookStorageFromWebStorage.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookStorage } from '../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
  * @@@
  *

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

@@ -11,11 +11,18 @@ import type { string_name } from '../typeAliases';
  */
 export type KnowledgeSourceJson = {
     /**
-     * @@@
+     * Unique identifier of the knowledge source
      */
     readonly name: string_name;
     /**
-     * @@@
+     * Source of one knowledge
+     *
+     * It can be a link, a relative path to file or direct text or combination of those
+     *
+     * For example `"https://pavolhejny.com/"`
+     * For example `"./pavol-hejny-cv.pdf"`
+     * For example `"Pavol Hejný has web https://pavolhejny.com/"`
+     * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
      */
     readonly sourceContent: string_knowledge_source_content;
 };

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/Prompt.d.ts

@@ -107,4 +107,5 @@ export type CommonPrompt = {
  * TODO: [🧄] Replace all "github.com/webgptorg/promptbook#xxx" with "ptbk.io/xxx"
  * TODO: [✔] Check ModelRequirements in runtime
  * TODO: [🏳] Add options for translation - maybe create `TranslationPrompt`
+ * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt
  */

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
  *
@@ -331,6 +331,13 @@ export type string_href = string;
  * For example `"https://collboard.com/9SeSQTupmQHwuSrLi.png?width=1200&height=630"`
  */
 export type string_url_image = string;
+/**
+ * Semantic helper
+ *
+ * For example `"C:/Users/me/AppData/Local/Pandoc/pandoc.exe"`
+ * For example `"C:/Program Files/LibreOffice/program/swriter.exe"`
+ */
+export type string_executable_path = string;
 /**
  * Semantic helper
  *
@@ -343,12 +350,6 @@ export type string_uri = string;
  * For example `"9SeSQTupmQHwuSrLi"`
  */
 export type string_uri_part = string;
-/**
- * Semantic helper, ID of the board used in URL and API
- *
- * For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
- */
-export type string_uriid = string_uri_part;
 /**
  * Semantic helper
  *
@@ -386,14 +387,23 @@ 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';
 };
 /**
- * End user identifier;
+ * Application identifier
+ *
+ * @@@
+ */
+export type string_app_id = id;
+/**
+ * End user identifier
+ *
+ * @@@
  */
-export type string_user_id = string;
+export type string_user_id = id;
 /**
  * Semantic helper
  *
@@ -423,37 +433,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;
-/**
- * Semantic helper
- */
-export type string_folder_path = string_file_absolute_path | string_file_relative_path;
+export type string_relative_dirname = string;
 /**
  * Semantic helper
  */
-export type string_filename = string;
+export type string_dirname = string_absolute_dirname | string_relative_dirname;
 /**
  * Semantic helper
  *
@@ -519,6 +525,7 @@ export type string_javascript_name = string;
  * Semantic helper; For example "unwrapResult" or "spaceTrim"
  */
 export type string_postprocessing_function_name = string;
+export type id = string | number;
 export type string_token = string;
 export type string_license_token = string_token;
 export type string_password = string;
@@ -592,7 +599,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/$Register.d.ts

@@ -1,14 +1,27 @@
-import type { string_javascript_name } from '../types/typeAliases';
+import { type IDestroyable } from 'destroyable';
+import type { string_name } from '../types/typeAliases';
 import type { TODO_string } from './organization/TODO_string';
+/**
+ * @@@
+ */
 export type Registered = {
     /**
      * @@@
      */
-    packageName: TODO_string;
+    readonly packageName: TODO_string;
+    /**
+     * @@@
+     */
+    readonly className: TODO_string;
+};
+/**
+ * @@@
+ */
+export type Registration = Registered & IDestroyable & {
     /**
      * @@@
      */
-    className: TODO_string;
+    readonly registerName: string_name;
 };
 /**
  * Register is @@@
@@ -18,9 +31,9 @@ export type Registered = {
  * @private internal utility, exported are only signleton instances of this class
  */
 export declare class $Register<TRegistered extends Registered> {
-    private readonly storageName;
+    private readonly registerName;
     private readonly storage;
-    constructor(storageName: string_javascript_name);
+    constructor(registerName: string_name);
     list(): Array<TRegistered>;
-    register(registered: TRegistered): void;
+    register(registered: TRegistered): Registration;
 }

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/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/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/files/isDirectoryExisting.d.ts

@@ -0,0 +1,14 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+export declare function isDirectoryExisting(directoryPath: string_dirname, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * 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/isDirectoryExisting.test.d.ts

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

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

@@ -0,0 +1,13 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+export declare function isFileExisting(filename: string_filename, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * 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/isFileExisting.test.d.ts

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

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

@@ -0,0 +1,17 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Reads all files in the directory
+ *
+ * @param path
+ * @param isRecursive
+ * @returns List of all files in the directory
+ * @private internal function of `createCollectionFromDirectory`
+ */
+export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
+/**
+ * TODO: [😶] Unite floder listing
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/files/listAllFiles.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/remote-server",
-    "version": "0.72.0-1",
+    "version": "0.72.0-11",
     "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/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-1"
+        "@promptbook/core": "0.72.0-11"
     },
     "dependencies": {
         "colors": "1.4.0",