@promptbook/remote-server 0.72.0-8 → 0.72.0

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

@@ -77,7 +77,7 @@ export type CommonPrompt = {
     /**
      * List of postprocessing steps that are executed after the prompt
      */
-    readonly postprocessingFunctionNames?: Array<string_postprocessing_function_name>;
+    readonly postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
     /**
      * Expectations for the answer
      *
@@ -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

@@ -37,5 +37,5 @@ export type ExecutionReportJson = {
     /**
      * Sequence of templates in order which were executed
      */
-    readonly promptExecutions: Array<ExecutionPromptReportJson>;
+    readonly promptExecutions: ReadonlyArray<ExecutionPromptReportJson>;
 };

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

@@ -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
  *
@@ -392,9 +393,17 @@ 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
  *
@@ -516,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;

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);
-    list(): Array<TRegistered>;
-    register(registered: TRegistered): void;
+    constructor(registerName: string_name);
+    list(): ReadonlyArray<TRegistered>;
+    register(registered: TRegistered): Registration;
 }

package/esm/typings/src/utils/FromtoItems.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents items which are compared to each other
  */
-export type FromtoItems = Array<{
+export type FromtoItems = ReadonlyArray<{
     /**
      * The title of the item
      */

package/esm/typings/src/utils/arrayableToArray.d.ts

@@ -8,4 +8,4 @@ import type { Arrayable } from '../types/Arrayable';
  *
  * @private internal utility
  */
-export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;
+export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): ReadonlyArray<TItem>;

package/esm/typings/src/utils/emojis.d.ts

@@ -8,7 +8,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
-export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
 /**
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...

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

@@ -1,14 +1,16 @@
-import type { IExecCommandOptions } from './IExecCommandOptions';
+import type { ExecCommandOptions } from './ExecCommandOptions';
 /**
  * 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
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
  *
  * @public exported from `@promptbook/node`
  */
-export declare function $execCommand(options: IExecCommandOptions): Promise<string>;
+export declare function $execCommand(options: ExecCommandOptions): 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`
+ * 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/$execCommandNormalizeOptions.d.ts

@@ -0,0 +1,12 @@
+import type { ExecCommandOptions } from './ExecCommandOptions';
+import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
+/**
+ * Normalize options for `execCommand` and `execCommands`
+ *
+ * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
+ *
+ * @private internal utility of `execCommand` and `execCommands`
+ */
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
+    humanReadableCommand: string;
+};

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

@@ -4,6 +4,7 @@
  * Note: There are 2 similar functions in the codebase:
  * - `$execCommand` which runs a single command
  * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a commands in a shell
  *
  * @public exported from `@promptbook/node`
  */
@@ -13,5 +14,5 @@ export declare function $execCommands({ commands, cwd, crashOnError, }: {
     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`
+ * 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/ExecCommandOptions.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @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`
+ */
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
+/**
+ * Advanced options for `execCommand`
+ */
+export type ExecCommandOptionsAdvanced = {
+    /**
+     * Command to run
+     */
+    readonly command: string;
+    /**
+     * Arguments for the command
+     */
+    readonly args: string[];
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
+    readonly cwd: string;
+    /**
+     * If `true` then the command will throw an error if the return code is not `0`
+     */
+    readonly crashOnError: boolean;
+    /**
+     * Timeout in milliseconds
+     */
+    readonly timeout: number;
+    /**
+     * If `true` then the command and entire CLI output will be logged to the console
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};
+export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/esm/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -4,7 +4,7 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
  *
  * @public exported from `@promptbook/utils`
  */
-export declare function splitIntoSentences(text: string): Array<string>;
+export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
 /**
  * Counts number of sentences in the text
  *

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

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

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 → listAllFiles.d.ts}

@@ -1,18 +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
  *
- * Note: `$` is used to indicate that this function is not a pure function - it looks at the filesystem
- *
  * @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): Promise<Array<string_filename>>;
+export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
 /**
  * TODO: [😶] Unite floder listing
- * Note: [🟢 <- TODO: [🦖] !!!!!! Split scrapers into packages and enable] Code in this file should never be published outside of `@promptbook/node` and `@promptbook/cli`
+ * 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/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -30,7 +30,7 @@ export type CodeBlock = {
  * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
 /**
  * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
  */

package/esm/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -5,7 +5,7 @@ import type { string_markdown_section } from '../../types/typeAliases';
  *
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+export declare function splitMarkdownIntoSections(markdown: string_markdown): ReadonlyArray<string_markdown_section>;
 /**
  * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more

package/esm/typings/src/utils/normalization/IKeywords.d.ts

@@ -2,7 +2,7 @@
  * Semantic helper
  *
  * Keyword is string without diacritics in lowercase [a-z1-9]
- * Words are splitted between multiple keywords @see IKeywords
+ * Words are splitted between multiple keywords @see Keywords
  *
  * For example `"keyword"`
  *
@@ -15,7 +15,7 @@ export type string_keyword = string;
  *
  * @public exported from `@promptbook/utils`
  */
-export type IKeywords = Set<string_keyword>;
+export type Keywords = Set<string_keyword>;
 /**
  * TODO: [🌮] Keywords with weight
  */

package/esm/typings/src/utils/normalization/parseKeywords.d.ts

@@ -1,5 +1,5 @@
 import type { really_unknown } from '../organization/really_unknown';
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
  *
@@ -9,7 +9,7 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywords(input: really_unknown): IKeywords;
+export declare function parseKeywords(input: really_unknown): Keywords;
 /**
  * Note: Not using spread in input param because of keeping second parameter for options
  * TODO: [🌺] Use some intermediate util splitWords

package/esm/typings/src/utils/normalization/parseKeywordsFromString.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * Parses keywords from a string
  *
@@ -6,4 +6,4 @@ import type { IKeywords } from './IKeywords';
  * @returns {Set} of keywords without diacritics in lowercase
  * @public exported from `@promptbook/utils`
  */
-export declare function parseKeywordsFromString(input: string): IKeywords;
+export declare function parseKeywordsFromString(input: string): Keywords;

package/esm/typings/src/utils/normalization/searchKeywords.d.ts

@@ -1,4 +1,4 @@
-import type { IKeywords } from './IKeywords';
+import type { Keywords } from './IKeywords';
 /**
  * @@@
  *
@@ -7,4 +7,4 @@ import type { IKeywords } from './IKeywords';
  * @returns
  * @public exported from `@promptbook/utils`
  */
-export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
+export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function TODO_USE(...value: Array<really_any>): void;
+export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;
+export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -3,7 +3,7 @@ import type { number_seed } from '../../types/typeAliases';
  * Generates random seed
  *
  * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ * Warning: This function is NOT cryptographically secure (it uses Math.random internally)
  * @public exported from `@promptbook/utils`
  */
 export declare function $randomSeed(): number_seed;

package/esm/typings/src/utils/sets/intersection.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function intersection<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/sets/union.d.ts

@@ -4,4 +4,4 @@
  * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
  * @public exported from `@promptbook/utils`
  */
-export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+export declare function union<TItem>(...sets: ReadonlyArray<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/unwrapResult.d.ts

@@ -1,11 +1,11 @@
 /**
  * Additional options for `unwrapResult`
  */
-interface UnwrapResultOptions {
+type UnwrapResultOptions = {
     /**
      * If true, the text is trimmed before processing
      */
-    isTrimmed?: boolean;
+    readonly isTrimmed?: boolean;
     /**
      * If true, the introduce sentence is removed
      *
@@ -15,8 +15,8 @@ interface UnwrapResultOptions {
      *
      * @default true
      */
-    isIntroduceSentenceRemoved?: boolean;
-}
+    readonly isIntroduceSentenceRemoved?: boolean;
+};
 /**
  * Removes quotes and optional introduce text from a string
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.72.0-8",
+    "version": "0.72.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -11,6 +11,7 @@
     "contributors": [
         "Pavol Hejný <me@pavolhejny.com> (https://www.pavolhejny.com/)"
     ],
+    "todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -51,11 +52,11 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.72.0-8"
+        "@promptbook/core": "0.72.0"
     },
     "dependencies": {
         "colors": "1.4.0",
         "socket.io": "4.7.2",
-        "spacetrim": "0.11.39"
+        "spacetrim": "0.11.59"
     }
 }